Repository: snyk/parlay Branch: main Commit: 132ec411f5a1 Files: 93 Total size: 4.2 MB Directory structure: gitextract_b9stc6rp/ ├── .circleci/ │ └── config.yml ├── .github/ │ ├── CODEOWNERS │ └── workflows/ │ ├── ci.yml │ ├── release.yml │ └── security.yml ├── .gitignore ├── .gitleaks.toml ├── .golangci.yaml ├── .goreleaser.yml ├── .pre-commit-config.yaml ├── .snyk ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── NOTICE ├── README.md ├── SECURITY.md ├── acceptance.bats ├── catalog-info.yaml ├── ecosystems/ │ ├── packages/ │ │ └── packages.go │ └── repos/ │ └── repos.go ├── go.mod ├── go.sum ├── internal/ │ ├── commands/ │ │ ├── default.go │ │ ├── deps/ │ │ │ ├── repos.go │ │ │ └── root.go │ │ ├── ecosystems/ │ │ │ ├── enrich.go │ │ │ ├── packages.go │ │ │ ├── repos.go │ │ │ └── root.go │ │ ├── scorecard/ │ │ │ ├── enrich.go │ │ │ └── root.go │ │ └── snyk/ │ │ ├── config.go │ │ ├── enrich.go │ │ ├── packages.go │ │ └── root.go │ └── utils/ │ ├── cdx.go │ ├── cdx_test.go │ ├── input.go │ ├── input_test.go │ ├── spdx.go │ └── spdx_test.go ├── lib/ │ ├── deps/ │ │ └── repo.go │ ├── ecosystems/ │ │ ├── cache.go │ │ ├── cache_test.go │ │ ├── enrich.go │ │ ├── enrich_cyclonedx.go │ │ ├── enrich_cyclonedx_test.go │ │ ├── enrich_spdx.go │ │ ├── enrich_spdx_test.go │ │ ├── package.go │ │ ├── package_test.go │ │ ├── repo.go │ │ └── repo_test.go │ ├── sbom/ │ │ ├── cyclonedx.go │ │ ├── decode.go │ │ ├── decode_test.go │ │ ├── encode.go │ │ ├── format.go │ │ ├── sbom.go │ │ └── spdx.go │ ├── scorecard/ │ │ ├── enrich.go │ │ ├── enrich_cyclonedx.go │ │ ├── enrich_spdx.go │ │ └── enrich_test.go │ └── snyk/ │ ├── config.go │ ├── enrich.go │ ├── enrich_cyclonedx.go │ ├── enrich_spdx.go │ ├── enrich_test.go │ ├── package.go │ ├── package_test.go │ ├── self.go │ ├── self_test.go │ ├── service.go │ └── testdata/ │ ├── no_issues.json │ ├── numpy_issues.json │ ├── pandas_issues.json │ └── self.json ├── main.go ├── snyk/ │ ├── issues/ │ │ └── issues.go │ └── users/ │ └── users.go ├── specs/ │ ├── packages.yaml │ ├── repos.yaml │ ├── snyk-experimental.json │ └── snyk.json └── testing/ ├── sbom.cyclonedx-1.5.json ├── sbom.cyclonedx.json ├── sbom.cyclonedx.xml ├── sbom.spdx-2.3.json ├── sbom2.cyclonedx.json └── sbom3.cyclonedx.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .circleci/config.yml ================================================ version: 2.1 orbs: prodsec: snyk/prodsec-orb@1 go_image: &go_image resource_class: small docker: - image: cimg/go:1.25 jobs: security-scans: <<: *go_image steps: - checkout - prodsec/security_scans: mode: auto iac-scan: disabled workflows: version: 2 CICD: jobs: - prodsec/secrets-scan: name: Scan repository for secrets context: - snyk-bot-slack channel: snyk-vuln-alerts-unify filters: branches: ignore: - main - security-scans: name: Security Scans context: analysis_unify ================================================ FILE: .github/CODEOWNERS ================================================ * @snyk/unify @snyk/codesec_unify @snyk/open-source_unify @garethr ================================================ FILE: .github/workflows/ci.yml ================================================ name: CI on: push: pull_request: branches: [ "main" ] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Set up Go uses: actions/setup-go@v3 with: go-version: '1.25' - name: Lint uses: golangci/golangci-lint-action@v9 with: version: v2.9.0 - name: Build run: go build -v -o parlay - name: Unit tests run: go test -v ./... - name: Setup BATS uses: mig4/setup-bats@v1 with: bats-version: 1.9.0 - name: Acceptance tests run: bats -r . ================================================ FILE: .github/workflows/release.yml ================================================ name: Release on: push: tags: - 'v*' permissions: contents: write jobs: release: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: 0 - name: Set up Go uses: actions/setup-go@v4 with: go-version: '1.25' check-latest: true - run: go version - name: Install Syft uses: anchore/sbom-action/download-syft@v0 - name: Release uses: goreleaser/goreleaser-action@v6.1.0 with: version: ${{ env.GITHUB_REF_NAME }} args: release --clean env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ================================================ FILE: .github/workflows/security.yml ================================================ name: Security on: push: workflow_dispatch: schedule: - cron: "0 0 * * 0" workflow_call: secrets: GITLEAKS_LICENSE: required: true SNYK_TOKEN: required: true jobs: security: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: fetch-depth: 0 - name: Set up Go uses: actions/setup-go@v3 with: go-version: '1.25' - uses: snyk/actions/setup@master - name: Snyk Open Source run: snyk test env: SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} - name: Snyk Code run: snyk code test env: SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} - name: Gitleaks uses: gitleaks/gitleaks-action@v2 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}} ================================================ FILE: .gitignore ================================================ # Binaries for programs and plugins *.exe *.exe~ *.dll *.so *.dylib # Test binary, built with `go test -c` *.test # Output of the go coverage tool, specifically when used with LiteIDE *.out # Snyk Code cache .dccache # Goreleaser distribution files dist # Dependency directories (remove the comment below to include it) # vendor/ # IDE configs .idea /parlay ================================================ FILE: .gitleaks.toml ================================================ [whitelist] files = [ "specs/snyk-experimental.jsonl", ] ================================================ FILE: .golangci.yaml ================================================ version: "2" run: issues-exit-code: 1 tests: true linters: enable: - misspell settings: errcheck: check-type-assertions: true check-blank: true govet: enable: - shadow misspell: locale: US exclusions: generated: lax presets: - comments - common-false-positives - legacy - std-error-handling rules: - linters: - staticcheck text: "ST1005:" paths: - third_party$ - builtin$ - examples$ formatters: enable: - goimports settings: goimports: local-prefixes: - github.com/snyk/parlay exclusions: generated: lax paths: - third_party$ - builtin$ - examples$ ================================================ FILE: .goreleaser.yml ================================================ version: 2 before: hooks: - go mod download - go install github.com/google/go-licenses@latest - go-licenses save . --save_path=./acknowledgements --force - tar -cvf ./acknowledgements.tar.gz -C ./acknowledgements . - rm -rf ./acknowledgements builds: - main: ./main.go env: - CGO_ENABLED=0 goos: - windows - linux - darwin goarch: - amd64 - arm64 - ppc64le ldflags: - "-s" - "-w" - "-X github.com/snyk/parlay/internal/commands.version={{.Version}}" - "-X github.com/snyk/parlay/lib/ecosystems.Version={{.Version}}" - "-X github.com/snyk/parlay/lib/snyk.Version={{.Version}}" archives: - format: tar.gz name_template: >- {{ .ProjectName }}_ {{- title .Os }}_ {{- if eq .Arch "amd64" }}x86_64 {{- else if eq .Arch "386" }}i386 {{- else }}{{ .Arch }}{{ end }} format_overrides: - goos: windows format: zip files: # - LICENSE - README.md checksum: name_template: 'checksums.txt' release: extra_files: - glob: ./acknowledgements.tar.gz changelog: use: github groups: - title: New Features regexp: '^feat(ure)?:' order: 0 - title: Bug Fixes regexp: '^(bug|fix):' order: 1 - title: Other Changes order: 999 sort: asc filters: exclude: - '^docs:' - '^test:' - '^misc:' - '^typo:' - '(?i) typo( |\.|\r?\n)' # Publishes the deb and rpm files to the GitHub releases page. nfpms: - bindir: /usr/bin description: "Enrich SBOMs with Parlay" formats: - deb - rpm homepage: https://github.com/snyk/parlay maintainer: garethr source: enabled: true sboms: - id: cyclonedx artifacts: source args: ["$artifact", "--file", "$document", "--output", "cyclonedx-json"] documents: - "{{ .Binary }}_{{ .Version }}.cyclonedx.sbom" - id: spdx artifacts: source args: ["$artifact", "--file", "$document", "--output", "spdx-json"] documents: - "{{ .Binary }}-{{ .Version }}.spdx.sbom" ================================================ FILE: .pre-commit-config.yaml ================================================ repos: - repo: https://github.com/gitleaks/gitleaks rev: v8.16.1 hooks: - id: gitleaks ================================================ FILE: .snyk ================================================ # Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities. version: v1.25.0 # ignores vulnerabilities until expiry date; change duration by modifying expiry date ignore: 'snyk:lic:golang:github.com:package-url:packageurl-go:Unknown': - '*': reason: None Given expires: 2023-07-04T10:24:10.016Z created: 2023-06-04T10:24:10.022Z patch: {} ================================================ FILE: CODE_OF_CONDUCT.md ================================================ # Contributor Covenant Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at `oss-conduct-reports@snyk.io`. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. ================================================ FILE: CONTRIBUTING.md ================================================ # CONTRIBUTING.md First and foremost, thank you for considering contributing to Parlay! Your contribution is valuable and we genuinely appreciate your interest. Parlay is a distinct software project developed by Snyk. Although separate from our core product line, it provides a platform for us to demonstrate our capabilities and some key concepts. Please note that we monitor and respond to issues and pull requests on a best-effort basis. ### How to contribute #### Code of Conduct Prior to contributing, please familiarize yourself with our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all our contributors to uphold these guidelines to maintain a respectful and inclusive environment. #### Open Development All development work on Parlay is done directly on GitHub. Both our core team members and external contributors send pull requests, which go through a unified review process. #### Reporting Issues We welcome you to raise an issue if you discover a bug, find a documentation error, or identify a feature you believe should be added. You can do this by opening a new issue in the issue tracker. Please ensure that your issue hasn't already been reported by reviewing existing issues before creating a new one. We value the time and effort you spend in providing these details. #### Pull Requests We highly recommend that contributors raise an issue before making a pull request. This allows us to discuss potential changes and prevent unnecessary or duplicative work. Once the issue has been reviewed and we've agreed on a solution, contributors can then fork the repository and submit a pull request. ##### Submitting your Pull Request - Ensure your code passes all tests, and consider adding new tests for the changes you've made. - In your Pull Request description, provide a detailed explanation of your changes. This assists us in understanding your decision-making process and aids in the effective review of your work. - Remember to reference the relevant issue number in your pull request. Your time and efforts make Parlay better, and we're grateful for your support and contributions. Thank you! ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: Makefile ================================================ # Copyright 2023 Snyk Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. build: @go build -v test: lint @go test -cover -v ./... acceptance: build @bats -r . lint: @golangci-lint run --fix cover: @go test ./... -coverprofile=/tmp/cover.out @go tool cover -html=/tmp/cover.out specs: @curl --silent https://packages.ecosyste.ms/docs/api/v1/openapi.yaml -o specs/packages.yaml @curl --silent https://repos.ecosyste.ms/docs/api/v1/openapi.yaml -o specs/repos.yaml @curl --silent https://api.snyk.io/rest/openapi/2024-06-26~experimental -o specs/snyk-experimental.json @curl --silent https://api.snyk.io/rest/openapi/2024-06-26 -o specs/snyk.json clients: specs @oapi-codegen -generate types,client -package packages specs/packages.yaml > ecosystems/packages/packages.go @oapi-codegen -generate types,client -package repos specs/repos.yaml > ecosystems/repos/repos.go @oapi-codegen -generate types,client -package users -include-tags Users specs/snyk-experimental.json > snyk/users/users.go @oapi-codegen -generate types,client -package issues -include-tags Issues specs/snyk.json > snyk/issues/issues.go sed -i '' 's/"purl", runtime.ParamLocationPath, purl/"purl", runtime.ParamLocationQuery, purl/' snyk/issues/issues.go fmt: @gofmt -s -w -l . .PHONY: build test acceptance lint cover specs patch clients fmt ================================================ FILE: NOTICE ================================================ © 2023 Snyk Limited All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ### Third party software ### We use third-party libraries, whose license information is included the acknowledgements.tar.gz file as part of each release.. ================================================ FILE: README.md ================================================ # Parlay [![CI](https://github.com/snyk/parlay/actions/workflows/ci.yml/badge.svg)](https://github.com/snyk/parlay/actions/workflows/ci.yml) [![Security](https://github.com/snyk/parlay/actions/workflows/security.yml/badge.svg)](https://github.com/snyk/parlay/actions/workflows/security.yml) ## Enriching SBOMs `parlay` will take a CycloneDX (JSON, XML) or SPDX 2.3 (JSON) document and enrich it with information taken from external services. At present this includes: * [ecosyste.ms](https://ecosyste.ms) * [Snyk](https://snyk.io) * [OpenSSF Scorecard](https://securityscorecards.dev/) By enrich, we mean add additional information. You put in an SBOM, and you get a richer SBOM back. In many cases SBOMs have a minimum of information, often just the name and version of a given package. By enriching that with additional information we can make better decisions about the packages we're using. ## Enriching with ecosyste.ms Let's take a simple CycloneDX SBOM of a Javascript application. Using `parlay` we enrich it using data from [ecosyste.ms](https://ecosyste.ms), adding information about the package license, external links, the maintainer and more. ``` $ cat testing/sbom.cyclonedx.json ... { "bom-ref": "68-subtext@6.0.12", "type": "library", "name": "subtext", "version": "6.0.12", "purl": "pkg:npm/subtext@6.0.12" } ... $ cat testing/sbom.cyclonedx.json | parlay ecosystems enrich - | jq ... { "bom-ref": "68-subtext@6.0.12", "type": "library", "supplier": { "name": "hapi.js", "url": [ "https://hapi.dev" ] }, "author": "hapi.js", "name": "subtext", "version": "6.0.12", "description": "HTTP payload parsing", "licenses": [ { "expression": "BSD-3-Clause" } ], "purl": "pkg:npm/subtext@6.0.12", "externalReferences": [ { "url": "https://github.com/hapijs/subtext", "type": "website" }, { "url": "https://www.npmjs.com/package/subtext", "type": "distribution" }, { "url": "https://github.com/hapijs/subtext", "type": "vcs" } ], "properties": [ { "name": "ecosystems:first_release_published_at", "value": "2014-09-29T01:56:03Z" }, { "name": "ecosystems:latest_release_published_at", "value": "2019-01-31T19:36:58Z" } ] } ... ``` What about with SPDX? Let's take an SBOM containing a list of packages like so: ```json { "name": "concat-map", "SPDXID": "SPDXRef-7-concat-map-0.0.1", "versionInfo": "0.0.1", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/concat-map@0.0.1" } ] } ``` Running `parlay ecosystems enrich ` will add additional information: ```diff { "name": "concat-map", "SPDXID": "SPDXRef-7-concat-map-0.0.1", "versionInfo": "0.0.1", "downloadLocation": "NOASSERTION", + "homepage": "https://github.com/ljharb/concat-map", + "licenseConcluded": "MIT", "copyrightText": "NOASSERTION", + "description": "concatenative mapdashery", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/concat-map@0.0.1" } ] ``` There are a few other utility commands for ecosyste.ms as well. The first returns raw JSON information about a specific package from ecosyste.ms: ``` parlay ecosystems package pkg:npm/snyk ``` You can also return raw JSON information about a specific repository: ``` parlay ecosystems repo https://github.com/open-policy-agent/conftest ``` ### License data parlay enriches components and packages with their license information from ecosyste.ms on a best-effort basis. It prefers the license data of the package version at hand; however, it may not always be possible to retrieve the license for a specific version (see [ecosyste.ms issue here](https://github.com/ecosyste-ms/packages/issues/1027) for more info). In this case, parlay will fall back to enriching with the license data of the package's latest release. In rare cases — where the licensing model of a package changed over time — this may result in license data inaccuracies. ## Enriching with Snyk `parlay` can also enrich an SBOM with Vulnerability information from Snyk. It's important to note vulnerability data is moment-in-time information. By adding vulnerability information directly to the SBOM this makes the SBOM moment-in-time too. Note the Snyk commands require you to be a Snyk customer, and require passing a valid Snyk API token in the `SNYK_TOKEN` environment variable. The API base url can be set using the `SNYK_API` environment variable, and if missing it will default to `https://api.snyk.io`. ``` parlay snyk enrich testing/sbom.cyclonedx.json ``` Snyk will add a new [vulnerability](https://cyclonedx.org/docs/1.4/json/#vulnerabilities) attribute to the SBOM, for example: ```json "vulnerabilities": [ { "bom-ref": "68-subtext@6.0.12", "id": "SNYK-JS-SUBTEXT-467257", "ratings": [ { "source": { "name": "Snyk", "url": "https://security.snyk.io" }, "score": 7.5, "severity": "high", "method": "CVSSv31", "vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H" } ], "cwes": [ 400 ], "description": "Denial of Service (DoS)", "detail": "...", "advisories": [ { "title": "GitHub Commit", "url": "https://github.com/brave-intl/subtext/commit/9557c115b1384191a0d6e4a9ea028fedf8b44ae6" }, { "title": "GitHub Issue", "url": "https://github.com/hapijs/subtext/issues/72" }, { "title": "NPM Security Advisory", "url": "https://www.npmjs.com/advisories/1168" } ], "created": "2019-09-19T10:25:11Z", "updated": "2020-12-14T14:41:09Z" } ``` For SPDX, vulnerability informatio is added as additional `externalRefs`: ```json { "referenceCategory": "SECURITY", "referenceType": "advisory", "referenceLocator": "https://security.snyk.io/vuln/SNYK-JS-MINIMATCH-3050818", "comment": "Regular Expression Denial of Service (ReDoS)" }, { "referenceCategory": "SECURITY", "referenceType": "advisory", "referenceLocator": "https://security.snyk.io/vuln/SNYK-JS-MINIMATCH-1019388", "comment": "Regular Expression Denial of Service (ReDoS)" } ``` Return raw JSON information about vulnerabilities in a specific package from Snyk: ``` parlay snyk package pkg:npm/sqliter@1.0.1 ``` ## Enriching with OpenSSF Scorecard The [OpenSSF Scorecard project](https://securityscorecards.dev/) tests various aspects of a projects security posture and provides a score. `parlay` supports added a link to this data with the `parlay scorecard enrich` command. You can use this like so: ``` parlay scorecard enrich testing/sbom2.cyclonedx.json ``` This will currently add an external reference to the [Scorecard API](https://api.securityscorecards.dev/) which can be used to retrieve the full scorecard. ```json { "bom-ref": "103-org.springframework:spring-webmvc@5.3.3", "type": "library", "name": "org.springframework:spring-webmvc", "version": "5.3.3", "purl": "pkg:maven/org.springframework/spring-webmvc@5.3.3", "externalReferences": [ { "url": "https://api.securityscorecards.dev/projects/github.com/spring-projects/spring-framework", "comment": "OpenSSF Scorecard", "type": "other" } ] }, ``` We're currently looking at the best way of encoding some of the scorecard data in the SBOM itself as well. ## What about enriching with other data sources? There are lots of other sources of package data, and it would be great to add support for them in `parlay`. Please open issues and PRs with ideas. ## Pipes! `parlay` is a fan of stdin and stdout. You can pipe SBOMs from other tools into `parlay`, and pipe between the separate `enrich` commands too. Maybe you want to enrich an SBOM with both ecosyste.ms and Snyk data: ``` cat testing/sbom.cyclonedx.json | ./parlay e enrich - | ./parlay s enrich - | jq ``` Maybe you want to take the output from Syft and add vulnerabilitity data? ``` syft -o cyclonedx-json nginx | parlay s enrich - | jq ``` Maybe you want to geneate an SBOM with `cdxgen`, enrich that with extra information, and test that with `bomber`: ``` cdxgen -o | parlay e enrich - | bomber scan --provider snyk - ``` The ecosyste.ms enrichment adds license information, which Bomber then surfaces: ``` ■ Ecosystems detected: gem ■ Scanning 18 packages for vulnerabilities... ■ Vulnerability Provider: Snyk (https://security.snyk.io) ■ Files Scanned - (sha256:701770b2317ea8cbd03aa398ecb6a0381c85beaf24d46c45665b53331816e360) ■ Licenses Found: MIT, Apache-2.0, BSD-3-Clause, Ruby ``` ## Installation `parlay` binaries are available from [GitHub Releases](https://github.com/snyk/parlay/releases). Just select the archive for your operating system and architecture. For instance, you could download for macOS ARM machines with the following, substituting `{version}` for the latest version number, for instance `0.1.4`. ``` wget https://github.com/snyk/parlay/releases/download/v{version}/parlay_Darwin_arm64.tar.gz tar -xvf parlay_Darwin_arm64.tar.gz ``` ## Supported package types The various services used to enrich the SBOM data have data for a subset of purl types: ### Ecosystems * `apk` * `cargo` * `cocoapods` * `composer` * `gem` * `golang` * `hex` * `maven` * `npm` * `nuget` * `pypi` ### Snyk * `apk` * `cargo` * `cocoapods` * `composer` * `deb` * `gem` * `golang` * `hex` * `maven` * `npm` * `nuget` * `pypi` * `rpm` * `swift` ### OpenSSF Scorecard * `apk` * `cargo` * `cocoapods` * `composer` * `gem` * `golang` * `hex` * `maven` * `npm` * `nuget` * `pypi` Note that Scorecard data is available only for a subset of projects from supported Git repositories. See the [Scorecard project](https://github.com/ossf/scorecard) for more information. ================================================ FILE: SECURITY.md ================================================ ## Reporting Security Issues To report a security vulnerability to us, please see https://docs.snyk.io/snyk-data-and-governance/reporting-security-issues. ================================================ FILE: acceptance.bats ================================================ #!/usr/bin/env bats @test "Not fail when testing a JavaScript SBOM" { run ./parlay ecosystems enrich testing/sbom.cyclonedx.json [ "$status" -eq 0 ] } @test "Not fail when testing a JavaScript CycloneDX 1.5 SBOM" { run ./parlay ecosystems enrich testing/sbom.cyclonedx-1.5.json [ "$status" -eq 0 ] } @test "Not fail when testing an SBOM on stdin" { run bash -c "cat testing/sbom.cyclonedx.json | ./parlay ecosystems enrich -" [ "$status" -eq 0 ] } @test "Not fail when testing a Java SBOM" { run ./parlay ecosystems enrich testing/sbom2.cyclonedx.json [ "$status" -eq 0 ] } @test "Not fail when testing a CycloneDX XML SBOM" { run ./parlay ecosystems enrich testing/sbom.cyclonedx.xml [ "$status" -eq 0 ] } @test "Fail when testing a non-existent file" { run ./parlay ecosystems enrich not-here [ "$status" -eq 1 ] } ================================================ FILE: catalog-info.yaml ================================================ apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: parlay annotations: github.com/project-slug: snyk/parlay github.com/team-slug: snyk/link spec: type: external-tooling lifecycle: "-" owner: link ================================================ FILE: ecosystems/packages/packages.go ================================================ // Package packages provides primitives to interact with the openapi HTTP API. // // Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT. package packages import ( "context" "encoding/json" "fmt" "io" "net/http" "net/url" "strings" "time" "github.com/oapi-codegen/runtime" ) // Advisory defines model for Advisory. type Advisory struct { Classification *string `json:"classification"` CreatedAt string `json:"created_at"` CvssScore *float32 `json:"cvss_score"` CvssVector *string `json:"cvss_vector"` Description *string `json:"description"` Identifiers []string `json:"identifiers"` Origin *string `json:"origin"` Packages []map[string]interface{} `json:"packages"` PublishedAt *string `json:"published_at"` References []string `json:"references"` Severity *string `json:"severity"` SourceKind *string `json:"source_kind"` Title *string `json:"title"` UpdatedAt string `json:"updated_at"` Url *string `json:"url"` Uuid string `json:"uuid"` WithdrawnAt *string `json:"withdrawn_at"` } // Dependency defines model for Dependency. type Dependency struct { Ecosystem string `json:"ecosystem"` Id int `json:"id"` Kind *string `json:"kind"` Optional *bool `json:"optional"` PackageName string `json:"package_name"` Requirements *string `json:"requirements"` } // Keyword defines model for Keyword. type Keyword struct { Name string `json:"name"` PackagesCount int `json:"packages_count"` PackagesUrl string `json:"packages_url"` } // KeywordWithPackages defines model for KeywordWithPackages. type KeywordWithPackages struct { Name string `json:"name"` Packages []Package `json:"packages"` PackagesCount int `json:"packages_count"` PackagesUrl string `json:"packages_url"` RelatedKeywords []Keyword `json:"related_keywords"` } // Maintainer defines model for Maintainer. type Maintainer struct { CreatedAt time.Time `json:"created_at"` Email *string `json:"email"` HtmlUrl *string `json:"html_url"` Login *string `json:"login"` Name *string `json:"name"` PackagesCount int `json:"packages_count"` PackagesUrl string `json:"packages_url"` Role *string `json:"role"` TotalDownloads int `json:"total_downloads"` UpdatedAt time.Time `json:"updated_at"` Url *string `json:"url"` Uuid string `json:"uuid"` } // Namespace defines model for Namespace. type Namespace struct { Name string `json:"name"` PackagesCount int `json:"packages_count"` PackagesUrl string `json:"packages_url"` } // Package defines model for Package. type Package struct { Advisories []Advisory `json:"advisories"` CreatedAt time.Time `json:"created_at"` Critical bool `json:"critical"` DependentPackagesCount int `json:"dependent_packages_count"` DependentPackagesUrl string `json:"dependent_packages_url"` DependentReposCount int `json:"dependent_repos_count"` DependentRepositoriesUrl string `json:"dependent_repositories_url"` Description *string `json:"description"` DockerDependentsCount int `json:"docker_dependents_count"` DockerDownloadsCount int `json:"docker_downloads_count"` DockerUsageUrl string `json:"docker_usage_url"` DocumentationUrl *string `json:"documentation_url"` Downloads int `json:"downloads"` DownloadsPeriod *string `json:"downloads_period"` Ecosystem string `json:"ecosystem"` FirstReleasePublishedAt *time.Time `json:"first_release_published_at"` FundingLinks []string `json:"funding_links"` Homepage *string `json:"homepage"` Id int `json:"id"` InstallCommand *string `json:"install_command"` KeywordsArray []string `json:"keywords_array"` LastSyncedAt *time.Time `json:"last_synced_at"` LatestReleaseNumber *string `json:"latest_release_number"` LatestReleasePublishedAt *time.Time `json:"latest_release_published_at"` Licenses *string `json:"licenses"` Maintainers []Maintainer `json:"maintainers"` Metadata *map[string]interface{} `json:"metadata"` Name string `json:"name"` Namespace *string `json:"namespace"` NormalizedLicenses []string `json:"normalized_licenses"` Purl string `json:"purl"` Rankings map[string]interface{} `json:"rankings"` RegistryUrl *string `json:"registry_url"` RelatedPackagesUrl string `json:"related_packages_url"` RepoMetadata *map[string]interface{} `json:"repo_metadata"` RepoMetadataUpdatedAt *time.Time `json:"repo_metadata_updated_at"` RepositoryUrl *string `json:"repository_url"` Status *string `json:"status"` UpdatedAt time.Time `json:"updated_at"` UsageUrl string `json:"usage_url"` VersionNumbersUrl *string `json:"version_numbers_url,omitempty"` VersionsCount int `json:"versions_count"` VersionsUrl string `json:"versions_url"` } // PackageWithRegistry defines model for PackageWithRegistry. type PackageWithRegistry struct { Advisories []Advisory `json:"advisories"` CreatedAt time.Time `json:"created_at"` Critical bool `json:"critical"` DependentPackagesCount int `json:"dependent_packages_count"` DependentPackagesUrl string `json:"dependent_packages_url"` DependentReposCount int `json:"dependent_repos_count"` DependentRepositoriesUrl string `json:"dependent_repositories_url"` Description *string `json:"description"` DockerDependentsCount int `json:"docker_dependents_count"` DockerDownloadsCount int `json:"docker_downloads_count"` DockerUsageUrl string `json:"docker_usage_url"` DocumentationUrl *string `json:"documentation_url"` Downloads int `json:"downloads"` DownloadsPeriod *string `json:"downloads_period"` Ecosystem string `json:"ecosystem"` FirstReleasePublishedAt *time.Time `json:"first_release_published_at"` FundingLinks []string `json:"funding_links"` Homepage *string `json:"homepage"` Id int `json:"id"` InstallCommand *string `json:"install_command"` KeywordsArray []string `json:"keywords_array"` LastSyncedAt *time.Time `json:"last_synced_at"` LatestReleaseNumber *string `json:"latest_release_number"` LatestReleasePublishedAt *time.Time `json:"latest_release_published_at"` Licenses *string `json:"licenses"` Maintainers []Maintainer `json:"maintainers"` Metadata *map[string]interface{} `json:"metadata"` Name string `json:"name"` Namespace *string `json:"namespace"` NormalizedLicenses []string `json:"normalized_licenses"` Purl string `json:"purl"` Rankings map[string]interface{} `json:"rankings"` Registry Registry `json:"registry"` RegistryUrl *string `json:"registry_url"` RelatedPackagesUrl string `json:"related_packages_url"` RepoMetadata *map[string]interface{} `json:"repo_metadata"` RepoMetadataUpdatedAt *time.Time `json:"repo_metadata_updated_at"` RepositoryUrl *string `json:"repository_url"` Status *string `json:"status"` UpdatedAt time.Time `json:"updated_at"` UsageUrl string `json:"usage_url"` VersionNumbersUrl *string `json:"version_numbers_url,omitempty"` VersionsCount int `json:"versions_count"` VersionsUrl string `json:"versions_url"` } // Registry defines model for Registry. type Registry struct { CreatedAt time.Time `json:"created_at"` Default bool `json:"default"` Downloads int64 `json:"downloads"` Ecosystem string `json:"ecosystem"` Github *string `json:"github"` IconUrl string `json:"icon_url"` KeywordsCount int64 `json:"keywords_count"` MaintainersCount int64 `json:"maintainers_count"` MaintainersUrl string `json:"maintainers_url"` Metadata *map[string]interface{} `json:"metadata"` Name string `json:"name"` NamespacesCount int64 `json:"namespaces_count"` PackagesCount int64 `json:"packages_count"` PackagesUrl string `json:"packages_url"` PurlType string `json:"purl_type"` UpdatedAt time.Time `json:"updated_at"` Url string `json:"url"` VersionsCount *int64 `json:"versions_count,omitempty"` } // Version defines model for Version. type Version struct { CreatedAt time.Time `json:"created_at"` DocumentationUrl *string `json:"documentation_url"` DownloadUrl *string `json:"download_url"` Id int `json:"id"` InstallCommand *string `json:"install_command"` Integrity *string `json:"integrity"` Licenses *string `json:"licenses"` Metadata *map[string]interface{} `json:"metadata"` Number string `json:"number"` PublishedAt *string `json:"published_at"` Purl string `json:"purl"` RegistryUrl *string `json:"registry_url"` RelatedTag map[string]interface{} `json:"related_tag"` Status *string `json:"status"` UpdatedAt time.Time `json:"updated_at"` VersionUrl string `json:"version_url"` } // VersionWithDependencies defines model for VersionWithDependencies. type VersionWithDependencies struct { CreatedAt time.Time `json:"created_at"` Dependencies []Dependency `json:"dependencies"` DocumentationUrl *string `json:"documentation_url"` DownloadUrl *string `json:"download_url"` Id *int `json:"id,omitempty"` InstallCommand *string `json:"install_command"` Integrity *string `json:"integrity"` Latest bool `json:"latest"` Licenses *string `json:"licenses"` Metadata *map[string]interface{} `json:"metadata"` Number string `json:"number"` PublishedAt *string `json:"published_at"` Purl string `json:"purl"` RegistryUrl *string `json:"registry_url"` RelatedTag map[string]interface{} `json:"related_tag"` Status *string `json:"status"` UpdatedAt time.Time `json:"updated_at"` VersionUrl string `json:"version_url"` } // VersionWithPackage defines model for VersionWithPackage. type VersionWithPackage struct { CreatedAt time.Time `json:"created_at"` DocumentationUrl *string `json:"documentation_url"` DownloadUrl *string `json:"download_url"` Id int `json:"id"` InstallCommand *string `json:"install_command"` Integrity *string `json:"integrity"` Latest bool `json:"latest"` Licenses *string `json:"licenses"` Metadata *map[string]interface{} `json:"metadata"` Number string `json:"number"` PackageUrl string `json:"package_url"` PublishedAt *string `json:"published_at"` Purl string `json:"purl"` RegistryUrl *string `json:"registry_url"` Status *string `json:"status"` UpdatedAt time.Time `json:"updated_at"` VersionUrl string `json:"version_url"` } // GetDependenciesParams defines parameters for GetDependencies. type GetDependenciesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // Ecosystem ecosystem name Ecosystem *string `form:"ecosystem,omitempty" json:"ecosystem,omitempty"` // PackageName package name PackageName *string `form:"package_name,omitempty" json:"package_name,omitempty"` // PackageId package id PackageId *string `form:"package_id,omitempty" json:"package_id,omitempty"` // Requirements requirements Requirements *string `form:"requirements,omitempty" json:"requirements,omitempty"` // Kind kind Kind *string `form:"kind,omitempty" json:"kind,omitempty"` // Optional optional Optional *bool `form:"optional,omitempty" json:"optional,omitempty"` // After filter by id after given id After *string `form:"after,omitempty" json:"after,omitempty"` } // GetKeywordsParams defines parameters for GetKeywords. type GetKeywordsParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // GetKeywordParams defines parameters for GetKeyword. type GetKeywordParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // LookupPackageParams defines parameters for LookupPackage. type LookupPackageParams struct { // RepositoryUrl repository URL RepositoryUrl *string `form:"repository_url,omitempty" json:"repository_url,omitempty"` // Purl package URL Purl *string `form:"purl,omitempty" json:"purl,omitempty"` // Ecosystem ecosystem name Ecosystem *string `form:"ecosystem,omitempty" json:"ecosystem,omitempty"` // Name package name Name *string `form:"name,omitempty" json:"name,omitempty"` // Sort field to sort results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to sort results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetRegistriesParams defines parameters for GetRegistries. type GetRegistriesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // GetRegistryParams defines parameters for GetRegistry. type GetRegistryParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // LookupRegistryPackageParams defines parameters for LookupRegistryPackage. type LookupRegistryPackageParams struct { // RepositoryUrl repository URL RepositoryUrl *string `form:"repository_url,omitempty" json:"repository_url,omitempty"` // Purl package URL Purl *string `form:"purl,omitempty" json:"purl,omitempty"` // Ecosystem ecosystem name Ecosystem *string `form:"ecosystem,omitempty" json:"ecosystem,omitempty"` // Name package name Name *string `form:"name,omitempty" json:"name,omitempty"` // Sort field to sort results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to sort results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetRegistryMaintainersParams defines parameters for GetRegistryMaintainers. type GetRegistryMaintainersParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetRegistryMaintainerPackagesParams defines parameters for GetRegistryMaintainerPackages. type GetRegistryMaintainerPackagesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // GetRegistryNamespacesParams defines parameters for GetRegistryNamespaces. type GetRegistryNamespacesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // GetRegistryNamespacePackagesParams defines parameters for GetRegistryNamespacePackages. type GetRegistryNamespacePackagesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // GetRegistryPackageNamesParams defines parameters for GetRegistryPackageNames. type GetRegistryPackageNamesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // CreatedBefore filter by created_at before given time CreatedBefore *time.Time `form:"created_before,omitempty" json:"created_before,omitempty"` // UpdatedBefore filter by updated_at before given time UpdatedBefore *time.Time `form:"updated_before,omitempty" json:"updated_before,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetRegistryPackagesParams defines parameters for GetRegistryPackages. type GetRegistryPackagesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // CreatedBefore filter by created_at before given time CreatedBefore *time.Time `form:"created_before,omitempty" json:"created_before,omitempty"` // UpdatedBefore filter by updated_at before given time UpdatedBefore *time.Time `form:"updated_before,omitempty" json:"updated_before,omitempty"` // Critical filter by critical packages Critical *bool `form:"critical,omitempty" json:"critical,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetRegistryPackageDependentPackageKindsParams defines parameters for GetRegistryPackageDependentPackageKinds. type GetRegistryPackageDependentPackageKindsParams struct { // Latest filter by latest version Latest *bool `form:"latest,omitempty" json:"latest,omitempty"` } // GetRegistryPackageDependentPackagesParams defines parameters for GetRegistryPackageDependentPackages. type GetRegistryPackageDependentPackagesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` // Latest filter by latest version Latest *bool `form:"latest,omitempty" json:"latest,omitempty"` // Kind filter by dependency kind Kind *string `form:"kind,omitempty" json:"kind,omitempty"` } // GetRegistryPackageRelatedPackagesParams defines parameters for GetRegistryPackageRelatedPackages. type GetRegistryPackageRelatedPackagesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetRegistryPackageVersionsParams defines parameters for GetRegistryPackageVersions. type GetRegistryPackageVersionsParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // PublishedAfter filter by published_at after given time PublishedAfter *time.Time `form:"published_after,omitempty" json:"published_after,omitempty"` // PublishedBefore filter by published_at before given time PublishedBefore *time.Time `form:"published_before,omitempty" json:"published_before,omitempty"` // CreatedBefore filter by created_at before given time CreatedBefore *time.Time `form:"created_before,omitempty" json:"created_before,omitempty"` // UpdatedBefore filter by updated_at before given time UpdatedBefore *time.Time `form:"updated_before,omitempty" json:"updated_before,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetRegistryRecentVersionsParams defines parameters for GetRegistryRecentVersions. type GetRegistryRecentVersionsParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // PublishedAfter filter by published_at after given time PublishedAfter *time.Time `form:"published_after,omitempty" json:"published_after,omitempty"` // PublishedBefore filter by published_at before given time PublishedBefore *time.Time `form:"published_before,omitempty" json:"published_before,omitempty"` // CreatedBefore filter by created_at before given time CreatedBefore *time.Time `form:"created_before,omitempty" json:"created_before,omitempty"` // UpdatedBefore filter by updated_at before given time UpdatedBefore *time.Time `form:"updated_before,omitempty" json:"updated_before,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // RequestEditorFn is the function signature for the RequestEditor callback function type RequestEditorFn func(ctx context.Context, req *http.Request) error // Doer performs HTTP requests. // // The standard http.Client implements this interface. type HttpRequestDoer interface { Do(req *http.Request) (*http.Response, error) } // Client which conforms to the OpenAPI3 specification for this service. type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn } // ClientOption allows setting custom parameters during construction type ClientOption func(*Client) error // Creates a new Client, with reasonable defaults func NewClient(server string, opts ...ClientOption) (*Client, error) { // create a client with sane default values client := Client{ Server: server, } // mutate client and add all optional params for _, o := range opts { if err := o(&client); err != nil { return nil, err } } // ensure the server URL always has a trailing slash if !strings.HasSuffix(client.Server, "/") { client.Server += "/" } // create httpClient, if not already present if client.Client == nil { client.Client = &http.Client{} } return &client, nil } // WithHTTPClient allows overriding the default Doer, which is // automatically created using http.Client. This is useful for tests. func WithHTTPClient(doer HttpRequestDoer) ClientOption { return func(c *Client) error { c.Client = doer return nil } } // WithRequestEditorFn allows setting up a callback function, which will be // called right before sending the request. This can be used to mutate the request. func WithRequestEditorFn(fn RequestEditorFn) ClientOption { return func(c *Client) error { c.RequestEditors = append(c.RequestEditors, fn) return nil } } // The interface specification for the client above. type ClientInterface interface { // GetDependencies request GetDependencies(ctx context.Context, params *GetDependenciesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetKeywords request GetKeywords(ctx context.Context, params *GetKeywordsParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetKeyword request GetKeyword(ctx context.Context, keywordName string, params *GetKeywordParams, reqEditors ...RequestEditorFn) (*http.Response, error) // LookupPackage request LookupPackage(ctx context.Context, params *LookupPackageParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistries request GetRegistries(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistry request GetRegistry(ctx context.Context, registryName string, params *GetRegistryParams, reqEditors ...RequestEditorFn) (*http.Response, error) // LookupRegistryPackage request LookupRegistryPackage(ctx context.Context, registryName string, params *LookupRegistryPackageParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryMaintainers request GetRegistryMaintainers(ctx context.Context, registryName string, params *GetRegistryMaintainersParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryMaintainer request GetRegistryMaintainer(ctx context.Context, registryName string, maintainerLoginOrUUID string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryMaintainerPackages request GetRegistryMaintainerPackages(ctx context.Context, registryName string, maintainerLoginOrUUID string, params *GetRegistryMaintainerPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryNamespaces request GetRegistryNamespaces(ctx context.Context, registryName string, params *GetRegistryNamespacesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryNamespace request GetRegistryNamespace(ctx context.Context, registryName string, namespaceName string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryNamespacePackages request GetRegistryNamespacePackages(ctx context.Context, registryName string, namespaceName string, params *GetRegistryNamespacePackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackageNames request GetRegistryPackageNames(ctx context.Context, registryName string, params *GetRegistryPackageNamesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackages request GetRegistryPackages(ctx context.Context, registryName string, params *GetRegistryPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackage request GetRegistryPackage(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackageDependentPackageKinds request GetRegistryPackageDependentPackageKinds(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackageKindsParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackageDependentPackages request GetRegistryPackageDependentPackages(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackageRelatedPackages request GetRegistryPackageRelatedPackages(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageRelatedPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackageVersionNumbers request GetRegistryPackageVersionNumbers(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackageVersions request GetRegistryPackageVersions(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryPackageVersion request GetRegistryPackageVersion(ctx context.Context, registryName string, packageName string, versionNumber string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetRegistryRecentVersions request GetRegistryRecentVersions(ctx context.Context, registryName string, params *GetRegistryRecentVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error) } func (c *Client) GetDependencies(ctx context.Context, params *GetDependenciesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetDependenciesRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetKeywords(ctx context.Context, params *GetKeywordsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetKeywordsRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetKeyword(ctx context.Context, keywordName string, params *GetKeywordParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetKeywordRequest(c.Server, keywordName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) LookupPackage(ctx context.Context, params *LookupPackageParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewLookupPackageRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistries(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistriesRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistry(ctx context.Context, registryName string, params *GetRegistryParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryRequest(c.Server, registryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) LookupRegistryPackage(ctx context.Context, registryName string, params *LookupRegistryPackageParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewLookupRegistryPackageRequest(c.Server, registryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryMaintainers(ctx context.Context, registryName string, params *GetRegistryMaintainersParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryMaintainersRequest(c.Server, registryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryMaintainer(ctx context.Context, registryName string, maintainerLoginOrUUID string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryMaintainerRequest(c.Server, registryName, maintainerLoginOrUUID) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryMaintainerPackages(ctx context.Context, registryName string, maintainerLoginOrUUID string, params *GetRegistryMaintainerPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryMaintainerPackagesRequest(c.Server, registryName, maintainerLoginOrUUID, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryNamespaces(ctx context.Context, registryName string, params *GetRegistryNamespacesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryNamespacesRequest(c.Server, registryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryNamespace(ctx context.Context, registryName string, namespaceName string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryNamespaceRequest(c.Server, registryName, namespaceName) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryNamespacePackages(ctx context.Context, registryName string, namespaceName string, params *GetRegistryNamespacePackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryNamespacePackagesRequest(c.Server, registryName, namespaceName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackageNames(ctx context.Context, registryName string, params *GetRegistryPackageNamesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageNamesRequest(c.Server, registryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackages(ctx context.Context, registryName string, params *GetRegistryPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackagesRequest(c.Server, registryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackage(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageRequest(c.Server, registryName, packageName) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackageDependentPackageKinds(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackageKindsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageDependentPackageKindsRequest(c.Server, registryName, packageName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackageDependentPackages(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageDependentPackagesRequest(c.Server, registryName, packageName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackageRelatedPackages(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageRelatedPackagesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageRelatedPackagesRequest(c.Server, registryName, packageName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackageVersionNumbers(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageVersionNumbersRequest(c.Server, registryName, packageName) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackageVersions(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageVersionsRequest(c.Server, registryName, packageName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryPackageVersion(ctx context.Context, registryName string, packageName string, versionNumber string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryPackageVersionRequest(c.Server, registryName, packageName, versionNumber) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetRegistryRecentVersions(ctx context.Context, registryName string, params *GetRegistryRecentVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistryRecentVersionsRequest(c.Server, registryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } // NewGetDependenciesRequest generates requests for GetDependencies func NewGetDependenciesRequest(server string, params *GetDependenciesParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/dependencies") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Ecosystem != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "ecosystem", runtime.ParamLocationQuery, *params.Ecosystem); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PackageName != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "package_name", runtime.ParamLocationQuery, *params.PackageName); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PackageId != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "package_id", runtime.ParamLocationQuery, *params.PackageId); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Requirements != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "requirements", runtime.ParamLocationQuery, *params.Requirements); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Kind != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "kind", runtime.ParamLocationQuery, *params.Kind); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Optional != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "optional", runtime.ParamLocationQuery, *params.Optional); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.After != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "after", runtime.ParamLocationQuery, *params.After); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetKeywordsRequest generates requests for GetKeywords func NewGetKeywordsRequest(server string, params *GetKeywordsParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/keywords") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetKeywordRequest generates requests for GetKeyword func NewGetKeywordRequest(server string, keywordName string, params *GetKeywordParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "keywordName", runtime.ParamLocationPath, keywordName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/keywords/%s", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewLookupPackageRequest generates requests for LookupPackage func NewLookupPackageRequest(server string, params *LookupPackageParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/packages/lookup") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.RepositoryUrl != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "repository_url", runtime.ParamLocationQuery, *params.RepositoryUrl); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Purl != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "purl", runtime.ParamLocationQuery, *params.Purl); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Ecosystem != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "ecosystem", runtime.ParamLocationQuery, *params.Ecosystem); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Name != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "name", runtime.ParamLocationQuery, *params.Name); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistriesRequest generates requests for GetRegistries func NewGetRegistriesRequest(server string, params *GetRegistriesParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryRequest generates requests for GetRegistry func NewGetRegistryRequest(server string, registryName string, params *GetRegistryParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewLookupRegistryPackageRequest generates requests for LookupRegistryPackage func NewLookupRegistryPackageRequest(server string, registryName string, params *LookupRegistryPackageParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/lookup", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.RepositoryUrl != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "repository_url", runtime.ParamLocationQuery, *params.RepositoryUrl); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Purl != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "purl", runtime.ParamLocationQuery, *params.Purl); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Ecosystem != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "ecosystem", runtime.ParamLocationQuery, *params.Ecosystem); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Name != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "name", runtime.ParamLocationQuery, *params.Name); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryMaintainersRequest generates requests for GetRegistryMaintainers func NewGetRegistryMaintainersRequest(server string, registryName string, params *GetRegistryMaintainersParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/maintainers", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryMaintainerRequest generates requests for GetRegistryMaintainer func NewGetRegistryMaintainerRequest(server string, registryName string, maintainerLoginOrUUID string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "MaintainerLoginOrUUID", runtime.ParamLocationPath, maintainerLoginOrUUID) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/maintainers/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryMaintainerPackagesRequest generates requests for GetRegistryMaintainerPackages func NewGetRegistryMaintainerPackagesRequest(server string, registryName string, maintainerLoginOrUUID string, params *GetRegistryMaintainerPackagesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "MaintainerLoginOrUUID", runtime.ParamLocationPath, maintainerLoginOrUUID) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/maintainers/%s/packages", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryNamespacesRequest generates requests for GetRegistryNamespaces func NewGetRegistryNamespacesRequest(server string, registryName string, params *GetRegistryNamespacesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/namespaces", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryNamespaceRequest generates requests for GetRegistryNamespace func NewGetRegistryNamespaceRequest(server string, registryName string, namespaceName string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "namespaceName", runtime.ParamLocationPath, namespaceName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/namespaces/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryNamespacePackagesRequest generates requests for GetRegistryNamespacePackages func NewGetRegistryNamespacePackagesRequest(server string, registryName string, namespaceName string, params *GetRegistryNamespacePackagesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "namespaceName", runtime.ParamLocationPath, namespaceName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/namespaces/%s/packages", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageNamesRequest generates requests for GetRegistryPackageNames func NewGetRegistryPackageNamesRequest(server string, registryName string, params *GetRegistryPackageNamesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/package_names", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_before", runtime.ParamLocationQuery, *params.CreatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_before", runtime.ParamLocationQuery, *params.UpdatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackagesRequest generates requests for GetRegistryPackages func NewGetRegistryPackagesRequest(server string, registryName string, params *GetRegistryPackagesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_before", runtime.ParamLocationQuery, *params.CreatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_before", runtime.ParamLocationQuery, *params.UpdatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Critical != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "critical", runtime.ParamLocationQuery, *params.Critical); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageRequest generates requests for GetRegistryPackage func NewGetRegistryPackageRequest(server string, registryName string, packageName string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "packageName", runtime.ParamLocationPath, packageName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageDependentPackageKindsRequest generates requests for GetRegistryPackageDependentPackageKinds func NewGetRegistryPackageDependentPackageKindsRequest(server string, registryName string, packageName string, params *GetRegistryPackageDependentPackageKindsParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "packageName", runtime.ParamLocationPath, packageName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages/%s/dependent_package_kinds", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Latest != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "latest", runtime.ParamLocationQuery, *params.Latest); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageDependentPackagesRequest generates requests for GetRegistryPackageDependentPackages func NewGetRegistryPackageDependentPackagesRequest(server string, registryName string, packageName string, params *GetRegistryPackageDependentPackagesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "packageName", runtime.ParamLocationPath, packageName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages/%s/dependent_packages", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Latest != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "latest", runtime.ParamLocationQuery, *params.Latest); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Kind != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "kind", runtime.ParamLocationQuery, *params.Kind); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageRelatedPackagesRequest generates requests for GetRegistryPackageRelatedPackages func NewGetRegistryPackageRelatedPackagesRequest(server string, registryName string, packageName string, params *GetRegistryPackageRelatedPackagesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "packageName", runtime.ParamLocationPath, packageName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages/%s/related_packages", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageVersionNumbersRequest generates requests for GetRegistryPackageVersionNumbers func NewGetRegistryPackageVersionNumbersRequest(server string, registryName string, packageName string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "packageName", runtime.ParamLocationPath, packageName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages/%s/version_numbers", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageVersionsRequest generates requests for GetRegistryPackageVersions func NewGetRegistryPackageVersionsRequest(server string, registryName string, packageName string, params *GetRegistryPackageVersionsParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "packageName", runtime.ParamLocationPath, packageName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages/%s/versions", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PublishedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "published_after", runtime.ParamLocationQuery, *params.PublishedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PublishedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "published_before", runtime.ParamLocationQuery, *params.PublishedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_before", runtime.ParamLocationQuery, *params.CreatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_before", runtime.ParamLocationQuery, *params.UpdatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryPackageVersionRequest generates requests for GetRegistryPackageVersion func NewGetRegistryPackageVersionRequest(server string, registryName string, packageName string, versionNumber string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "packageName", runtime.ParamLocationPath, packageName) if err != nil { return nil, err } var pathParam2 string pathParam2, err = runtime.StyleParamWithLocation("simple", false, "versionNumber", runtime.ParamLocationPath, versionNumber) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/packages/%s/versions/%s", pathParam0, pathParam1, pathParam2) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetRegistryRecentVersionsRequest generates requests for GetRegistryRecentVersions func NewGetRegistryRecentVersionsRequest(server string, registryName string, params *GetRegistryRecentVersionsParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "registryName", runtime.ParamLocationPath, registryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/registries/%s/versions", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PublishedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "published_after", runtime.ParamLocationQuery, *params.PublishedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PublishedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "published_before", runtime.ParamLocationQuery, *params.PublishedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_before", runtime.ParamLocationQuery, *params.CreatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_before", runtime.ParamLocationQuery, *params.UpdatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } func (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error { for _, r := range c.RequestEditors { if err := r(ctx, req); err != nil { return err } } for _, r := range additionalEditors { if err := r(ctx, req); err != nil { return err } } return nil } // ClientWithResponses builds on ClientInterface to offer response payloads type ClientWithResponses struct { ClientInterface } // NewClientWithResponses creates a new ClientWithResponses, which wraps // Client with return type handling func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { client, err := NewClient(server, opts...) if err != nil { return nil, err } return &ClientWithResponses{client}, nil } // WithBaseURL overrides the baseURL. func WithBaseURL(baseURL string) ClientOption { return func(c *Client) error { newBaseURL, err := url.Parse(baseURL) if err != nil { return err } c.Server = newBaseURL.String() return nil } } // ClientWithResponsesInterface is the interface specification for the client with responses above. type ClientWithResponsesInterface interface { // GetDependenciesWithResponse request GetDependenciesWithResponse(ctx context.Context, params *GetDependenciesParams, reqEditors ...RequestEditorFn) (*GetDependenciesResponse, error) // GetKeywordsWithResponse request GetKeywordsWithResponse(ctx context.Context, params *GetKeywordsParams, reqEditors ...RequestEditorFn) (*GetKeywordsResponse, error) // GetKeywordWithResponse request GetKeywordWithResponse(ctx context.Context, keywordName string, params *GetKeywordParams, reqEditors ...RequestEditorFn) (*GetKeywordResponse, error) // LookupPackageWithResponse request LookupPackageWithResponse(ctx context.Context, params *LookupPackageParams, reqEditors ...RequestEditorFn) (*LookupPackageResponse, error) // GetRegistriesWithResponse request GetRegistriesWithResponse(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*GetRegistriesResponse, error) // GetRegistryWithResponse request GetRegistryWithResponse(ctx context.Context, registryName string, params *GetRegistryParams, reqEditors ...RequestEditorFn) (*GetRegistryResponse, error) // LookupRegistryPackageWithResponse request LookupRegistryPackageWithResponse(ctx context.Context, registryName string, params *LookupRegistryPackageParams, reqEditors ...RequestEditorFn) (*LookupRegistryPackageResponse, error) // GetRegistryMaintainersWithResponse request GetRegistryMaintainersWithResponse(ctx context.Context, registryName string, params *GetRegistryMaintainersParams, reqEditors ...RequestEditorFn) (*GetRegistryMaintainersResponse, error) // GetRegistryMaintainerWithResponse request GetRegistryMaintainerWithResponse(ctx context.Context, registryName string, maintainerLoginOrUUID string, reqEditors ...RequestEditorFn) (*GetRegistryMaintainerResponse, error) // GetRegistryMaintainerPackagesWithResponse request GetRegistryMaintainerPackagesWithResponse(ctx context.Context, registryName string, maintainerLoginOrUUID string, params *GetRegistryMaintainerPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryMaintainerPackagesResponse, error) // GetRegistryNamespacesWithResponse request GetRegistryNamespacesWithResponse(ctx context.Context, registryName string, params *GetRegistryNamespacesParams, reqEditors ...RequestEditorFn) (*GetRegistryNamespacesResponse, error) // GetRegistryNamespaceWithResponse request GetRegistryNamespaceWithResponse(ctx context.Context, registryName string, namespaceName string, reqEditors ...RequestEditorFn) (*GetRegistryNamespaceResponse, error) // GetRegistryNamespacePackagesWithResponse request GetRegistryNamespacePackagesWithResponse(ctx context.Context, registryName string, namespaceName string, params *GetRegistryNamespacePackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryNamespacePackagesResponse, error) // GetRegistryPackageNamesWithResponse request GetRegistryPackageNamesWithResponse(ctx context.Context, registryName string, params *GetRegistryPackageNamesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageNamesResponse, error) // GetRegistryPackagesWithResponse request GetRegistryPackagesWithResponse(ctx context.Context, registryName string, params *GetRegistryPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackagesResponse, error) // GetRegistryPackageWithResponse request GetRegistryPackageWithResponse(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*GetRegistryPackageResponse, error) // GetRegistryPackageDependentPackageKindsWithResponse request GetRegistryPackageDependentPackageKindsWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackageKindsParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageDependentPackageKindsResponse, error) // GetRegistryPackageDependentPackagesWithResponse request GetRegistryPackageDependentPackagesWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageDependentPackagesResponse, error) // GetRegistryPackageRelatedPackagesWithResponse request GetRegistryPackageRelatedPackagesWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageRelatedPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageRelatedPackagesResponse, error) // GetRegistryPackageVersionNumbersWithResponse request GetRegistryPackageVersionNumbersWithResponse(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*GetRegistryPackageVersionNumbersResponse, error) // GetRegistryPackageVersionsWithResponse request GetRegistryPackageVersionsWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageVersionsParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageVersionsResponse, error) // GetRegistryPackageVersionWithResponse request GetRegistryPackageVersionWithResponse(ctx context.Context, registryName string, packageName string, versionNumber string, reqEditors ...RequestEditorFn) (*GetRegistryPackageVersionResponse, error) // GetRegistryRecentVersionsWithResponse request GetRegistryRecentVersionsWithResponse(ctx context.Context, registryName string, params *GetRegistryRecentVersionsParams, reqEditors ...RequestEditorFn) (*GetRegistryRecentVersionsResponse, error) } type GetDependenciesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Dependency } // Status returns HTTPResponse.Status func (r GetDependenciesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetDependenciesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetKeywordsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Keyword } // Status returns HTTPResponse.Status func (r GetKeywordsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetKeywordsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetKeywordResponse struct { Body []byte HTTPResponse *http.Response JSON200 *KeywordWithPackages } // Status returns HTTPResponse.Status func (r GetKeywordResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetKeywordResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type LookupPackageResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]PackageWithRegistry } // Status returns HTTPResponse.Status func (r LookupPackageResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r LookupPackageResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistriesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Registry } // Status returns HTTPResponse.Status func (r GetRegistriesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistriesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Registry } // Status returns HTTPResponse.Status func (r GetRegistryResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type LookupRegistryPackageResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]PackageWithRegistry } // Status returns HTTPResponse.Status func (r LookupRegistryPackageResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r LookupRegistryPackageResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryMaintainersResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Maintainer } // Status returns HTTPResponse.Status func (r GetRegistryMaintainersResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryMaintainersResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryMaintainerResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Maintainer } // Status returns HTTPResponse.Status func (r GetRegistryMaintainerResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryMaintainerResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryMaintainerPackagesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Package } // Status returns HTTPResponse.Status func (r GetRegistryMaintainerPackagesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryMaintainerPackagesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryNamespacesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Namespace } // Status returns HTTPResponse.Status func (r GetRegistryNamespacesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryNamespacesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryNamespaceResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Namespace } // Status returns HTTPResponse.Status func (r GetRegistryNamespaceResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryNamespaceResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryNamespacePackagesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Package } // Status returns HTTPResponse.Status func (r GetRegistryNamespacePackagesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryNamespacePackagesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageNamesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]string } // Status returns HTTPResponse.Status func (r GetRegistryPackageNamesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageNamesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackagesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Package } // Status returns HTTPResponse.Status func (r GetRegistryPackagesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackagesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Package } // Status returns HTTPResponse.Status func (r GetRegistryPackageResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageDependentPackageKindsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]string } // Status returns HTTPResponse.Status func (r GetRegistryPackageDependentPackageKindsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageDependentPackageKindsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageDependentPackagesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Package } // Status returns HTTPResponse.Status func (r GetRegistryPackageDependentPackagesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageDependentPackagesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageRelatedPackagesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Package } // Status returns HTTPResponse.Status func (r GetRegistryPackageRelatedPackagesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageRelatedPackagesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageVersionNumbersResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]string } // Status returns HTTPResponse.Status func (r GetRegistryPackageVersionNumbersResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageVersionNumbersResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageVersionsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Version } // Status returns HTTPResponse.Status func (r GetRegistryPackageVersionsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageVersionsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryPackageVersionResponse struct { Body []byte HTTPResponse *http.Response JSON200 *VersionWithDependencies } // Status returns HTTPResponse.Status func (r GetRegistryPackageVersionResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryPackageVersionResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetRegistryRecentVersionsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]VersionWithPackage } // Status returns HTTPResponse.Status func (r GetRegistryRecentVersionsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistryRecentVersionsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } // GetDependenciesWithResponse request returning *GetDependenciesResponse func (c *ClientWithResponses) GetDependenciesWithResponse(ctx context.Context, params *GetDependenciesParams, reqEditors ...RequestEditorFn) (*GetDependenciesResponse, error) { rsp, err := c.GetDependencies(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseGetDependenciesResponse(rsp) } // GetKeywordsWithResponse request returning *GetKeywordsResponse func (c *ClientWithResponses) GetKeywordsWithResponse(ctx context.Context, params *GetKeywordsParams, reqEditors ...RequestEditorFn) (*GetKeywordsResponse, error) { rsp, err := c.GetKeywords(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseGetKeywordsResponse(rsp) } // GetKeywordWithResponse request returning *GetKeywordResponse func (c *ClientWithResponses) GetKeywordWithResponse(ctx context.Context, keywordName string, params *GetKeywordParams, reqEditors ...RequestEditorFn) (*GetKeywordResponse, error) { rsp, err := c.GetKeyword(ctx, keywordName, params, reqEditors...) if err != nil { return nil, err } return ParseGetKeywordResponse(rsp) } // LookupPackageWithResponse request returning *LookupPackageResponse func (c *ClientWithResponses) LookupPackageWithResponse(ctx context.Context, params *LookupPackageParams, reqEditors ...RequestEditorFn) (*LookupPackageResponse, error) { rsp, err := c.LookupPackage(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseLookupPackageResponse(rsp) } // GetRegistriesWithResponse request returning *GetRegistriesResponse func (c *ClientWithResponses) GetRegistriesWithResponse(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*GetRegistriesResponse, error) { rsp, err := c.GetRegistries(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistriesResponse(rsp) } // GetRegistryWithResponse request returning *GetRegistryResponse func (c *ClientWithResponses) GetRegistryWithResponse(ctx context.Context, registryName string, params *GetRegistryParams, reqEditors ...RequestEditorFn) (*GetRegistryResponse, error) { rsp, err := c.GetRegistry(ctx, registryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryResponse(rsp) } // LookupRegistryPackageWithResponse request returning *LookupRegistryPackageResponse func (c *ClientWithResponses) LookupRegistryPackageWithResponse(ctx context.Context, registryName string, params *LookupRegistryPackageParams, reqEditors ...RequestEditorFn) (*LookupRegistryPackageResponse, error) { rsp, err := c.LookupRegistryPackage(ctx, registryName, params, reqEditors...) if err != nil { return nil, err } return ParseLookupRegistryPackageResponse(rsp) } // GetRegistryMaintainersWithResponse request returning *GetRegistryMaintainersResponse func (c *ClientWithResponses) GetRegistryMaintainersWithResponse(ctx context.Context, registryName string, params *GetRegistryMaintainersParams, reqEditors ...RequestEditorFn) (*GetRegistryMaintainersResponse, error) { rsp, err := c.GetRegistryMaintainers(ctx, registryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryMaintainersResponse(rsp) } // GetRegistryMaintainerWithResponse request returning *GetRegistryMaintainerResponse func (c *ClientWithResponses) GetRegistryMaintainerWithResponse(ctx context.Context, registryName string, maintainerLoginOrUUID string, reqEditors ...RequestEditorFn) (*GetRegistryMaintainerResponse, error) { rsp, err := c.GetRegistryMaintainer(ctx, registryName, maintainerLoginOrUUID, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryMaintainerResponse(rsp) } // GetRegistryMaintainerPackagesWithResponse request returning *GetRegistryMaintainerPackagesResponse func (c *ClientWithResponses) GetRegistryMaintainerPackagesWithResponse(ctx context.Context, registryName string, maintainerLoginOrUUID string, params *GetRegistryMaintainerPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryMaintainerPackagesResponse, error) { rsp, err := c.GetRegistryMaintainerPackages(ctx, registryName, maintainerLoginOrUUID, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryMaintainerPackagesResponse(rsp) } // GetRegistryNamespacesWithResponse request returning *GetRegistryNamespacesResponse func (c *ClientWithResponses) GetRegistryNamespacesWithResponse(ctx context.Context, registryName string, params *GetRegistryNamespacesParams, reqEditors ...RequestEditorFn) (*GetRegistryNamespacesResponse, error) { rsp, err := c.GetRegistryNamespaces(ctx, registryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryNamespacesResponse(rsp) } // GetRegistryNamespaceWithResponse request returning *GetRegistryNamespaceResponse func (c *ClientWithResponses) GetRegistryNamespaceWithResponse(ctx context.Context, registryName string, namespaceName string, reqEditors ...RequestEditorFn) (*GetRegistryNamespaceResponse, error) { rsp, err := c.GetRegistryNamespace(ctx, registryName, namespaceName, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryNamespaceResponse(rsp) } // GetRegistryNamespacePackagesWithResponse request returning *GetRegistryNamespacePackagesResponse func (c *ClientWithResponses) GetRegistryNamespacePackagesWithResponse(ctx context.Context, registryName string, namespaceName string, params *GetRegistryNamespacePackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryNamespacePackagesResponse, error) { rsp, err := c.GetRegistryNamespacePackages(ctx, registryName, namespaceName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryNamespacePackagesResponse(rsp) } // GetRegistryPackageNamesWithResponse request returning *GetRegistryPackageNamesResponse func (c *ClientWithResponses) GetRegistryPackageNamesWithResponse(ctx context.Context, registryName string, params *GetRegistryPackageNamesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageNamesResponse, error) { rsp, err := c.GetRegistryPackageNames(ctx, registryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageNamesResponse(rsp) } // GetRegistryPackagesWithResponse request returning *GetRegistryPackagesResponse func (c *ClientWithResponses) GetRegistryPackagesWithResponse(ctx context.Context, registryName string, params *GetRegistryPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackagesResponse, error) { rsp, err := c.GetRegistryPackages(ctx, registryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackagesResponse(rsp) } // GetRegistryPackageWithResponse request returning *GetRegistryPackageResponse func (c *ClientWithResponses) GetRegistryPackageWithResponse(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*GetRegistryPackageResponse, error) { rsp, err := c.GetRegistryPackage(ctx, registryName, packageName, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageResponse(rsp) } // GetRegistryPackageDependentPackageKindsWithResponse request returning *GetRegistryPackageDependentPackageKindsResponse func (c *ClientWithResponses) GetRegistryPackageDependentPackageKindsWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackageKindsParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageDependentPackageKindsResponse, error) { rsp, err := c.GetRegistryPackageDependentPackageKinds(ctx, registryName, packageName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageDependentPackageKindsResponse(rsp) } // GetRegistryPackageDependentPackagesWithResponse request returning *GetRegistryPackageDependentPackagesResponse func (c *ClientWithResponses) GetRegistryPackageDependentPackagesWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageDependentPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageDependentPackagesResponse, error) { rsp, err := c.GetRegistryPackageDependentPackages(ctx, registryName, packageName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageDependentPackagesResponse(rsp) } // GetRegistryPackageRelatedPackagesWithResponse request returning *GetRegistryPackageRelatedPackagesResponse func (c *ClientWithResponses) GetRegistryPackageRelatedPackagesWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageRelatedPackagesParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageRelatedPackagesResponse, error) { rsp, err := c.GetRegistryPackageRelatedPackages(ctx, registryName, packageName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageRelatedPackagesResponse(rsp) } // GetRegistryPackageVersionNumbersWithResponse request returning *GetRegistryPackageVersionNumbersResponse func (c *ClientWithResponses) GetRegistryPackageVersionNumbersWithResponse(ctx context.Context, registryName string, packageName string, reqEditors ...RequestEditorFn) (*GetRegistryPackageVersionNumbersResponse, error) { rsp, err := c.GetRegistryPackageVersionNumbers(ctx, registryName, packageName, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageVersionNumbersResponse(rsp) } // GetRegistryPackageVersionsWithResponse request returning *GetRegistryPackageVersionsResponse func (c *ClientWithResponses) GetRegistryPackageVersionsWithResponse(ctx context.Context, registryName string, packageName string, params *GetRegistryPackageVersionsParams, reqEditors ...RequestEditorFn) (*GetRegistryPackageVersionsResponse, error) { rsp, err := c.GetRegistryPackageVersions(ctx, registryName, packageName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageVersionsResponse(rsp) } // GetRegistryPackageVersionWithResponse request returning *GetRegistryPackageVersionResponse func (c *ClientWithResponses) GetRegistryPackageVersionWithResponse(ctx context.Context, registryName string, packageName string, versionNumber string, reqEditors ...RequestEditorFn) (*GetRegistryPackageVersionResponse, error) { rsp, err := c.GetRegistryPackageVersion(ctx, registryName, packageName, versionNumber, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryPackageVersionResponse(rsp) } // GetRegistryRecentVersionsWithResponse request returning *GetRegistryRecentVersionsResponse func (c *ClientWithResponses) GetRegistryRecentVersionsWithResponse(ctx context.Context, registryName string, params *GetRegistryRecentVersionsParams, reqEditors ...RequestEditorFn) (*GetRegistryRecentVersionsResponse, error) { rsp, err := c.GetRegistryRecentVersions(ctx, registryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistryRecentVersionsResponse(rsp) } // ParseGetDependenciesResponse parses an HTTP response from a GetDependenciesWithResponse call func ParseGetDependenciesResponse(rsp *http.Response) (*GetDependenciesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetDependenciesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Dependency if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetKeywordsResponse parses an HTTP response from a GetKeywordsWithResponse call func ParseGetKeywordsResponse(rsp *http.Response) (*GetKeywordsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetKeywordsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Keyword if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetKeywordResponse parses an HTTP response from a GetKeywordWithResponse call func ParseGetKeywordResponse(rsp *http.Response) (*GetKeywordResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetKeywordResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest KeywordWithPackages if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseLookupPackageResponse parses an HTTP response from a LookupPackageWithResponse call func ParseLookupPackageResponse(rsp *http.Response) (*LookupPackageResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &LookupPackageResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []PackageWithRegistry if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistriesResponse parses an HTTP response from a GetRegistriesWithResponse call func ParseGetRegistriesResponse(rsp *http.Response) (*GetRegistriesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistriesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Registry if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryResponse parses an HTTP response from a GetRegistryWithResponse call func ParseGetRegistryResponse(rsp *http.Response) (*GetRegistryResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Registry if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseLookupRegistryPackageResponse parses an HTTP response from a LookupRegistryPackageWithResponse call func ParseLookupRegistryPackageResponse(rsp *http.Response) (*LookupRegistryPackageResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &LookupRegistryPackageResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []PackageWithRegistry if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryMaintainersResponse parses an HTTP response from a GetRegistryMaintainersWithResponse call func ParseGetRegistryMaintainersResponse(rsp *http.Response) (*GetRegistryMaintainersResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryMaintainersResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Maintainer if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryMaintainerResponse parses an HTTP response from a GetRegistryMaintainerWithResponse call func ParseGetRegistryMaintainerResponse(rsp *http.Response) (*GetRegistryMaintainerResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryMaintainerResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Maintainer if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryMaintainerPackagesResponse parses an HTTP response from a GetRegistryMaintainerPackagesWithResponse call func ParseGetRegistryMaintainerPackagesResponse(rsp *http.Response) (*GetRegistryMaintainerPackagesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryMaintainerPackagesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Package if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryNamespacesResponse parses an HTTP response from a GetRegistryNamespacesWithResponse call func ParseGetRegistryNamespacesResponse(rsp *http.Response) (*GetRegistryNamespacesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryNamespacesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Namespace if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryNamespaceResponse parses an HTTP response from a GetRegistryNamespaceWithResponse call func ParseGetRegistryNamespaceResponse(rsp *http.Response) (*GetRegistryNamespaceResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryNamespaceResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Namespace if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryNamespacePackagesResponse parses an HTTP response from a GetRegistryNamespacePackagesWithResponse call func ParseGetRegistryNamespacePackagesResponse(rsp *http.Response) (*GetRegistryNamespacePackagesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryNamespacePackagesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Package if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageNamesResponse parses an HTTP response from a GetRegistryPackageNamesWithResponse call func ParseGetRegistryPackageNamesResponse(rsp *http.Response) (*GetRegistryPackageNamesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageNamesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []string if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackagesResponse parses an HTTP response from a GetRegistryPackagesWithResponse call func ParseGetRegistryPackagesResponse(rsp *http.Response) (*GetRegistryPackagesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackagesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Package if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageResponse parses an HTTP response from a GetRegistryPackageWithResponse call func ParseGetRegistryPackageResponse(rsp *http.Response) (*GetRegistryPackageResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Package if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageDependentPackageKindsResponse parses an HTTP response from a GetRegistryPackageDependentPackageKindsWithResponse call func ParseGetRegistryPackageDependentPackageKindsResponse(rsp *http.Response) (*GetRegistryPackageDependentPackageKindsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageDependentPackageKindsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []string if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageDependentPackagesResponse parses an HTTP response from a GetRegistryPackageDependentPackagesWithResponse call func ParseGetRegistryPackageDependentPackagesResponse(rsp *http.Response) (*GetRegistryPackageDependentPackagesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageDependentPackagesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Package if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageRelatedPackagesResponse parses an HTTP response from a GetRegistryPackageRelatedPackagesWithResponse call func ParseGetRegistryPackageRelatedPackagesResponse(rsp *http.Response) (*GetRegistryPackageRelatedPackagesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageRelatedPackagesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Package if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageVersionNumbersResponse parses an HTTP response from a GetRegistryPackageVersionNumbersWithResponse call func ParseGetRegistryPackageVersionNumbersResponse(rsp *http.Response) (*GetRegistryPackageVersionNumbersResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageVersionNumbersResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []string if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageVersionsResponse parses an HTTP response from a GetRegistryPackageVersionsWithResponse call func ParseGetRegistryPackageVersionsResponse(rsp *http.Response) (*GetRegistryPackageVersionsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageVersionsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Version if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryPackageVersionResponse parses an HTTP response from a GetRegistryPackageVersionWithResponse call func ParseGetRegistryPackageVersionResponse(rsp *http.Response) (*GetRegistryPackageVersionResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryPackageVersionResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest VersionWithDependencies if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetRegistryRecentVersionsResponse parses an HTTP response from a GetRegistryRecentVersionsWithResponse call func ParseGetRegistryRecentVersionsResponse(rsp *http.Response) (*GetRegistryRecentVersionsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistryRecentVersionsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []VersionWithPackage if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } ================================================ FILE: ecosystems/repos/repos.go ================================================ // Package repos provides primitives to interact with the openapi HTTP API. // // Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT. package repos import ( "context" "encoding/json" "fmt" "io" "net/http" "net/url" "strings" "time" "github.com/oapi-codegen/runtime" ) // Dependency defines model for Dependency. type Dependency struct { Direct *bool `json:"direct,omitempty"` Ecosystem *string `json:"ecosystem,omitempty"` Id *int `json:"id,omitempty"` Kind *string `json:"kind,omitempty"` Optional *bool `json:"optional,omitempty"` PackageName *string `json:"package_name,omitempty"` Requirements *string `json:"requirements,omitempty"` } // DependencyWithRepository defines model for DependencyWithRepository. type DependencyWithRepository struct { Direct *bool `json:"direct,omitempty"` Ecosystem *string `json:"ecosystem,omitempty"` Id *int `json:"id,omitempty"` Kind *string `json:"kind,omitempty"` Manifest *Manifest `json:"manifest,omitempty"` Optional *bool `json:"optional,omitempty"` PackageName *string `json:"package_name,omitempty"` Repository *Repository `json:"repository,omitempty"` Requirements *string `json:"requirements,omitempty"` } // Ecosystem defines model for Ecosystem. type Ecosystem struct { EcosystemUrl *string `json:"ecosystem_url,omitempty"` Name *string `json:"name,omitempty"` PackagesCount *int `json:"packages_count,omitempty"` } // Host defines model for Host. type Host struct { CreatedAt *time.Time `json:"created_at,omitempty"` HostUrl *string `json:"host_url,omitempty"` IconUrl *string `json:"icon_url,omitempty"` Kind *string `json:"kind,omitempty"` Name *string `json:"name,omitempty"` OwnersCount *int `json:"owners_count,omitempty"` OwnersUrl *string `json:"owners_url,omitempty"` RepositoriesCount *int `json:"repositories_count,omitempty"` RepositorisUrl *string `json:"repositoris_url,omitempty"` RepositoryNamesUrl *string `json:"repository_names_url,omitempty"` UpdatedAt *time.Time `json:"updated_at,omitempty"` Url *string `json:"url,omitempty"` Version *string `json:"version,omitempty"` } // Manifest defines model for Manifest. type Manifest struct { CreatedAt *time.Time `json:"created_at,omitempty"` Dependencies *[]Dependency `json:"dependencies,omitempty"` Ecosystem *string `json:"ecosystem,omitempty"` Filepath *string `json:"filepath,omitempty"` Kind *string `json:"kind,omitempty"` RepositoryLink *string `json:"repository_link,omitempty"` Sha *string `json:"sha,omitempty"` UpdatedAt *time.Time `json:"updated_at,omitempty"` } // Owner defines model for Owner. type Owner struct { Company *string `json:"company,omitempty"` CreatedAt *time.Time `json:"created_at,omitempty"` Description *string `json:"description,omitempty"` Email *string `json:"email,omitempty"` Followers *int `json:"followers,omitempty"` Following *int `json:"following,omitempty"` FundingLinks *[]string `json:"funding_links,omitempty"` HtmlUrl *string `json:"html_url,omitempty"` IconUrl *string `json:"icon_url,omitempty"` Kind *string `json:"kind,omitempty"` LastSyncedAt *time.Time `json:"last_synced_at,omitempty"` Location *string `json:"location,omitempty"` Login *string `json:"login,omitempty"` Metadata *map[string]interface{} `json:"metadata,omitempty"` Name *string `json:"name,omitempty"` OwnerUrl *string `json:"owner_url,omitempty"` RepositoriesCount *int `json:"repositories_count,omitempty"` RepositoriesUrl *string `json:"repositories_url,omitempty"` TotalStars *int `json:"total_stars,omitempty"` Twitter *string `json:"twitter,omitempty"` UpdatedAt *time.Time `json:"updated_at,omitempty"` Uuid *string `json:"uuid,omitempty"` Website *string `json:"website,omitempty"` } // PackageUsage defines model for PackageUsage. type PackageUsage struct { DependenciesUrl *string `json:"dependencies_url,omitempty"` DependentsCount *int `json:"dependents_count,omitempty"` Ecosystem *string `json:"ecosystem,omitempty"` Name *string `json:"name,omitempty"` PackageUsageUrl *string `json:"package_usage_url,omitempty"` } // Release defines model for Release. type Release struct { Assets *[]map[string]interface{} `json:"assets,omitempty"` Author *string `json:"author,omitempty"` Body *string `json:"body,omitempty"` CreatedAt *time.Time `json:"created_at,omitempty"` Draft *bool `json:"draft,omitempty"` HtmlUrl *string `json:"html_url,omitempty"` LastSyncedAt *time.Time `json:"last_synced_at,omitempty"` Name *string `json:"name,omitempty"` Prerelease *bool `json:"prerelease,omitempty"` PublishedAt *time.Time `json:"published_at,omitempty"` TagName *string `json:"tag_name,omitempty"` TagUrl *string `json:"tag_url,omitempty"` TargetCommitish *string `json:"target_commitish,omitempty"` Uuid *string `json:"uuid,omitempty"` } // Repository defines model for Repository. type Repository struct { Archived *bool `json:"archived,omitempty"` CommitStats *map[string]interface{} `json:"commit_stats,omitempty"` CreatedAt *time.Time `json:"created_at,omitempty"` DefaultBranch *string `json:"default_branch,omitempty"` DependenciesParsedAt *time.Time `json:"dependencies_parsed_at,omitempty"` DependencyJobId *string `json:"dependency_job_id,omitempty"` Description *string `json:"description,omitempty"` DownloadUrl *string `json:"download_url,omitempty"` Etag *string `json:"etag,omitempty"` Fork *bool `json:"fork,omitempty"` ForksCount *int `json:"forks_count,omitempty"` FullName *string `json:"full_name,omitempty"` HasIssues *bool `json:"has_issues,omitempty"` HasPages *bool `json:"has_pages,omitempty"` HasWiki *bool `json:"has_wiki,omitempty"` Homepage *string `json:"homepage,omitempty"` Host *Host `json:"host,omitempty"` HtmlUrl *string `json:"html_url,omitempty"` IconUrl *string `json:"icon_url,omitempty"` Id *int `json:"id,omitempty"` Language *string `json:"language,omitempty"` LastSyncedAt *time.Time `json:"last_synced_at,omitempty"` LatestCommitSha *string `json:"latest_commit_sha,omitempty"` LatestTagName *string `json:"latest_tag_name,omitempty"` LatestTagPublishedAt *time.Time `json:"latest_tag_published_at,omitempty"` License *string `json:"license,omitempty"` ManifestsUrl *string `json:"manifests_url,omitempty"` Metadata *map[string]interface{} `json:"metadata,omitempty"` MirrorUrl *string `json:"mirror_url,omitempty"` OpenIssuesCount *int `json:"open_issues_count,omitempty"` Owner *string `json:"owner,omitempty"` OwnerUrl *string `json:"owner_url,omitempty"` PreviousNames *[]string `json:"previous_names,omitempty"` PullRequestsEnabled *bool `json:"pull_requests_enabled,omitempty"` PushedAt *time.Time `json:"pushed_at,omitempty"` ReleasesUrl *string `json:"releases_url,omitempty"` RepositoryUrl *string `json:"repository_url,omitempty"` Scm *string `json:"scm,omitempty"` Size *int `json:"size,omitempty"` SourceName *string `json:"source_name,omitempty"` StargazersCount *int `json:"stargazers_count,omitempty"` Status *string `json:"status,omitempty"` SubscribersCount *int `json:"subscribers_count,omitempty"` TagsCount *int `json:"tags_count,omitempty"` TagsUrl *string `json:"tags_url,omitempty"` Template *bool `json:"template,omitempty"` TemplateFullName *string `json:"template_full_name,omitempty"` Topics *[]string `json:"topics,omitempty"` UpdatedAt *time.Time `json:"updated_at,omitempty"` Uuid *string `json:"uuid,omitempty"` } // Tag defines model for Tag. type Tag struct { DependenciesParsedAt *time.Time `json:"dependencies_parsed_at,omitempty"` DependencyJobId *string `json:"dependency_job_id,omitempty"` DownloadUrl *string `json:"download_url,omitempty"` HtmlUrl *string `json:"html_url,omitempty"` Kind *string `json:"kind,omitempty"` ManifestsUrl *string `json:"manifests_url,omitempty"` Name *string `json:"name,omitempty"` PublishedAt *time.Time `json:"published_at,omitempty"` Sha *string `json:"sha,omitempty"` TagUrl *string `json:"tag_url,omitempty"` } // Topic defines model for Topic. type Topic struct { Name *string `json:"name,omitempty"` RepositoriesCount *int `json:"repositories_count,omitempty"` TopicUrl *string `json:"topic_url,omitempty"` } // TopicWithRepositories defines model for TopicWithRepositories. type TopicWithRepositories struct { Name *string `json:"name,omitempty"` RelatedTopics *[]Topic `json:"related_topics,omitempty"` Repositories *[]Repository `json:"repositories,omitempty"` RepositoriesCount *int `json:"repositories_count,omitempty"` TopicUrl *string `json:"topic_url,omitempty"` } // GetRegistriesParams defines parameters for GetRegistries. type GetRegistriesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // LookupHostOwnerParams defines parameters for LookupHostOwner. type LookupHostOwnerParams struct { // Name name of owner Name *string `form:"name,omitempty" json:"name,omitempty"` // Email email of owner Email *string `form:"email,omitempty" json:"email,omitempty"` } // GetHostParams defines parameters for GetHost. type GetHostParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // GetHostOwnersParams defines parameters for GetHostOwners. type GetHostOwnersParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetHostOwnerRepositoriesParams defines parameters for GetHostOwnerRepositories. type GetHostOwnerRepositoriesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Fork filter by fork Fork *bool `form:"fork,omitempty" json:"fork,omitempty"` // Archived filter by archived Archived *bool `form:"archived,omitempty" json:"archived,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetHostRepositoriesParams defines parameters for GetHostRepositories. type GetHostRepositoriesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Fork filter by fork Fork *bool `form:"fork,omitempty" json:"fork,omitempty"` // Archived filter by archived Archived *bool `form:"archived,omitempty" json:"archived,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetHostRepositoryManifestsParams defines parameters for GetHostRepositoryManifests. type GetHostRepositoryManifestsParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // GetHostRepositoryReleasesParams defines parameters for GetHostRepositoryReleases. type GetHostRepositoryReleasesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetHostRepositoryTagsParams defines parameters for GetHostRepositoryTags. type GetHostRepositoryTagsParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // GetHostRepositoryNamesParams defines parameters for GetHostRepositoryNames. type GetHostRepositoryNamesParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Fork filter by fork Fork *bool `form:"fork,omitempty" json:"fork,omitempty"` // Archived filter by archived Archived *bool `form:"archived,omitempty" json:"archived,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // RepositoriesLookupParams defines parameters for RepositoriesLookup. type RepositoriesLookupParams struct { // Url The URL of the repository to lookup Url *string `form:"url,omitempty" json:"url,omitempty"` // Purl package URL Purl *string `form:"purl,omitempty" json:"purl,omitempty"` } // TopicsParams defines parameters for Topics. type TopicsParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` } // TopicParams defines parameters for Topic. type TopicParams struct { // Page pagination page number Page *int `form:"page,omitempty" json:"page,omitempty"` // PerPage Number of records to return PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"` // CreatedAfter filter by created_at after given time CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"` // UpdatedAfter filter by updated_at after given time UpdatedAfter *time.Time `form:"updated_after,omitempty" json:"updated_after,omitempty"` // Fork filter by fork Fork *bool `form:"fork,omitempty" json:"fork,omitempty"` // Archived filter by archived Archived *bool `form:"archived,omitempty" json:"archived,omitempty"` // Sort field to order results by Sort *string `form:"sort,omitempty" json:"sort,omitempty"` // Order direction to order results by Order *string `form:"order,omitempty" json:"order,omitempty"` } // RequestEditorFn is the function signature for the RequestEditor callback function type RequestEditorFn func(ctx context.Context, req *http.Request) error // Doer performs HTTP requests. // // The standard http.Client implements this interface. type HttpRequestDoer interface { Do(req *http.Request) (*http.Response, error) } // Client which conforms to the OpenAPI3 specification for this service. type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn } // ClientOption allows setting custom parameters during construction type ClientOption func(*Client) error // Creates a new Client, with reasonable defaults func NewClient(server string, opts ...ClientOption) (*Client, error) { // create a client with sane default values client := Client{ Server: server, } // mutate client and add all optional params for _, o := range opts { if err := o(&client); err != nil { return nil, err } } // ensure the server URL always has a trailing slash if !strings.HasSuffix(client.Server, "/") { client.Server += "/" } // create httpClient, if not already present if client.Client == nil { client.Client = &http.Client{} } return &client, nil } // WithHTTPClient allows overriding the default Doer, which is // automatically created using http.Client. This is useful for tests. func WithHTTPClient(doer HttpRequestDoer) ClientOption { return func(c *Client) error { c.Client = doer return nil } } // WithRequestEditorFn allows setting up a callback function, which will be // called right before sending the request. This can be used to mutate the request. func WithRequestEditorFn(fn RequestEditorFn) ClientOption { return func(c *Client) error { c.RequestEditors = append(c.RequestEditors, fn) return nil } } // The interface specification for the client above. type ClientInterface interface { // GetRegistries request GetRegistries(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // LookupHostOwner request LookupHostOwner(ctx context.Context, hostName string, params *LookupHostOwnerParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHost request GetHost(ctx context.Context, hostName string, params *GetHostParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostOwners request GetHostOwners(ctx context.Context, hostName string, params *GetHostOwnersParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostOwner request GetHostOwner(ctx context.Context, hostName string, ownerLogin string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostOwnerRepositories request GetHostOwnerRepositories(ctx context.Context, hostName string, ownerLogin string, params *GetHostOwnerRepositoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositories request GetHostRepositories(ctx context.Context, hostName string, params *GetHostRepositoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepository request GetHostRepository(ctx context.Context, hostName string, repositoryName string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositoryManifests request GetHostRepositoryManifests(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryManifestsParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositoryReleases request GetHostRepositoryReleases(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryReleasesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositoryRelease request GetHostRepositoryRelease(ctx context.Context, hostName string, repositoryName string, release string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositoryTags request GetHostRepositoryTags(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryTagsParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositoryTag request GetHostRepositoryTag(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositoryTagManifests request GetHostRepositoryTagManifests(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*http.Response, error) // GetHostRepositoryNames request GetHostRepositoryNames(ctx context.Context, hostName string, params *GetHostRepositoryNamesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // RepositoriesLookup request RepositoriesLookup(ctx context.Context, params *RepositoriesLookupParams, reqEditors ...RequestEditorFn) (*http.Response, error) // Topics request Topics(ctx context.Context, params *TopicsParams, reqEditors ...RequestEditorFn) (*http.Response, error) // Topic request Topic(ctx context.Context, topic string, params *TopicParams, reqEditors ...RequestEditorFn) (*http.Response, error) // Usage request Usage(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) // UsageEcosystem request UsageEcosystem(ctx context.Context, ecosystem string, reqEditors ...RequestEditorFn) (*http.Response, error) // UsagePackage request UsagePackage(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*http.Response, error) // UsagePackageDependencies request UsagePackageDependencies(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*http.Response, error) } func (c *Client) GetRegistries(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetRegistriesRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) LookupHostOwner(ctx context.Context, hostName string, params *LookupHostOwnerParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewLookupHostOwnerRequest(c.Server, hostName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHost(ctx context.Context, hostName string, params *GetHostParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRequest(c.Server, hostName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostOwners(ctx context.Context, hostName string, params *GetHostOwnersParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostOwnersRequest(c.Server, hostName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostOwner(ctx context.Context, hostName string, ownerLogin string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostOwnerRequest(c.Server, hostName, ownerLogin) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostOwnerRepositories(ctx context.Context, hostName string, ownerLogin string, params *GetHostOwnerRepositoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostOwnerRepositoriesRequest(c.Server, hostName, ownerLogin, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositories(ctx context.Context, hostName string, params *GetHostRepositoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoriesRequest(c.Server, hostName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepository(ctx context.Context, hostName string, repositoryName string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryRequest(c.Server, hostName, repositoryName) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositoryManifests(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryManifestsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryManifestsRequest(c.Server, hostName, repositoryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositoryReleases(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryReleasesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryReleasesRequest(c.Server, hostName, repositoryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositoryRelease(ctx context.Context, hostName string, repositoryName string, release string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryReleaseRequest(c.Server, hostName, repositoryName, release) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositoryTags(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryTagsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryTagsRequest(c.Server, hostName, repositoryName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositoryTag(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryTagRequest(c.Server, hostName, repositoryName, tag) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositoryTagManifests(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryTagManifestsRequest(c.Server, hostName, repositoryName, tag) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetHostRepositoryNames(ctx context.Context, hostName string, params *GetHostRepositoryNamesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetHostRepositoryNamesRequest(c.Server, hostName, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) RepositoriesLookup(ctx context.Context, params *RepositoriesLookupParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewRepositoriesLookupRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) Topics(ctx context.Context, params *TopicsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewTopicsRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) Topic(ctx context.Context, topic string, params *TopicParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewTopicRequest(c.Server, topic, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) Usage(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewUsageRequest(c.Server) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) UsageEcosystem(ctx context.Context, ecosystem string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewUsageEcosystemRequest(c.Server, ecosystem) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) UsagePackage(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewUsagePackageRequest(c.Server, ecosystem, pPackage) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) UsagePackageDependencies(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewUsagePackageDependenciesRequest(c.Server, ecosystem, pPackage) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } // NewGetRegistriesRequest generates requests for GetRegistries func NewGetRegistriesRequest(server string, params *GetRegistriesParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewLookupHostOwnerRequest generates requests for LookupHostOwner func NewLookupHostOwnerRequest(server string, hostName string, params *LookupHostOwnerParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "HostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/owners/lookup", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Name != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "name", runtime.ParamLocationQuery, *params.Name); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Email != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "email", runtime.ParamLocationQuery, *params.Email); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRequest generates requests for GetHost func NewGetHostRequest(server string, hostName string, params *GetHostParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostOwnersRequest generates requests for GetHostOwners func NewGetHostOwnersRequest(server string, hostName string, params *GetHostOwnersParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/owners", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostOwnerRequest generates requests for GetHostOwner func NewGetHostOwnerRequest(server string, hostName string, ownerLogin string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "ownerLogin", runtime.ParamLocationPath, ownerLogin) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/owners/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostOwnerRepositoriesRequest generates requests for GetHostOwnerRepositories func NewGetHostOwnerRepositoriesRequest(server string, hostName string, ownerLogin string, params *GetHostOwnerRepositoriesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "ownerLogin", runtime.ParamLocationPath, ownerLogin) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/owners/%s/repositories", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Fork != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "fork", runtime.ParamLocationQuery, *params.Fork); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Archived != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "archived", runtime.ParamLocationQuery, *params.Archived); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoriesRequest generates requests for GetHostRepositories func NewGetHostRepositoriesRequest(server string, hostName string, params *GetHostRepositoriesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Fork != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "fork", runtime.ParamLocationQuery, *params.Fork); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Archived != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "archived", runtime.ParamLocationQuery, *params.Archived); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryRequest generates requests for GetHostRepository func NewGetHostRepositoryRequest(server string, hostName string, repositoryName string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "repositoryName", runtime.ParamLocationPath, repositoryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryManifestsRequest generates requests for GetHostRepositoryManifests func NewGetHostRepositoryManifestsRequest(server string, hostName string, repositoryName string, params *GetHostRepositoryManifestsParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "repositoryName", runtime.ParamLocationPath, repositoryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories/%s/manifests", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryReleasesRequest generates requests for GetHostRepositoryReleases func NewGetHostRepositoryReleasesRequest(server string, hostName string, repositoryName string, params *GetHostRepositoryReleasesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "repositoryName", runtime.ParamLocationPath, repositoryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories/%s/releases", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryReleaseRequest generates requests for GetHostRepositoryRelease func NewGetHostRepositoryReleaseRequest(server string, hostName string, repositoryName string, release string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "repositoryName", runtime.ParamLocationPath, repositoryName) if err != nil { return nil, err } var pathParam2 string pathParam2, err = runtime.StyleParamWithLocation("simple", false, "release", runtime.ParamLocationPath, release) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories/%s/releases/%s", pathParam0, pathParam1, pathParam2) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryTagsRequest generates requests for GetHostRepositoryTags func NewGetHostRepositoryTagsRequest(server string, hostName string, repositoryName string, params *GetHostRepositoryTagsParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "repositoryName", runtime.ParamLocationPath, repositoryName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories/%s/tags", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryTagRequest generates requests for GetHostRepositoryTag func NewGetHostRepositoryTagRequest(server string, hostName string, repositoryName string, tag string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "repositoryName", runtime.ParamLocationPath, repositoryName) if err != nil { return nil, err } var pathParam2 string pathParam2, err = runtime.StyleParamWithLocation("simple", false, "tag", runtime.ParamLocationPath, tag) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories/%s/tags/%s", pathParam0, pathParam1, pathParam2) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryTagManifestsRequest generates requests for GetHostRepositoryTagManifests func NewGetHostRepositoryTagManifestsRequest(server string, hostName string, repositoryName string, tag string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "repositoryName", runtime.ParamLocationPath, repositoryName) if err != nil { return nil, err } var pathParam2 string pathParam2, err = runtime.StyleParamWithLocation("simple", false, "tag", runtime.ParamLocationPath, tag) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repositories/%s/tags/%s/manifests", pathParam0, pathParam1, pathParam2) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetHostRepositoryNamesRequest generates requests for GetHostRepositoryNames func NewGetHostRepositoryNamesRequest(server string, hostName string, params *GetHostRepositoryNamesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "hostName", runtime.ParamLocationPath, hostName) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/hosts/%s/repository_names", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Fork != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "fork", runtime.ParamLocationQuery, *params.Fork); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Archived != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "archived", runtime.ParamLocationQuery, *params.Archived); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewRepositoriesLookupRequest generates requests for RepositoriesLookup func NewRepositoriesLookupRequest(server string, params *RepositoriesLookupParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/repositories/lookup") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Url != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "url", runtime.ParamLocationQuery, *params.Url); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Purl != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "purl", runtime.ParamLocationQuery, *params.Purl); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewTopicsRequest generates requests for Topics func NewTopicsRequest(server string, params *TopicsParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/topics") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewTopicRequest generates requests for Topic func NewTopicRequest(server string, topic string, params *TopicParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "topic", runtime.ParamLocationPath, topic) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/topics/%s", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if params.Page != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "page", runtime.ParamLocationQuery, *params.Page); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.PerPage != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "per_page", runtime.ParamLocationQuery, *params.PerPage); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Fork != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "fork", runtime.ParamLocationQuery, *params.Fork); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Archived != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "archived", runtime.ParamLocationQuery, *params.Archived); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Sort != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "sort", runtime.ParamLocationQuery, *params.Sort); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Order != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "order", runtime.ParamLocationQuery, *params.Order); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewUsageRequest generates requests for Usage func NewUsageRequest(server string) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/usage") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewUsageEcosystemRequest generates requests for UsageEcosystem func NewUsageEcosystemRequest(server string, ecosystem string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "ecosystem", runtime.ParamLocationPath, ecosystem) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/usage/%s", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewUsagePackageRequest generates requests for UsagePackage func NewUsagePackageRequest(server string, ecosystem string, pPackage string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "ecosystem", runtime.ParamLocationPath, ecosystem) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "package", runtime.ParamLocationPath, pPackage) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/usage/%s/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewUsagePackageDependenciesRequest generates requests for UsagePackageDependencies func NewUsagePackageDependenciesRequest(server string, ecosystem string, pPackage string) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "ecosystem", runtime.ParamLocationPath, ecosystem) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "package", runtime.ParamLocationPath, pPackage) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/usage/%s/%s/dependencies", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } func (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error { for _, r := range c.RequestEditors { if err := r(ctx, req); err != nil { return err } } for _, r := range additionalEditors { if err := r(ctx, req); err != nil { return err } } return nil } // ClientWithResponses builds on ClientInterface to offer response payloads type ClientWithResponses struct { ClientInterface } // NewClientWithResponses creates a new ClientWithResponses, which wraps // Client with return type handling func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { client, err := NewClient(server, opts...) if err != nil { return nil, err } return &ClientWithResponses{client}, nil } // WithBaseURL overrides the baseURL. func WithBaseURL(baseURL string) ClientOption { return func(c *Client) error { newBaseURL, err := url.Parse(baseURL) if err != nil { return err } c.Server = newBaseURL.String() return nil } } // ClientWithResponsesInterface is the interface specification for the client with responses above. type ClientWithResponsesInterface interface { // GetRegistriesWithResponse request GetRegistriesWithResponse(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*GetRegistriesResponse, error) // LookupHostOwnerWithResponse request LookupHostOwnerWithResponse(ctx context.Context, hostName string, params *LookupHostOwnerParams, reqEditors ...RequestEditorFn) (*LookupHostOwnerResponse, error) // GetHostWithResponse request GetHostWithResponse(ctx context.Context, hostName string, params *GetHostParams, reqEditors ...RequestEditorFn) (*GetHostResponse, error) // GetHostOwnersWithResponse request GetHostOwnersWithResponse(ctx context.Context, hostName string, params *GetHostOwnersParams, reqEditors ...RequestEditorFn) (*GetHostOwnersResponse, error) // GetHostOwnerWithResponse request GetHostOwnerWithResponse(ctx context.Context, hostName string, ownerLogin string, reqEditors ...RequestEditorFn) (*GetHostOwnerResponse, error) // GetHostOwnerRepositoriesWithResponse request GetHostOwnerRepositoriesWithResponse(ctx context.Context, hostName string, ownerLogin string, params *GetHostOwnerRepositoriesParams, reqEditors ...RequestEditorFn) (*GetHostOwnerRepositoriesResponse, error) // GetHostRepositoriesWithResponse request GetHostRepositoriesWithResponse(ctx context.Context, hostName string, params *GetHostRepositoriesParams, reqEditors ...RequestEditorFn) (*GetHostRepositoriesResponse, error) // GetHostRepositoryWithResponse request GetHostRepositoryWithResponse(ctx context.Context, hostName string, repositoryName string, reqEditors ...RequestEditorFn) (*GetHostRepositoryResponse, error) // GetHostRepositoryManifestsWithResponse request GetHostRepositoryManifestsWithResponse(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryManifestsParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryManifestsResponse, error) // GetHostRepositoryReleasesWithResponse request GetHostRepositoryReleasesWithResponse(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryReleasesParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryReleasesResponse, error) // GetHostRepositoryReleaseWithResponse request GetHostRepositoryReleaseWithResponse(ctx context.Context, hostName string, repositoryName string, release string, reqEditors ...RequestEditorFn) (*GetHostRepositoryReleaseResponse, error) // GetHostRepositoryTagsWithResponse request GetHostRepositoryTagsWithResponse(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryTagsParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryTagsResponse, error) // GetHostRepositoryTagWithResponse request GetHostRepositoryTagWithResponse(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*GetHostRepositoryTagResponse, error) // GetHostRepositoryTagManifestsWithResponse request GetHostRepositoryTagManifestsWithResponse(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*GetHostRepositoryTagManifestsResponse, error) // GetHostRepositoryNamesWithResponse request GetHostRepositoryNamesWithResponse(ctx context.Context, hostName string, params *GetHostRepositoryNamesParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryNamesResponse, error) // RepositoriesLookupWithResponse request RepositoriesLookupWithResponse(ctx context.Context, params *RepositoriesLookupParams, reqEditors ...RequestEditorFn) (*RepositoriesLookupResponse, error) // TopicsWithResponse request TopicsWithResponse(ctx context.Context, params *TopicsParams, reqEditors ...RequestEditorFn) (*TopicsResponse, error) // TopicWithResponse request TopicWithResponse(ctx context.Context, topic string, params *TopicParams, reqEditors ...RequestEditorFn) (*TopicResponse, error) // UsageWithResponse request UsageWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UsageResponse, error) // UsageEcosystemWithResponse request UsageEcosystemWithResponse(ctx context.Context, ecosystem string, reqEditors ...RequestEditorFn) (*UsageEcosystemResponse, error) // UsagePackageWithResponse request UsagePackageWithResponse(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*UsagePackageResponse, error) // UsagePackageDependenciesWithResponse request UsagePackageDependenciesWithResponse(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*UsagePackageDependenciesResponse, error) } type GetRegistriesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Host } // Status returns HTTPResponse.Status func (r GetRegistriesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetRegistriesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type LookupHostOwnerResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Owner } // Status returns HTTPResponse.Status func (r LookupHostOwnerResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r LookupHostOwnerResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Host } // Status returns HTTPResponse.Status func (r GetHostResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostOwnersResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Owner } // Status returns HTTPResponse.Status func (r GetHostOwnersResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostOwnersResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostOwnerResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Owner } // Status returns HTTPResponse.Status func (r GetHostOwnerResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostOwnerResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostOwnerRepositoriesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Repository } // Status returns HTTPResponse.Status func (r GetHostOwnerRepositoriesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostOwnerRepositoriesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoriesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Repository } // Status returns HTTPResponse.Status func (r GetHostRepositoriesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoriesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Repository } // Status returns HTTPResponse.Status func (r GetHostRepositoryResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryManifestsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Manifest } // Status returns HTTPResponse.Status func (r GetHostRepositoryManifestsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryManifestsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryReleasesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Tag } // Status returns HTTPResponse.Status func (r GetHostRepositoryReleasesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryReleasesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryReleaseResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Release } // Status returns HTTPResponse.Status func (r GetHostRepositoryReleaseResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryReleaseResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryTagsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Tag } // Status returns HTTPResponse.Status func (r GetHostRepositoryTagsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryTagsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryTagResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Tag } // Status returns HTTPResponse.Status func (r GetHostRepositoryTagResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryTagResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryTagManifestsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Manifest } // Status returns HTTPResponse.Status func (r GetHostRepositoryTagManifestsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryTagManifestsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetHostRepositoryNamesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]string } // Status returns HTTPResponse.Status func (r GetHostRepositoryNamesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetHostRepositoryNamesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type RepositoriesLookupResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Repository } // Status returns HTTPResponse.Status func (r RepositoriesLookupResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r RepositoriesLookupResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type TopicsResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Topic } // Status returns HTTPResponse.Status func (r TopicsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r TopicsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type TopicResponse struct { Body []byte HTTPResponse *http.Response JSON200 *TopicWithRepositories } // Status returns HTTPResponse.Status func (r TopicResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r TopicResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type UsageResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]Ecosystem } // Status returns HTTPResponse.Status func (r UsageResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r UsageResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type UsageEcosystemResponse struct { Body []byte HTTPResponse *http.Response JSON200 *[]PackageUsage } // Status returns HTTPResponse.Status func (r UsageEcosystemResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r UsageEcosystemResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type UsagePackageResponse struct { Body []byte HTTPResponse *http.Response JSON200 *PackageUsage } // Status returns HTTPResponse.Status func (r UsagePackageResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r UsagePackageResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type UsagePackageDependenciesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *DependencyWithRepository } // Status returns HTTPResponse.Status func (r UsagePackageDependenciesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r UsagePackageDependenciesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } // GetRegistriesWithResponse request returning *GetRegistriesResponse func (c *ClientWithResponses) GetRegistriesWithResponse(ctx context.Context, params *GetRegistriesParams, reqEditors ...RequestEditorFn) (*GetRegistriesResponse, error) { rsp, err := c.GetRegistries(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseGetRegistriesResponse(rsp) } // LookupHostOwnerWithResponse request returning *LookupHostOwnerResponse func (c *ClientWithResponses) LookupHostOwnerWithResponse(ctx context.Context, hostName string, params *LookupHostOwnerParams, reqEditors ...RequestEditorFn) (*LookupHostOwnerResponse, error) { rsp, err := c.LookupHostOwner(ctx, hostName, params, reqEditors...) if err != nil { return nil, err } return ParseLookupHostOwnerResponse(rsp) } // GetHostWithResponse request returning *GetHostResponse func (c *ClientWithResponses) GetHostWithResponse(ctx context.Context, hostName string, params *GetHostParams, reqEditors ...RequestEditorFn) (*GetHostResponse, error) { rsp, err := c.GetHost(ctx, hostName, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostResponse(rsp) } // GetHostOwnersWithResponse request returning *GetHostOwnersResponse func (c *ClientWithResponses) GetHostOwnersWithResponse(ctx context.Context, hostName string, params *GetHostOwnersParams, reqEditors ...RequestEditorFn) (*GetHostOwnersResponse, error) { rsp, err := c.GetHostOwners(ctx, hostName, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostOwnersResponse(rsp) } // GetHostOwnerWithResponse request returning *GetHostOwnerResponse func (c *ClientWithResponses) GetHostOwnerWithResponse(ctx context.Context, hostName string, ownerLogin string, reqEditors ...RequestEditorFn) (*GetHostOwnerResponse, error) { rsp, err := c.GetHostOwner(ctx, hostName, ownerLogin, reqEditors...) if err != nil { return nil, err } return ParseGetHostOwnerResponse(rsp) } // GetHostOwnerRepositoriesWithResponse request returning *GetHostOwnerRepositoriesResponse func (c *ClientWithResponses) GetHostOwnerRepositoriesWithResponse(ctx context.Context, hostName string, ownerLogin string, params *GetHostOwnerRepositoriesParams, reqEditors ...RequestEditorFn) (*GetHostOwnerRepositoriesResponse, error) { rsp, err := c.GetHostOwnerRepositories(ctx, hostName, ownerLogin, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostOwnerRepositoriesResponse(rsp) } // GetHostRepositoriesWithResponse request returning *GetHostRepositoriesResponse func (c *ClientWithResponses) GetHostRepositoriesWithResponse(ctx context.Context, hostName string, params *GetHostRepositoriesParams, reqEditors ...RequestEditorFn) (*GetHostRepositoriesResponse, error) { rsp, err := c.GetHostRepositories(ctx, hostName, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoriesResponse(rsp) } // GetHostRepositoryWithResponse request returning *GetHostRepositoryResponse func (c *ClientWithResponses) GetHostRepositoryWithResponse(ctx context.Context, hostName string, repositoryName string, reqEditors ...RequestEditorFn) (*GetHostRepositoryResponse, error) { rsp, err := c.GetHostRepository(ctx, hostName, repositoryName, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryResponse(rsp) } // GetHostRepositoryManifestsWithResponse request returning *GetHostRepositoryManifestsResponse func (c *ClientWithResponses) GetHostRepositoryManifestsWithResponse(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryManifestsParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryManifestsResponse, error) { rsp, err := c.GetHostRepositoryManifests(ctx, hostName, repositoryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryManifestsResponse(rsp) } // GetHostRepositoryReleasesWithResponse request returning *GetHostRepositoryReleasesResponse func (c *ClientWithResponses) GetHostRepositoryReleasesWithResponse(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryReleasesParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryReleasesResponse, error) { rsp, err := c.GetHostRepositoryReleases(ctx, hostName, repositoryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryReleasesResponse(rsp) } // GetHostRepositoryReleaseWithResponse request returning *GetHostRepositoryReleaseResponse func (c *ClientWithResponses) GetHostRepositoryReleaseWithResponse(ctx context.Context, hostName string, repositoryName string, release string, reqEditors ...RequestEditorFn) (*GetHostRepositoryReleaseResponse, error) { rsp, err := c.GetHostRepositoryRelease(ctx, hostName, repositoryName, release, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryReleaseResponse(rsp) } // GetHostRepositoryTagsWithResponse request returning *GetHostRepositoryTagsResponse func (c *ClientWithResponses) GetHostRepositoryTagsWithResponse(ctx context.Context, hostName string, repositoryName string, params *GetHostRepositoryTagsParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryTagsResponse, error) { rsp, err := c.GetHostRepositoryTags(ctx, hostName, repositoryName, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryTagsResponse(rsp) } // GetHostRepositoryTagWithResponse request returning *GetHostRepositoryTagResponse func (c *ClientWithResponses) GetHostRepositoryTagWithResponse(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*GetHostRepositoryTagResponse, error) { rsp, err := c.GetHostRepositoryTag(ctx, hostName, repositoryName, tag, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryTagResponse(rsp) } // GetHostRepositoryTagManifestsWithResponse request returning *GetHostRepositoryTagManifestsResponse func (c *ClientWithResponses) GetHostRepositoryTagManifestsWithResponse(ctx context.Context, hostName string, repositoryName string, tag string, reqEditors ...RequestEditorFn) (*GetHostRepositoryTagManifestsResponse, error) { rsp, err := c.GetHostRepositoryTagManifests(ctx, hostName, repositoryName, tag, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryTagManifestsResponse(rsp) } // GetHostRepositoryNamesWithResponse request returning *GetHostRepositoryNamesResponse func (c *ClientWithResponses) GetHostRepositoryNamesWithResponse(ctx context.Context, hostName string, params *GetHostRepositoryNamesParams, reqEditors ...RequestEditorFn) (*GetHostRepositoryNamesResponse, error) { rsp, err := c.GetHostRepositoryNames(ctx, hostName, params, reqEditors...) if err != nil { return nil, err } return ParseGetHostRepositoryNamesResponse(rsp) } // RepositoriesLookupWithResponse request returning *RepositoriesLookupResponse func (c *ClientWithResponses) RepositoriesLookupWithResponse(ctx context.Context, params *RepositoriesLookupParams, reqEditors ...RequestEditorFn) (*RepositoriesLookupResponse, error) { rsp, err := c.RepositoriesLookup(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseRepositoriesLookupResponse(rsp) } // TopicsWithResponse request returning *TopicsResponse func (c *ClientWithResponses) TopicsWithResponse(ctx context.Context, params *TopicsParams, reqEditors ...RequestEditorFn) (*TopicsResponse, error) { rsp, err := c.Topics(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseTopicsResponse(rsp) } // TopicWithResponse request returning *TopicResponse func (c *ClientWithResponses) TopicWithResponse(ctx context.Context, topic string, params *TopicParams, reqEditors ...RequestEditorFn) (*TopicResponse, error) { rsp, err := c.Topic(ctx, topic, params, reqEditors...) if err != nil { return nil, err } return ParseTopicResponse(rsp) } // UsageWithResponse request returning *UsageResponse func (c *ClientWithResponses) UsageWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UsageResponse, error) { rsp, err := c.Usage(ctx, reqEditors...) if err != nil { return nil, err } return ParseUsageResponse(rsp) } // UsageEcosystemWithResponse request returning *UsageEcosystemResponse func (c *ClientWithResponses) UsageEcosystemWithResponse(ctx context.Context, ecosystem string, reqEditors ...RequestEditorFn) (*UsageEcosystemResponse, error) { rsp, err := c.UsageEcosystem(ctx, ecosystem, reqEditors...) if err != nil { return nil, err } return ParseUsageEcosystemResponse(rsp) } // UsagePackageWithResponse request returning *UsagePackageResponse func (c *ClientWithResponses) UsagePackageWithResponse(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*UsagePackageResponse, error) { rsp, err := c.UsagePackage(ctx, ecosystem, pPackage, reqEditors...) if err != nil { return nil, err } return ParseUsagePackageResponse(rsp) } // UsagePackageDependenciesWithResponse request returning *UsagePackageDependenciesResponse func (c *ClientWithResponses) UsagePackageDependenciesWithResponse(ctx context.Context, ecosystem string, pPackage string, reqEditors ...RequestEditorFn) (*UsagePackageDependenciesResponse, error) { rsp, err := c.UsagePackageDependencies(ctx, ecosystem, pPackage, reqEditors...) if err != nil { return nil, err } return ParseUsagePackageDependenciesResponse(rsp) } // ParseGetRegistriesResponse parses an HTTP response from a GetRegistriesWithResponse call func ParseGetRegistriesResponse(rsp *http.Response) (*GetRegistriesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetRegistriesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Host if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseLookupHostOwnerResponse parses an HTTP response from a LookupHostOwnerWithResponse call func ParseLookupHostOwnerResponse(rsp *http.Response) (*LookupHostOwnerResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &LookupHostOwnerResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Owner if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostResponse parses an HTTP response from a GetHostWithResponse call func ParseGetHostResponse(rsp *http.Response) (*GetHostResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Host if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostOwnersResponse parses an HTTP response from a GetHostOwnersWithResponse call func ParseGetHostOwnersResponse(rsp *http.Response) (*GetHostOwnersResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostOwnersResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Owner if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostOwnerResponse parses an HTTP response from a GetHostOwnerWithResponse call func ParseGetHostOwnerResponse(rsp *http.Response) (*GetHostOwnerResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostOwnerResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Owner if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostOwnerRepositoriesResponse parses an HTTP response from a GetHostOwnerRepositoriesWithResponse call func ParseGetHostOwnerRepositoriesResponse(rsp *http.Response) (*GetHostOwnerRepositoriesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostOwnerRepositoriesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Repository if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoriesResponse parses an HTTP response from a GetHostRepositoriesWithResponse call func ParseGetHostRepositoriesResponse(rsp *http.Response) (*GetHostRepositoriesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoriesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Repository if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryResponse parses an HTTP response from a GetHostRepositoryWithResponse call func ParseGetHostRepositoryResponse(rsp *http.Response) (*GetHostRepositoryResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Repository if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryManifestsResponse parses an HTTP response from a GetHostRepositoryManifestsWithResponse call func ParseGetHostRepositoryManifestsResponse(rsp *http.Response) (*GetHostRepositoryManifestsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryManifestsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Manifest if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryReleasesResponse parses an HTTP response from a GetHostRepositoryReleasesWithResponse call func ParseGetHostRepositoryReleasesResponse(rsp *http.Response) (*GetHostRepositoryReleasesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryReleasesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Tag if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryReleaseResponse parses an HTTP response from a GetHostRepositoryReleaseWithResponse call func ParseGetHostRepositoryReleaseResponse(rsp *http.Response) (*GetHostRepositoryReleaseResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryReleaseResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Release if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryTagsResponse parses an HTTP response from a GetHostRepositoryTagsWithResponse call func ParseGetHostRepositoryTagsResponse(rsp *http.Response) (*GetHostRepositoryTagsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryTagsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Tag if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryTagResponse parses an HTTP response from a GetHostRepositoryTagWithResponse call func ParseGetHostRepositoryTagResponse(rsp *http.Response) (*GetHostRepositoryTagResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryTagResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Tag if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryTagManifestsResponse parses an HTTP response from a GetHostRepositoryTagManifestsWithResponse call func ParseGetHostRepositoryTagManifestsResponse(rsp *http.Response) (*GetHostRepositoryTagManifestsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryTagManifestsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Manifest if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseGetHostRepositoryNamesResponse parses an HTTP response from a GetHostRepositoryNamesWithResponse call func ParseGetHostRepositoryNamesResponse(rsp *http.Response) (*GetHostRepositoryNamesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetHostRepositoryNamesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []string if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseRepositoriesLookupResponse parses an HTTP response from a RepositoriesLookupWithResponse call func ParseRepositoriesLookupResponse(rsp *http.Response) (*RepositoriesLookupResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &RepositoriesLookupResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest Repository if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseTopicsResponse parses an HTTP response from a TopicsWithResponse call func ParseTopicsResponse(rsp *http.Response) (*TopicsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &TopicsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Topic if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseTopicResponse parses an HTTP response from a TopicWithResponse call func ParseTopicResponse(rsp *http.Response) (*TopicResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &TopicResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest TopicWithRepositories if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseUsageResponse parses an HTTP response from a UsageWithResponse call func ParseUsageResponse(rsp *http.Response) (*UsageResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &UsageResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []Ecosystem if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseUsageEcosystemResponse parses an HTTP response from a UsageEcosystemWithResponse call func ParseUsageEcosystemResponse(rsp *http.Response) (*UsageEcosystemResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &UsageEcosystemResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest []PackageUsage if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseUsagePackageResponse parses an HTTP response from a UsagePackageWithResponse call func ParseUsagePackageResponse(rsp *http.Response) (*UsagePackageResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &UsagePackageResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest PackageUsage if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } // ParseUsagePackageDependenciesResponse parses an HTTP response from a UsagePackageDependenciesWithResponse call func ParseUsagePackageDependenciesResponse(rsp *http.Response) (*UsagePackageDependenciesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &UsagePackageDependenciesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest DependencyWithRepository if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.JSON200 = &dest } return response, nil } ================================================ FILE: go.mod ================================================ module github.com/snyk/parlay go 1.25.7 require ( github.com/CycloneDX/cyclonedx-go v0.9.2 github.com/deepmap/oapi-codegen v1.12.4 github.com/edoardottt/depsdev v0.0.3 github.com/google/uuid v1.5.0 github.com/hashicorp/go-retryablehttp v0.7.7 github.com/jarcoal/httpmock v1.3.0 github.com/oapi-codegen/runtime v1.1.1 github.com/package-url/packageurl-go v0.1.2 github.com/remeh/sizedwaitgroup v1.0.0 github.com/rs/zerolog v1.29.1 github.com/spdx/tools-golang v0.5.4-0.20240304222056-8baafa1a79c4 github.com/spf13/cobra v1.7.0 github.com/spf13/viper v1.15.0 github.com/stretchr/testify v1.10.0 ) require ( github.com/anchore/go-struct-converter v0.0.0-20221118182256-c68fdcfa2092 // indirect github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect github.com/avast/retry-go v3.0.0+incompatible // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/fsnotify/fsnotify v1.6.0 // indirect github.com/hashicorp/go-cleanhttp v0.5.2 // indirect github.com/hashicorp/hcl v1.0.0 // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/magiconair/properties v1.8.7 // indirect github.com/mattn/go-colorable v0.1.13 // indirect github.com/mattn/go-isatty v0.0.20 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/pelletier/go-toml/v2 v2.0.9 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/spf13/afero v1.9.3 // indirect github.com/spf13/cast v1.5.0 // indirect github.com/spf13/jwalterweatherman v1.1.0 // indirect github.com/spf13/pflag v1.0.5 // indirect github.com/subosito/gotenv v1.4.2 // indirect golang.org/x/sys v0.20.0 // indirect golang.org/x/text v0.14.0 // indirect gopkg.in/ini.v1 v1.67.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) ================================================ FILE: go.sum ================================================ cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= cloud.google.com/go v0.38.0/go.mod h1:990N+gfupTy94rShfmMCWGDn0LpTmnzTp2qbd1dvSRU= cloud.google.com/go v0.44.1/go.mod h1:iSa0KzasP4Uvy3f1mN/7PiObzGgflwredwwASm/v6AU= cloud.google.com/go v0.44.2/go.mod h1:60680Gw3Yr4ikxnPRS/oxxkBccT6SA1yMk63TGekxKY= cloud.google.com/go v0.44.3/go.mod h1:60680Gw3Yr4ikxnPRS/oxxkBccT6SA1yMk63TGekxKY= cloud.google.com/go v0.45.1/go.mod h1:RpBamKRgapWJb87xiFSdk4g1CME7QZg3uwTez+TSTjc= cloud.google.com/go v0.46.3/go.mod h1:a6bKKbmY7er1mI7TEI4lsAkts/mkhTSZK8w33B4RAg0= cloud.google.com/go v0.50.0/go.mod h1:r9sluTvynVuxRIOHXQEHMFffphuXHOMZMycpNR5e6To= cloud.google.com/go v0.52.0/go.mod h1:pXajvRH/6o3+F9jDHZWQ5PbGhn+o8w9qiu/CffaVdO4= cloud.google.com/go v0.53.0/go.mod h1:fp/UouUEsRkN6ryDKNW/Upv/JBKnv6WDthjR6+vze6M= cloud.google.com/go v0.54.0/go.mod h1:1rq2OEkV3YMf6n/9ZvGWI3GWw0VoqH/1x2nd8Is/bPc= cloud.google.com/go v0.56.0/go.mod h1:jr7tqZxxKOVYizybht9+26Z/gUq7tiRzu+ACVAMbKVk= cloud.google.com/go v0.57.0/go.mod h1:oXiQ6Rzq3RAkkY7N6t3TcE6jE+CIBBbA36lwQ1JyzZs= cloud.google.com/go v0.62.0/go.mod h1:jmCYTdRCQuc1PHIIJ/maLInMho30T/Y0M4hTdTShOYc= cloud.google.com/go v0.65.0/go.mod h1:O5N8zS7uWy9vkA9vayVHs65eM1ubvY4h553ofrNHObY= cloud.google.com/go v0.72.0/go.mod h1:M+5Vjvlc2wnp6tjzE102Dw08nGShTscUx2nZMufOKPI= cloud.google.com/go v0.74.0/go.mod h1:VV1xSbzvo+9QJOxLDaJfTjx5e+MePCpCWwvftOeQmWk= cloud.google.com/go v0.75.0/go.mod h1:VGuuCn7PG0dwsd5XPVm2Mm3wlh3EL55/79EKB6hlPTY= cloud.google.com/go/bigquery v1.0.1/go.mod h1:i/xbL2UlR5RvWAURpBYZTtm/cXjCha9lbfbpx4poX+o= cloud.google.com/go/bigquery v1.3.0/go.mod h1:PjpwJnslEMmckchkHFfq+HTD2DmtT67aNFKH1/VBDHE= cloud.google.com/go/bigquery v1.4.0/go.mod h1:S8dzgnTigyfTmLBfrtrhyYhwRxG72rYxvftPBK2Dvzc= cloud.google.com/go/bigquery v1.5.0/go.mod h1:snEHRnqQbz117VIFhE8bmtwIDY80NLUZUMb4Nv6dBIg= cloud.google.com/go/bigquery v1.7.0/go.mod h1://okPTzCYNXSlb24MZs83e2Do+h+VXtc4gLoIoXIAPc= cloud.google.com/go/bigquery v1.8.0/go.mod h1:J5hqkt3O0uAFnINi6JXValWIb1v0goeZM77hZzJN/fQ= cloud.google.com/go/datastore v1.0.0/go.mod h1:LXYbyblFSglQ5pkeyhO+Qmw7ukd3C+pD7TKLgZqpHYE= cloud.google.com/go/datastore v1.1.0/go.mod h1:umbIZjpQpHh4hmRpGhH4tLFup+FVzqBi1b3c64qFpCk= cloud.google.com/go/pubsub v1.0.1/go.mod h1:R0Gpsv3s54REJCy4fxDixWD93lHJMoZTyQ2kNxGRt3I= cloud.google.com/go/pubsub v1.1.0/go.mod h1:EwwdRX2sKPjnvnqCa270oGRyludottCI76h+R3AArQw= cloud.google.com/go/pubsub v1.2.0/go.mod h1:jhfEVHT8odbXTkndysNHCcx0awwzvfOlguIAii9o8iA= cloud.google.com/go/pubsub v1.3.1/go.mod h1:i+ucay31+CNRpDW4Lu78I4xXG+O1r/MAHgjpRVR+TSU= cloud.google.com/go/storage v1.0.0/go.mod h1:IhtSnM/ZTZV8YYJWCY8RULGVqBDmpoyjwiyrjsg+URw= cloud.google.com/go/storage v1.5.0/go.mod h1:tpKbwo567HUNpVclU5sGELwQWBDZ8gh0ZeosJ0Rtdos= cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohlUTyfDhBk= cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs= cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0= cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3fOKtUw0Xmo= dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/CycloneDX/cyclonedx-go v0.9.2 h1:688QHn2X/5nRezKe2ueIVCt+NRqf7fl3AVQk+vaFcIo= github.com/CycloneDX/cyclonedx-go v0.9.2/go.mod h1:vcK6pKgO1WanCdd61qx4bFnSsDJQ6SbM2ZuMIgq86Jg= github.com/RaveNoX/go-jsoncommentstrip v1.0.0/go.mod h1:78ihd09MekBnJnxpICcwzCMzGrKSKYe4AqU6PDYYpjk= github.com/anchore/go-struct-converter v0.0.0-20221118182256-c68fdcfa2092 h1:aM1rlcoLz8y5B2r4tTLMiVTrMtpfY0O8EScKJxaSaEc= github.com/anchore/go-struct-converter v0.0.0-20221118182256-c68fdcfa2092/go.mod h1:rYqSE9HbjzpHTI74vwPvae4ZVYZd1lue2ta6xHPdblA= github.com/apapsch/go-jsonmerge/v2 v2.0.0 h1:axGnT1gRIfimI7gJifB699GoE/oq+F2MU7Dml6nw9rQ= github.com/apapsch/go-jsonmerge/v2 v2.0.0/go.mod h1:lvDnEdqiQrp0O42VQGgmlKpxL1AP2+08jFMw88y4klk= github.com/avast/retry-go v3.0.0+incompatible h1:4SOWQ7Qs+oroOTQOYnAHqelpCO0biHSxpiH9JdtuBj0= github.com/avast/retry-go v3.0.0+incompatible/go.mod h1:XtSnn+n/sHqQIpZ10K1qAevBhOOCWBLXXy3hyiqqBrY= github.com/bmatcuk/doublestar v1.1.1/go.mod h1:UD6OnuiIn0yFxxA2le/rnRU1G4RaI4UvFv1sNto9p6w= github.com/bradleyjkemp/cupaloy/v2 v2.8.0 h1:any4BmKE+jGIaMpnU8YgH/I2LPiLBufr6oMMlVBbn9M= github.com/bradleyjkemp/cupaloy/v2 v2.8.0/go.mod h1:bm7JXdkRd4BHJk9HpwqAI8BoAY1lps46Enkdqw6aRX0= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/deepmap/oapi-codegen v1.12.4 h1:pPmn6qI9MuOtCz82WY2Xaw46EQjgvxednXXrP7g5Q2s= github.com/deepmap/oapi-codegen v1.12.4/go.mod h1:3lgHGMu6myQ2vqbbTXH2H1o4eXFTGnFiDaOaKKl5yas= github.com/edoardottt/depsdev v0.0.3 h1:QqTZGjdvrq8aZ0qhlPxUHiDrB+LadqUVsHX9a03pWO0= github.com/edoardottt/depsdev v0.0.3/go.mod h1:IQTpYyqJbheAt6AXD/96CUMSGHha5r6rMLNKD8CXkiY= github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= github.com/envoyproxy/go-control-plane v0.9.7/go.mod h1:cwu0lG7PUMfa9snN8LXBig5ynNVH9qI8YYLbd1fK2po= github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk= github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM= github.com/fatih/color v1.16.0/go.mod h1:fL2Sau1YI5c0pdGEVCbKQbLXB6edEj1ZgiY4NijnWvE= github.com/frankban/quicktest v1.14.3 h1:FJKSZTDHjyhriyC81FLQ0LY93eSai0ZyR/ZIkd3ZUKE= github.com/frankban/quicktest v1.14.3/go.mod h1:mgiwOwqx65TmIk1wJ6Q7wvnVMocbUorkibMOrVTHZps= github.com/fsnotify/fsnotify v1.6.0 h1:n+5WquG0fcWoWp6xPWfHdbskMCQaFnG6PfBrh1Ky4HY= github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbSClcnxKAGw= github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y= github.com/golang/mock v1.4.0/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= github.com/golang/mock v1.4.1/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4= github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= github.com/golang/protobuf v1.3.4/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= github.com/golang/protobuf v1.3.5/go.mod h1:6O5/vntMXwX2lRkT1hjjk0nAC1IDOTvTlVgjlRvqsdk= github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8= github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA= github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8= github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.4.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0= github.com/google/martian/v3 v3.1.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0= github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= github.com/google/pprof v0.0.0-20191218002539-d4f498aebedc/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= github.com/google/pprof v0.0.0-20200212024743-f11f1df84d12/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= github.com/google/pprof v0.0.0-20200229191704-1ebb73c60ed3/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= github.com/google/pprof v0.0.0-20200430221834-fc25d7d30c6d/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= github.com/google/pprof v0.0.0-20200708004538-1a94d8640e99/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= github.com/google/pprof v0.0.0-20201023163331-3e6fc7fc9c4c/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/pprof v0.0.0-20201203190320-1bf35d6f28c2/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/pprof v0.0.0-20201218002935-b9804c9f04c2/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.5.0 h1:1p67kYwdtXjb0gL0BPiP1Av9wiZPo5A8z2cWkTZ+eyU= github.com/google/uuid v1.5.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg= github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= github.com/googleapis/google-cloud-go-testing v0.0.0-20200911160855-bcd43fbb19e8/go.mod h1:dvDLG8qkwmyD9a/MJJN3XJcT3xFxOKAvTZGvuZmac9g= github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ= github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k= github.com/hashicorp/go-hclog v1.6.3/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M= github.com/hashicorp/go-retryablehttp v0.7.7 h1:C8hUCYzor8PIfXHa4UrZkU4VvK8o9ISHxT2Q8+VepXU= github.com/hashicorp/go-retryablehttp v0.7.7/go.mod h1:pkQpWZeYWskR+D1tR2O5OcBFOxfA7DoAO6xtkuQnHTk= github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4= github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= github.com/jarcoal/httpmock v1.3.0 h1:2RJ8GP0IIaWwcC9Fp2BmVi8Kog3v2Hn7VXM3fTd+nuc= github.com/jarcoal/httpmock v1.3.0/go.mod h1:3yb8rc4BI7TCBhFY8ng0gjuLKJNquuDNiPaZjnENuYg= github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk= github.com/juju/gnuflag v0.0.0-20171113085948-2ce1bb71843d/go.mod h1:2PavIy+JPciBPrBUjwbNvtwB6RQlve+hkpll6QSNmOE= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0= github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY= github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0= github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/maxatome/go-testdeep v1.12.0 h1:Ql7Go8Tg0C1D/uMMX59LAoYK7LffeJQ6X2T04nTH68g= github.com/maxatome/go-testdeep v1.12.0/go.mod h1:lPZc/HAcJMP92l7yI6TRz1aZN5URwUBUAfUNvrclaNM= github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/oapi-codegen/runtime v1.1.1 h1:EXLHh0DXIJnWhdRPN2w4MXAzFyE4CskzhNLUmtpMYro= github.com/oapi-codegen/runtime v1.1.1/go.mod h1:SK9X900oXmPWilYR5/WKPzt3Kqxn/uS/+lbpREv+eCg= github.com/package-url/packageurl-go v0.1.2 h1:0H2DQt6DHd/NeRlVwW4EZ4oEI6Bn40XlNPRqegcxuo4= github.com/package-url/packageurl-go v0.1.2/go.mod h1:uQd4a7Rh3ZsVg5j0lNyAfyxIeGde9yrlhjF78GzeW0c= github.com/pelletier/go-toml/v2 v2.0.9 h1:uH2qQXheeefCCkuBBSLi7jCiSmj3VRh2+Goq2N7Xxu0= github.com/pelletier/go-toml/v2 v2.0.9/go.mod h1:tJU2Z3ZkXwnxa4DPO899bsyIoywizdUvyaeZurnPPDc= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/sftp v1.13.1/go.mod h1:3HaPG6Dq1ILlpPZRO0HVMrsydcdLt6HRDccSgb87qRg= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/remeh/sizedwaitgroup v1.0.0 h1:VNGGFwNo/R5+MJBf6yrsr110p0m4/OX4S3DCy7Kyl5E= github.com/remeh/sizedwaitgroup v1.0.0/go.mod h1:3j2R4OIe/SeS6YDhICBy22RWjJC5eNCJ1V+9+NVNYlo= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= github.com/rogpeppe/go-internal v1.6.1 h1:/FiVV8dS/e+YqF2JvO3yXRFbBLTIuSDkuC7aBOAvL+k= github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc= github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= github.com/rs/zerolog v1.29.1 h1:cO+d60CHkknCbvzEWxP0S9K6KqyTjrCNUy1LdQLCGPc= github.com/rs/zerolog v1.29.1/go.mod h1:Le6ESbR7hc+DP6Lt1THiV8CQSdkkNrd3R0XbEgp3ZBU= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/spdx/gordf v0.0.0-20201111095634-7098f93598fb/go.mod h1:uKWaldnbMnjsSAXRurWqqrdyZen1R7kxl8TkmWk2OyM= github.com/spdx/tools-golang v0.5.4-0.20240304222056-8baafa1a79c4 h1:h1iNkxAggQH5lpDxHslTTB3Y61XN2G/rjA/n/TAIwFg= github.com/spdx/tools-golang v0.5.4-0.20240304222056-8baafa1a79c4/go.mod h1:MVIsXx8ZZzaRWNQpUDhC4Dud34edUYJYecciXgrw5vE= github.com/spf13/afero v1.9.3 h1:41FoI0fD7OR7mGcKE/aOiLkGreyf8ifIOQmJANWogMk= github.com/spf13/afero v1.9.3/go.mod h1:iUV7ddyEEZPO5gA3zD4fJt6iStLlL+Lg4m2cihcDf8Y= github.com/spf13/cast v1.5.0 h1:rj3WzYc11XZaIZMPKmwP96zkFEnnAmV8s6XbB2aY32w= github.com/spf13/cast v1.5.0/go.mod h1:SpXXQ5YoyJw6s3/6cMTQuxvgRl3PCJiyaX9p6b155UU= github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I= github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0= github.com/spf13/jwalterweatherman v1.1.0 h1:ue6voC5bR5F8YxI5S67j9i582FU4Qvo2bmqnqMYADFk= github.com/spf13/jwalterweatherman v1.1.0/go.mod h1:aNWZUN0dPAAO/Ljvb5BEdw96iTZ0EXowPYD95IqWIGo= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/spf13/viper v1.15.0 h1:js3yy885G8xwJa6iOISGFwd+qlUo5AvyXb7CiihdtiU= github.com/spf13/viper v1.15.0/go.mod h1:fFcTBJxvhhzSJiZy8n+PeW6t8l+KeT/uTARa0jHOQLA= github.com/spkg/bom v0.0.0-20160624110644-59b7046e48ad/go.mod h1:qLr4V1qq6nMqFKkMo8ZTx3f+BZEkzsRUY10Xsm2mwU0= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/subosito/gotenv v1.4.2 h1:X1TuBLAMDFbaTAChgCBLu3DU3UPyELpnF2jjJ2cz/S8= github.com/subosito/gotenv v1.4.2/go.mod h1:ayKnFf/c6rvx/2iiLrJUk1e6plDbT3edrFNGqEflhK0= github.com/terminalstatic/go-xsd-validate v0.1.6 h1:TenYeQ3eY631qNi1/cTmLH/s2slHPRKTTHT+XSHkepo= github.com/terminalstatic/go-xsd-validate v0.1.6/go.mod h1:18lsvYFofBflqCrvo1umpABZ99+GneNTw2kEEc8UPJw= github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f h1:J9EGpcZtP0E/raorCMxlFGSTBrsSlaDGf3jU/qvAE2c= github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU= github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 h1:EzJWgHovont7NscjpAxXsDA8S8BMYve8Y5+7cuRE7R0= github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ= github.com/xeipuuv/gojsonschema v1.2.0 h1:LhYJRs+L4fBtjZUfuSZIKGeVu0QRy8e5Xi7D17UxZ74= github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y= github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU= go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8= go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.5/go.mod h1:5pWMHQbX5EPX2/62yrJeAkowc+lfs/XD7Uxpq3pI6kk= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= golang.org/x/exp v0.0.0-20190829153037-c13cbed26979/go.mod h1:86+5VVa7VpoJ4kLfm080zCjGlMRFzhUhsZKEZO7MGek= golang.org/x/exp v0.0.0-20191030013958-a1ab85dbe136/go.mod h1:JXzH8nQsPlswgeRAPE3MuO9GYsAcnJvJ4vnMwN/5qkY= golang.org/x/exp v0.0.0-20191129062945-2f5052295587/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4= golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4= golang.org/x/exp v0.0.0-20200119233911-0405dc783f0a/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4= golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM= golang.org/x/exp v0.0.0-20200224162631-6cc2880d07d6/go.mod h1:3jZMyOhIsHpP37uCMkUooju7aAi5cS1Q23tOzKc+0MU= golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= golang.org/x/lint v0.0.0-20190301231843-5614ed5bae6f/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/lint v0.0.0-20190409202823-959b441ac422/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/lint v0.0.0-20190909230951-414d861bb4ac/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f/go.mod h1:5qLYkcX4OjUUV8bRuDixDT3tpyyb+LUpUlRWLxfhWrs= golang.org/x/lint v0.0.0-20200130185559-910be7a94367/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o= golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc= golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY= golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= golang.org/x/mod v0.1.1-0.20191107180719-034126e5016b/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190501004415-9ce7a6920f09/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190628185345-da137c7871d7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200222125558-5a598a2470a0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200501053045-e0ff5e5a1de5/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200506145744-7e3656a0809f/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200513185701-a91f0712d120/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20200707034311-ab3426394381/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= golang.org/x/net v0.0.0-20201031054903-ff519b6c9102/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20200902213428-5d25da1a8d43/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20201109201403-9fd604954f58/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20201208152858-08078c50e5b5/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210218202405-ba52d332ba99/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190502145724-3ef323f4f1fd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191228213918-04cbcbbfeed8/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200113162924-86b910548bc1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200122134326-e047566fdf82/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200212091648-12a6c2dcc1e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200331124033-c3d80250170d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200501052902-10377860bb8e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200511232937-7e40ca221e25/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200523222454-059865788121/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200803210538-64077c9b5642/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200905004654-be1d3432aa8f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201201145000-ef89a241ccb3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210104204734-6f8348627aad/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210225134936-a50acf3fe073/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y= golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20190312170243-e65039ee4138/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190506145303-2d16b83fe98c/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190816200558-6889da9d5479/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20190911174233-4f2ddba30aff/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191113191852-77e3bb0ad9e7/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191115202509-3a792d9c32b2/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191125144606-a911d9008d1f/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191130070609-6e064ea0cf2d/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191216173652-a0e659d51361/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20191227053925-7b8e75db28f4/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200117161641-43d50277825c/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200122220014-bf1340f18c4a/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200204074204-1cc6d1ef6c74/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200212150539-ea181f53ac56/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200224181240-023911ca70b2/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200227222343-706bc42d1f0d/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200304193943-95d2e580d8eb/go.mod h1:o4KQGtdN14AW+yjsvvwRTJJuXz8XRtIHtEnmAXLyFUw= golang.org/x/tools v0.0.0-20200312045724-11d5b4c81c7d/go.mod h1:o4KQGtdN14AW+yjsvvwRTJJuXz8XRtIHtEnmAXLyFUw= golang.org/x/tools v0.0.0-20200331025713-a30bf2db82d4/go.mod h1:Sl4aGygMT6LrqrWclx+PTx3U+LnKx/seiNR+3G19Ar8= golang.org/x/tools v0.0.0-20200501065659-ab2804fb9c9d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200512131952-2bc93b1c0c88/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200515010526-7d3b6ebf133d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200618134242-20370b0cb4b2/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200729194436-6467de6f59a7/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200804011535-6c149bb5ef0d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200825202427-b303f430e36d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200904185747-39188db58858/go.mod h1:Cj7w3i3Rnn0Xh82ur9kSqwfTHTeVxaDqrfMjpcNT6bE= golang.org/x/tools v0.0.0-20201110124207-079ba7bd75cd/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20201201161351-ac6f37ff4c2a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20201208233053-a543418bbed2/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20210108195828-e2f9c7f1fc8e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/api v0.4.0/go.mod h1:8k5glujaEP+g9n7WNsDg8QP6cUVNI86fCNMcbazEtwE= google.golang.org/api v0.7.0/go.mod h1:WtwebWUNSVBH/HAw79HIFXZNqEvBhG+Ra+ax0hx3E3M= google.golang.org/api v0.8.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg= google.golang.org/api v0.9.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg= google.golang.org/api v0.13.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI= google.golang.org/api v0.14.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI= google.golang.org/api v0.15.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI= google.golang.org/api v0.17.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= google.golang.org/api v0.18.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= google.golang.org/api v0.19.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= google.golang.org/api v0.20.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= google.golang.org/api v0.22.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= google.golang.org/api v0.24.0/go.mod h1:lIXQywCXRcnZPGlsd8NbLnOjtAoL6em04bJ9+z0MncE= google.golang.org/api v0.28.0/go.mod h1:lIXQywCXRcnZPGlsd8NbLnOjtAoL6em04bJ9+z0MncE= google.golang.org/api v0.29.0/go.mod h1:Lcubydp8VUV7KeIHD9z2Bys/sm/vGKnG1UHuDBSrHWM= google.golang.org/api v0.30.0/go.mod h1:QGmEvQ87FHZNiUVJkT14jQNYJ4ZJjdRF23ZXz5138Fc= google.golang.org/api v0.35.0/go.mod h1:/XrVsuzM0rZmrsbjJutiuftIzeuTQcEeaYcSk/mQ1dg= google.golang.org/api v0.36.0/go.mod h1:+z5ficQTmoYpPn8LCUNVpK5I7hwkpjbcgqA7I34qYtE= google.golang.org/api v0.40.0/go.mod h1:fYKFpnQN0DsDSKRVRcQSDQNtqWPfM9i+zNPxepjRCQ8= google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= google.golang.org/appengine v1.5.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= google.golang.org/appengine v1.6.1/go.mod h1:i06prIuMbXzDqacNJfV5OdTW448YApPu5ww/cMBSeb0= google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= google.golang.org/appengine v1.6.6/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= google.golang.org/genproto v0.0.0-20190307195333-5fe7a883aa19/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= google.golang.org/genproto v0.0.0-20190418145605-e7d98fc518a7/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= google.golang.org/genproto v0.0.0-20190425155659-357c62f0e4bb/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= google.golang.org/genproto v0.0.0-20190502173448-54afdca5d873/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= google.golang.org/genproto v0.0.0-20190801165951-fa694d86fc64/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= google.golang.org/genproto v0.0.0-20190911173649-1774047e7e51/go.mod h1:IbNlFCBrqXvoKpeg0TB2l7cyZUmoaFKYIwrEpbDKLA8= google.golang.org/genproto v0.0.0-20191108220845-16a3f7862a1a/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= google.golang.org/genproto v0.0.0-20191115194625-c23dd37a84c9/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= google.golang.org/genproto v0.0.0-20191216164720-4f79533eabd1/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= google.golang.org/genproto v0.0.0-20191230161307-f3c370f40bfb/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= google.golang.org/genproto v0.0.0-20200115191322-ca5a22157cba/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= google.golang.org/genproto v0.0.0-20200122232147-0452cf42e150/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= google.golang.org/genproto v0.0.0-20200204135345-fa8e72b47b90/go.mod h1:GmwEX6Z4W5gMy59cAlVYjN9JhxgbQH6Gn+gFDQe2lzA= google.golang.org/genproto v0.0.0-20200212174721-66ed5ce911ce/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200224152610-e50cd9704f63/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200228133532-8c2c7df3a383/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200305110556-506484158171/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200312145019-da6875a35672/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200331122359-1ee6d9798940/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200430143042-b979b6f78d84/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200511104702-f5ebc3bea380/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200515170657-fc4c6c6a6587/go.mod h1:YsZOwe1myG/8QRHRsmBRE1LrgQY60beZKjly0O1fX9U= google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo= google.golang.org/genproto v0.0.0-20200618031413-b414f8b61790/go.mod h1:jDfRM7FcilCzHH/e9qn6dsT145K34l5v+OpcnNgKAAA= google.golang.org/genproto v0.0.0-20200729003335-053ba62fc06f/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200804131852-c06518451d9c/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200825200019-8632dd797987/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200904004341-0bd0a958aa1d/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20201109203340-2640f1f9cdfb/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20201201144952-b05cb90ed32e/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20201210142538-e3217bee35cc/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20201214200347-8c77b98c765d/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20210108203827-ffc7fda8c3d7/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20210226172003-ab064af71705/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= google.golang.org/grpc v1.20.1/go.mod h1:10oTOabMzJvdu6/UiuZezV6QK5dSlG84ov/aaiqXj38= google.golang.org/grpc v1.21.1/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM= google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY= google.golang.org/grpc v1.26.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= google.golang.org/grpc v1.27.1/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= google.golang.org/grpc v1.28.0/go.mod h1:rpkK4SK4GF4Ach/+MFLZUBavHOvF2JJB5uozKKal+60= google.golang.org/grpc v1.29.1/go.mod h1:itym6AZVZYACWQqET3MqgPpjcuV5QH3BxFS3IjizoKk= google.golang.org/grpc v1.30.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= google.golang.org/grpc v1.31.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= google.golang.org/grpc v1.31.1/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= google.golang.org/grpc v1.33.2/go.mod h1:JMHMWHQWaTccqQQlmk3MJZS+GWXOdAesneDmEnv2fbc= google.golang.org/grpc v1.34.0/go.mod h1:WotjhfgOW/POjDeRt8vscBtXq+2VjORFy659qA51WJ8= google.golang.org/grpc v1.35.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGjtUeSXeh4= google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA= gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0= rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA= sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY= ================================================ FILE: internal/commands/default.go ================================================ package commands import ( "os" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/spf13/viper" "github.com/snyk/parlay/internal/commands/deps" "github.com/snyk/parlay/internal/commands/ecosystems" "github.com/snyk/parlay/internal/commands/scorecard" "github.com/snyk/parlay/internal/commands/snyk" ) // These values are set at build time var ( version = "" ) func NewDefaultCommand() *cobra.Command { output := zerolog.ConsoleWriter{Out: os.Stderr} logger := zerolog.New(output).With().Timestamp().Logger() cmd := cobra.Command{ Use: "parlay", Short: "Enrich an SBOM with context from third party services", SilenceUsage: true, Version: GetVersion(), DisableFlagsInUseLine: true, Run: func(cmd *cobra.Command, args []string) { if err := cmd.Help(); err != nil { logger.Fatal().Err(err).Msg("Failed to run parlay command") } }, PersistentPreRun: func(cmd *cobra.Command, args []string) { if viper.GetBool("debug") { zerolog.SetGlobalLevel(zerolog.DebugLevel) } else { zerolog.SetGlobalLevel(zerolog.InfoLevel) } }, } cmd.CompletionOptions.HiddenDefaultCmd = true cmd.PersistentFlags().Bool("debug", false, "") viper.BindPFlag("debug", cmd.PersistentFlags().Lookup("debug")) //nolint:errcheck cmd.SetVersionTemplate(`{{.Version}}`) cmd.AddCommand(ecosystems.NewEcosystemsRootCommand(&logger)) cmd.AddCommand(snyk.NewSnykRootCommand(&logger)) cmd.AddCommand(deps.NewDepsRootCommand(&logger)) cmd.AddCommand(scorecard.NewRootCommand(&logger)) return &cmd } func GetVersion() string { return version } ================================================ FILE: internal/commands/deps/repos.go ================================================ package deps import ( "encoding/json" "fmt" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/snyk/parlay/lib/deps" ) func NewRepoCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "repo ", Short: "Return repo info from deps.dev", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { repo, err := deps.GetRepoData(args[0]) if err != nil { logger.Fatal().Err(err).Msg("Failed to retrieve data from deps.dev") } repository, err := json.Marshal(repo) if err != nil { logger.Fatal().Err(err).Msg("Failed to parse response from deps.dev") } fmt.Print(string(repository)) }, } return &cmd } ================================================ FILE: internal/commands/deps/root.go ================================================ package deps import ( "github.com/rs/zerolog" "github.com/spf13/cobra" ) func NewDepsRootCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "deps", Short: "Commands for using parlay with deps.dev", Aliases: []string{"d"}, DisableFlagsInUseLine: true, SilenceUsage: true, Run: func(cmd *cobra.Command, args []string) { if err := cmd.Help(); err != nil { logger.Fatal().Err(err).Msg("Failed to run deps command") } }, } cmd.AddCommand(NewRepoCommand(logger)) return &cmd } ================================================ FILE: internal/commands/ecosystems/enrich.go ================================================ package ecosystems import ( "os" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/snyk/parlay/internal/utils" "github.com/snyk/parlay/lib/ecosystems" "github.com/snyk/parlay/lib/sbom" ) func NewEnrichCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "enrich ", Short: "Enrich an SBOM with ecosyste.ms data", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { b, err := utils.GetUserInput(args[0], os.Stdin) if err != nil { logger.Fatal().Err(err).Msg("Failed to read input") } doc, err := sbom.DecodeSBOMDocument(b) if err != nil { logger.Fatal().Err(err).Msg("Failed to read SBOM input") } ecosystems.EnrichSBOM(doc, logger) if err := doc.Encode(os.Stdout); err != nil { logger.Fatal().Err(err).Msg("Failed to encode new SBOM") } }, } return &cmd } ================================================ FILE: internal/commands/ecosystems/packages.go ================================================ package ecosystems import ( "fmt" "github.com/package-url/packageurl-go" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/snyk/parlay/lib/ecosystems" ) func NewPackageCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "package ", Short: "Return package info from ecosyste.ms", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { purl, err := packageurl.FromString(args[0]) if err != nil { logger.Fatal().Err(err).Msg("Failed to parse PackageURL") } resp, err := ecosystems.GetPackageData(purl) if err != nil { logger.Fatal().Err(err).Msg("Failed to get package data from ecosyste.ms") } fmt.Print(string(resp.Body)) }, } return &cmd } ================================================ FILE: internal/commands/ecosystems/repos.go ================================================ package ecosystems import ( "fmt" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/snyk/parlay/lib/ecosystems" ) func NewRepoCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "repo ", Short: "Return repo info from ecosyste.ms", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { resp, err := ecosystems.GetRepoData(args[0]) if err != nil { logger.Fatal().Err(err).Msg("Failed to get repository data from ecosyste.ms") } fmt.Print(string(resp.Body)) }, } return &cmd } ================================================ FILE: internal/commands/ecosystems/root.go ================================================ package ecosystems import ( "github.com/rs/zerolog" "github.com/spf13/cobra" ) func NewEcosystemsRootCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "ecosystems", Short: "Commands for using parlay with ecosystem.ms", Aliases: []string{"e"}, DisableFlagsInUseLine: true, SilenceUsage: true, Run: func(cmd *cobra.Command, args []string) { if err := cmd.Help(); err != nil { logger.Fatal().Err(err).Msg("Failed to run ecosystems command") } }, } cmd.AddCommand(NewPackageCommand(logger)) cmd.AddCommand(NewRepoCommand(logger)) cmd.AddCommand(NewEnrichCommand(logger)) return &cmd } ================================================ FILE: internal/commands/scorecard/enrich.go ================================================ package scorecard import ( "os" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/snyk/parlay/internal/utils" "github.com/snyk/parlay/lib/sbom" "github.com/snyk/parlay/lib/scorecard" ) func NewEnrichCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "enrich ", Short: "Enrich an SBOM with OpenSSF Scorecard data", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { b, err := utils.GetUserInput(args[0], os.Stdin) if err != nil { logger.Fatal().Err(err).Msg("Failed to read input") } doc, err := sbom.DecodeSBOMDocument(b) if err != nil { logger.Fatal().Err(err).Msg("Failed to read SBOM input") } scorecard.EnrichSBOM(doc) if err := doc.Encode(os.Stdout); err != nil { logger.Fatal().Err(err).Msg("Failed to encode new SBOM") } }, } return &cmd } ================================================ FILE: internal/commands/scorecard/root.go ================================================ package scorecard import ( "github.com/rs/zerolog" "github.com/spf13/cobra" ) func NewRootCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "scorecard", Short: "Commands for using parlay with OpenSSF Scorecard", Aliases: []string{"s"}, DisableFlagsInUseLine: true, SilenceUsage: true, Run: func(cmd *cobra.Command, args []string) { if err := cmd.Help(); err != nil { logger.Fatal().Err(err).Msg("Failed to run scorecard command") } }, } cmd.AddCommand(NewEnrichCommand(logger)) return &cmd } ================================================ FILE: internal/commands/snyk/config.go ================================================ package snyk import ( "os" "github.com/snyk/parlay/lib/snyk" ) func config() *snyk.Config { c := snyk.DefaultConfig() if t := os.Getenv("SNYK_TOKEN"); t != "" { c.APIToken = t } if u := os.Getenv("SNYK_API"); u != "" { c.SnykAPIURL = u } return c } ================================================ FILE: internal/commands/snyk/enrich.go ================================================ package snyk import ( "os" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/snyk/parlay/internal/utils" "github.com/snyk/parlay/lib/sbom" "github.com/snyk/parlay/lib/snyk" ) func NewEnrichCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "enrich ", Short: "Enrich an SBOM with Snyk data", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { cfg := config() svc := snyk.NewService(cfg, logger) b, err := utils.GetUserInput(args[0], os.Stdin) if err != nil { logger.Fatal().Err(err).Msg("Failed to read input") } doc, err := sbom.DecodeSBOMDocument(b) if err != nil { logger.Fatal().Err(err).Msg("Failed to read SBOM input") } svc.EnrichSBOM(doc) if err := doc.Encode(os.Stdout); err != nil { logger.Fatal().Err(err).Msg("Failed to encode new SBOM") } }, } return &cmd } ================================================ FILE: internal/commands/snyk/packages.go ================================================ package snyk import ( "fmt" "github.com/package-url/packageurl-go" "github.com/rs/zerolog" "github.com/spf13/cobra" "github.com/snyk/parlay/lib/snyk" ) func NewPackageCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "package ", Short: "Return package vulnerabilities from Snyk", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { cfg := config() svc := snyk.NewService(cfg, logger) purl, err := packageurl.FromString(args[0]) if err != nil { logger.Fatal().Err(err).Msg("Failed to parse PackageURL") } logger. Debug(). Str("purl", args[0]). Msg("Looking up package vulnerabilities from Snyk") resp, err := svc.GetPackageVulnerabilities(&purl) if err != nil { logger.Fatal().Err(err).Msg("Failed to look up package vulnerabilities") } fmt.Print(string(resp.Body)) }, } return &cmd } ================================================ FILE: internal/commands/snyk/root.go ================================================ package snyk import ( "github.com/rs/zerolog" "github.com/spf13/cobra" ) func NewSnykRootCommand(logger *zerolog.Logger) *cobra.Command { cmd := cobra.Command{ Use: "snyk", Short: "Commands for using parlay with Snyk", Aliases: []string{"s"}, DisableFlagsInUseLine: true, SilenceUsage: true, Run: func(cmd *cobra.Command, args []string) { if err := cmd.Help(); err != nil { logger.Fatal().Err(err).Msg("Failed to run snyk command") } }, } cmd.AddCommand(NewPackageCommand(logger)) cmd.AddCommand(NewEnrichCommand(logger)) return &cmd } ================================================ FILE: internal/utils/cdx.go ================================================ package utils import ( cdx "github.com/CycloneDX/cyclonedx-go" ) func traverseComponent(comps *[]*cdx.Component, comp *cdx.Component) { *comps = append(*comps, comp) if comp.Components == nil { return } for i := range *comp.Components { traverseComponent(comps, &(*comp.Components)[i]) } } func DiscoverCDXComponents(bom *cdx.BOM) []*cdx.Component { comps := make([]*cdx.Component, 0) if bom.Metadata != nil && bom.Metadata.Component != nil { traverseComponent(&comps, bom.Metadata.Component) } if bom.Components != nil { for i := range *bom.Components { traverseComponent(&comps, &(*bom.Components)[i]) } } return comps } ================================================ FILE: internal/utils/cdx_test.go ================================================ package utils_test import ( "testing" "github.com/snyk/parlay/internal/utils" cdx "github.com/CycloneDX/cyclonedx-go" "github.com/stretchr/testify/assert" ) func TestDiscoverCDXComponents(t *testing.T) { assert := assert.New(t) bom := &cdx.BOM{ Metadata: &cdx.Metadata{ Component: &cdx.Component{ Name: "MetaComp", }, }, Components: &[]cdx.Component{ { Name: "Parent", Components: &[]cdx.Component{ {Name: "Child"}, }, }, }, } result := utils.DiscoverCDXComponents(bom) assert.Equal(len(result), 3) } ================================================ FILE: internal/utils/input.go ================================================ package utils import ( "errors" "fmt" "io" "os" ) // GetUserInput will open and read from the given filename. If filename is // "-", it will read from the given file instead. func GetUserInput(filename string, file io.Reader) (b []byte, err error) { if filename != "-" { file, err = os.Open(filename) if err != nil { return nil, fmt.Errorf("could not open file: %w", err) } } b, err = io.ReadAll(file) if err != nil { return nil, fmt.Errorf("could not read file: %w", err) } if len(b) == 0 { return nil, errors.New("no input given") } return b, nil } ================================================ FILE: internal/utils/input_test.go ================================================ package utils import ( "bytes" "os" "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func TestGetUserInput_File(t *testing.T) { in := []byte("foo") f := writeToTempFile(t, in) b, err := GetUserInput(f.Name(), nil) assert.NoError(t, err) assert.Equal(t, in, b) } func TestGetUserInput_BadFile(t *testing.T) { b, err := GetUserInput("notafile", nil) assert.Nil(t, b) assert.ErrorContains(t, err, "could not open file") } func TestGetUserInput_Stdin(t *testing.T) { in := []byte("bar") b, err := GetUserInput("-", bytes.NewReader(in)) assert.NoError(t, err) assert.Equal(t, in, b) } func TestGetUserInput_NoContent(t *testing.T) { in := new([]byte) b, err := GetUserInput("-", bytes.NewReader(*in)) assert.ErrorContains(t, err, "no input given") assert.Nil(t, b) } func writeToTempFile(t *testing.T, b []byte) *os.File { t.Helper() f, err := os.CreateTemp("", "tmpfile-") require.NoError(t, err) n, err := f.Write(b) require.Equal(t, len(b), n) require.NoError(t, err) return f } ================================================ FILE: internal/utils/spdx.go ================================================ package utils import ( "fmt" "strings" "github.com/package-url/packageurl-go" spdx_2_3 "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/snyk/parlay/ecosystems/packages" ) func GetPurlFromSPDXPackage(pkg *spdx_2_3.Package) (*packageurl.PackageURL, error) { var p string for _, ref := range pkg.PackageExternalReferences { if ref.RefType == "purl" { p = ref.Locator break } } if p == "" { return nil, fmt.Errorf("no purl on package %s", pkg.PackageName) } purl, err := packageurl.FromString(p) if err != nil { return nil, err } return &purl, nil } func GetLicensesFromEcosystemsLicense(pkgVersionData *packages.VersionWithDependencies, pkgData *packages.Package) []string { if pkgVersionData != nil && pkgVersionData.Licenses != nil && *pkgVersionData.Licenses != "" { return strings.Split(*pkgVersionData.Licenses, ",") } else if pkgData != nil && len(pkgData.NormalizedLicenses) > 0 { return pkgData.NormalizedLicenses } return nil } func GetLicenseExpressionFromEcosystemsLicense(pkgVersionData *packages.VersionWithDependencies, pkgData *packages.Package) string { licenses := GetLicensesFromEcosystemsLicense(pkgVersionData, pkgData) if len(licenses) == 0 { return "" } return fmt.Sprintf("(%s)", strings.Join(licenses, " OR ")) } ================================================ FILE: internal/utils/spdx_test.go ================================================ package utils_test import ( "testing" "github.com/snyk/parlay/ecosystems/packages" "github.com/snyk/parlay/internal/utils" "github.com/stretchr/testify/assert" ) func TestGetSPDXLicenseExpressionFromEcosystemsLicense(t *testing.T) { assert := assert.New(t) versionedLicenses := "GPLv2,MIT" pkgVersionData := packages.VersionWithDependencies{Licenses: &versionedLicenses} latestLicenses := []string{"Apache-2.0"} pkgData := packages.Package{NormalizedLicenses: latestLicenses} expression := utils.GetLicenseExpressionFromEcosystemsLicense(&pkgVersionData, &pkgData) assert.Equal("(GPLv2 OR MIT)", expression) } func TestGetSPDXLicenseExpressionFromEcosystemsLicense_NoData(t *testing.T) { assert := assert.New(t) expression := utils.GetLicenseExpressionFromEcosystemsLicense(nil, nil) assert.Equal("", expression) } func TestGetSPDXLicenseExpressionFromEcosystemsLicense_NoVersionedData(t *testing.T) { assert := assert.New(t) pkgVersionData := packages.VersionWithDependencies{} latestLicenses := []string{"Apache-2.0"} pkgData := packages.Package{NormalizedLicenses: latestLicenses} expression := utils.GetLicenseExpressionFromEcosystemsLicense(&pkgVersionData, &pkgData) assert.Equal("(Apache-2.0)", expression) } func TestGetSPDXLicenseExpressionFromEcosystemsLicense_NoLatestData(t *testing.T) { assert := assert.New(t) versionedLicenses := "GPLv2,MIT" pkgVersionData := packages.VersionWithDependencies{Licenses: &versionedLicenses} pkgData := packages.Package{} expression := utils.GetLicenseExpressionFromEcosystemsLicense(&pkgVersionData, &pkgData) assert.Equal("(GPLv2 OR MIT)", expression) } func TestGetSPDXLicenseExpressionFromEcosystemsLicense_NoLicenses(t *testing.T) { assert := assert.New(t) pkgVersionData := packages.VersionWithDependencies{} pkgData := packages.Package{} expression := utils.GetLicenseExpressionFromEcosystemsLicense(&pkgVersionData, &pkgData) assert.Equal("", expression) } func TestGetSPDXLicenseExpressionFromEcosystemsLicense_EmptyLicenses(t *testing.T) { assert := assert.New(t) versionedLicenses := "" pkgVersionData := packages.VersionWithDependencies{Licenses: &versionedLicenses} latestLicenses := []string{} pkgData := packages.Package{NormalizedLicenses: latestLicenses} expression := utils.GetLicenseExpressionFromEcosystemsLicense(&pkgVersionData, &pkgData) assert.Equal("", expression) } ================================================ FILE: lib/deps/repo.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package deps import ( "github.com/edoardottt/depsdev/pkg/depsdev" ) func GetRepoData(url string) (*depsdev.Project, error) { proj, err := depsdev.GetProject(url) if err != nil { return nil, err } return &proj, nil } ================================================ FILE: lib/ecosystems/cache.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "sync" "github.com/package-url/packageurl-go" "github.com/snyk/parlay/ecosystems/packages" ) type Cache interface { GetPackageData(purl packageurl.PackageURL) (*packages.GetRegistryPackageResponse, error) GetPackageVersionData(purl packageurl.PackageURL) (*packages.GetRegistryPackageVersionResponse, error) } type InMemoryCache struct { packageCache map[string]*packages.GetRegistryPackageResponse packageVersionCache map[string]*packages.GetRegistryPackageVersionResponse mu sync.RWMutex } var ( globalCache *InMemoryCache globalCacheOnce sync.Once ) func NewInMemoryCache() *InMemoryCache { return &InMemoryCache{ packageCache: make(map[string]*packages.GetRegistryPackageResponse), packageVersionCache: make(map[string]*packages.GetRegistryPackageVersionResponse), } } // GetGlobalCache returns a singleton cache instance that persists for the lifetime of the process. // This cache is shared across all SBOM enrichments to avoid repeated API calls for the same packages, // including 404 responses for non-existent packages. func GetGlobalCache() *InMemoryCache { globalCacheOnce.Do(func() { globalCache = NewInMemoryCache() }) return globalCache } // ResetGlobalCache resets the global cache. This is primarily for testing purposes. func ResetGlobalCache() { globalCache = nil globalCacheOnce = sync.Once{} } func (c *InMemoryCache) GetPackageData(purl packageurl.PackageURL) (*packages.GetRegistryPackageResponse, error) { key := purl.ToString() c.mu.RLock() if cached, exists := c.packageCache[key]; exists { c.mu.RUnlock() return cached, nil } c.mu.RUnlock() response, err := GetPackageData(purl) if err != nil { return nil, err } c.mu.Lock() c.packageCache[key] = response c.mu.Unlock() return response, nil } func (c *InMemoryCache) GetPackageVersionData(purl packageurl.PackageURL) (*packages.GetRegistryPackageVersionResponse, error) { key := purl.ToString() c.mu.RLock() if cached, exists := c.packageVersionCache[key]; exists { c.mu.RUnlock() return cached, nil } c.mu.RUnlock() response, err := GetPackageVersionData(purl) if err != nil { return nil, err } c.mu.Lock() c.packageVersionCache[key] = response c.mu.Unlock() return response, nil } func (c *InMemoryCache) GetCacheStats() (int, int) { c.mu.RLock() defer c.mu.RUnlock() return len(c.packageCache), len(c.packageVersionCache) } ================================================ FILE: lib/ecosystems/cache_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "sync" "testing" "github.com/jarcoal/httpmock" "github.com/package-url/packageurl-go" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func TestInMemoryCache_GetPackageData(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() mockResponse := `{"name": "test-package", "description": "Test package"}` httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(200, mockResponse), ) cache := NewInMemoryCache() purl, err := packageurl.FromString("pkg:npm/test-package@1.0.0") require.NoError(t, err) resp1, err := cache.GetPackageData(purl) assert.NoError(t, err) assert.NotNil(t, resp1) resp2, err := cache.GetPackageData(purl) assert.NoError(t, err) assert.NotNil(t, resp2) assert.Equal(t, resp1, resp2) callCount := httpmock.GetTotalCallCount() assert.Equal(t, 1, callCount) pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 1, pkgCacheSize) assert.Equal(t, 0, versionCacheSize) } func TestInMemoryCache_GetPackageVersionData(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() mockResponse := `{"number": "1.0.0", "licenses": "MIT"}` httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(200, mockResponse), ) cache := NewInMemoryCache() purl, err := packageurl.FromString("pkg:npm/test-package@1.0.0") require.NoError(t, err) resp1, err := cache.GetPackageVersionData(purl) assert.NoError(t, err) assert.NotNil(t, resp1) resp2, err := cache.GetPackageVersionData(purl) assert.NoError(t, err) assert.NotNil(t, resp2) assert.Equal(t, resp1, resp2) callCount := httpmock.GetTotalCallCount() assert.Equal(t, 1, callCount) pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 0, pkgCacheSize) assert.Equal(t, 1, versionCacheSize) } func TestInMemoryCache_DifferentPackages(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(200, `{}`), ) cache := NewInMemoryCache() purl1, err := packageurl.FromString("pkg:npm/package1@1.0.0") require.NoError(t, err) purl2, err := packageurl.FromString("pkg:npm/package2@1.0.0") require.NoError(t, err) _, err = cache.GetPackageData(purl1) assert.NoError(t, err) _, err = cache.GetPackageData(purl2) assert.NoError(t, err) callCount := httpmock.GetTotalCallCount() assert.Equal(t, 2, callCount) pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 2, pkgCacheSize) assert.Equal(t, 0, versionCacheSize) } func TestInMemoryCache_SamePackageDifferentVersions(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(200, `{}`), ) cache := NewInMemoryCache() purl1, err := packageurl.FromString("pkg:npm/package@1.0.0") require.NoError(t, err) purl2, err := packageurl.FromString("pkg:npm/package@2.0.0") require.NoError(t, err) _, err = cache.GetPackageData(purl1) assert.NoError(t, err) _, err = cache.GetPackageData(purl2) assert.NoError(t, err) // Different versions = different cache entries callCount := httpmock.GetTotalCallCount() assert.Equal(t, 2, callCount) pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 2, pkgCacheSize) assert.Equal(t, 0, versionCacheSize) } func TestInMemoryCache_APIError(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() // HTTP client returns a successful response even with 500 status // So we need to test that the client properly handles this case httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(500, `{"error": "internal server error"}`), ) cache := NewInMemoryCache() purl, err := packageurl.FromString("pkg:npm/test-package@1.0.0") require.NoError(t, err) // HTTP client doesn't treat 500 as error resp1, err := cache.GetPackageData(purl) assert.NoError(t, err) assert.Equal(t, 500, resp1.StatusCode()) resp2, err := cache.GetPackageData(purl) assert.NoError(t, err) assert.Equal(t, 500, resp2.StatusCode()) assert.Equal(t, resp1, resp2) // Second call used cache callCount := httpmock.GetTotalCallCount() assert.Equal(t, 1, callCount) pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 1, pkgCacheSize) assert.Equal(t, 0, versionCacheSize) } func TestInMemoryCache_404NotFound(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() // HTTP client returns a successful response even with 404 status // We want to cache 404 responses to avoid hammering the server httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(404, `{"error": "not found"}`), ) cache := NewInMemoryCache() purl, err := packageurl.FromString("pkg:golang/stdlib@1.0.0") require.NoError(t, err) // HTTP client doesn't treat 404 as error resp1, err := cache.GetPackageData(purl) assert.NoError(t, err) assert.Equal(t, 404, resp1.StatusCode()) resp2, err := cache.GetPackageData(purl) assert.NoError(t, err) assert.Equal(t, 404, resp2.StatusCode()) assert.Equal(t, resp1, resp2) // Second call should use cache - only 1 API call total callCount := httpmock.GetTotalCallCount() assert.Equal(t, 1, callCount, "Expected only 1 API call, but got %d. 404 responses should be cached.", callCount) pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 1, pkgCacheSize) assert.Equal(t, 0, versionCacheSize) } func TestInMemoryCache_404NotFoundVersionData(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() // Test that 404 responses are also cached for version data httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(404, `{"error": "not found"}`), ) cache := NewInMemoryCache() purl, err := packageurl.FromString("pkg:golang/stdlib@1.0.0") require.NoError(t, err) // HTTP client doesn't treat 404 as error resp1, err := cache.GetPackageVersionData(purl) assert.NoError(t, err) assert.Equal(t, 404, resp1.StatusCode()) resp2, err := cache.GetPackageVersionData(purl) assert.NoError(t, err) assert.Equal(t, 404, resp2.StatusCode()) assert.Equal(t, resp1, resp2) // Second call should use cache - only 1 API call total callCount := httpmock.GetTotalCallCount() assert.Equal(t, 1, callCount, "Expected only 1 API call, but got %d. 404 responses should be cached.", callCount) pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 0, pkgCacheSize) assert.Equal(t, 1, versionCacheSize) } func TestInMemoryCache_ConcurrentAccess(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(200, `{}`), ) cache := NewInMemoryCache() purl, err := packageurl.FromString("pkg:npm/test-package@1.0.0") require.NoError(t, err) var wg sync.WaitGroup numGoroutines := 100 for i := 0; i < numGoroutines; i++ { wg.Add(1) go func() { defer wg.Done() _, err := cache.GetPackageData(purl) assert.NoError(t, err) }() } wg.Wait() // Should only have one entry despite concurrent access pkgCacheSize, versionCacheSize := cache.GetCacheStats() assert.Equal(t, 1, pkgCacheSize) assert.Equal(t, 0, versionCacheSize) // API should have been called at least once, but should be much less than 100 due to caching // Can't guarantee exactly 1 call due to race conditions, but should be significantly less than numGoroutines callCount := httpmock.GetTotalCallCount() assert.True(t, callCount >= 1 && callCount < numGoroutines) } func TestGetGlobalCache_Singleton(t *testing.T) { // GetGlobalCache should return the same instance every time cache1 := GetGlobalCache() cache2 := GetGlobalCache() assert.Equal(t, cache1, cache2, "GetGlobalCache should return the same instance") } func TestGetGlobalCache_SharesDataAcrossEnrichments(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() // Reset global cache for this test globalCache = nil globalCacheOnce = sync.Once{} mockResponse := `{"error": "not found"}` httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(404, mockResponse), ) cache := GetGlobalCache() purl, err := packageurl.FromString("pkg:golang/stdlib@1.0.0") require.NoError(t, err) // First enrichment call resp1, err := cache.GetPackageData(purl) assert.NoError(t, err) assert.Equal(t, 404, resp1.StatusCode()) // Simulate a second enrichment by getting the global cache again cache2 := GetGlobalCache() resp2, err := cache2.GetPackageData(purl) assert.NoError(t, err) assert.Equal(t, 404, resp2.StatusCode()) // Should have only made 1 API call total, because the cache is shared callCount := httpmock.GetTotalCallCount() assert.Equal(t, 1, callCount, "Expected only 1 API call across enrichments, but got %d. Global cache should be shared.", callCount) } ================================================ FILE: lib/ecosystems/enrich.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( cdx "github.com/CycloneDX/cyclonedx-go" "github.com/rs/zerolog" "github.com/spdx/tools-golang/spdx" "github.com/snyk/parlay/lib/sbom" ) func EnrichSBOM(doc *sbom.SBOMDocument, logger *zerolog.Logger) *sbom.SBOMDocument { switch bom := doc.BOM.(type) { case *cdx.BOM: enrichCDX(bom, logger) case *spdx.Document: enrichSPDX(bom, logger) } return doc } ================================================ FILE: lib/ecosystems/enrich_cyclonedx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "net/url" "strings" "time" cdx "github.com/CycloneDX/cyclonedx-go" "github.com/package-url/packageurl-go" "github.com/remeh/sizedwaitgroup" "github.com/rs/zerolog" "github.com/snyk/parlay/ecosystems/packages" "github.com/snyk/parlay/internal/utils" ) type ( cdxPackageEnricher = func(*cdx.Component, *packages.Package) cdxPackageVersionEnricher = func(*cdx.Component, *packages.VersionWithDependencies, *packages.Package) ) var cdxPackageEnrichers = []cdxPackageEnricher{ enrichCDXDescription, enrichCDXHomepage, enrichCDXRegistryURL, enrichCDXRepositoryURL, enrichCDXDocumentationURL, enrichCDXFirstReleasePublishedAt, enrichCDXLatestReleasePublishedAt, enrichCDXRepoArchived, enrichCDXLocation, enrichCDXTopics, enrichCDXAuthor, enrichCDXSupplier, } var cdxPackageVersionEnrichers = []cdxPackageVersionEnricher{ enrichCDXLicense, } func enrichCDXDescription(comp *cdx.Component, data *packages.Package) { if data.Description != nil { comp.Description = *data.Description } } func enrichCDXLicense(comp *cdx.Component, pkgVersionData *packages.VersionWithDependencies, pkgData *packages.Package) { expression := utils.GetLicenseExpressionFromEcosystemsLicense(pkgVersionData, pkgData) if expression != "" { licenses := cdx.LicenseChoice{Expression: expression} comp.Licenses = &cdx.Licenses{licenses} } } func enrichExternalReference(comp *cdx.Component, ref *string, refType cdx.ExternalReferenceType) { if ref == nil { return } if _, err := url.Parse(*ref); err != nil { return } ext := cdx.ExternalReference{ URL: *ref, Type: refType, } if comp.ExternalReferences == nil { comp.ExternalReferences = &[]cdx.ExternalReference{ext} } else { *comp.ExternalReferences = append(*comp.ExternalReferences, ext) } } func enrichProperty(comp *cdx.Component, name string, value string) { prop := cdx.Property{ Name: name, Value: value, } if comp.Properties == nil { comp.Properties = &[]cdx.Property{prop} } else { *comp.Properties = append(*comp.Properties, prop) } } func enrichCDXHomepage(comp *cdx.Component, data *packages.Package) { enrichExternalReference(comp, data.Homepage, cdx.ERTypeWebsite) } func enrichCDXRegistryURL(comp *cdx.Component, data *packages.Package) { enrichExternalReference(comp, data.RegistryUrl, cdx.ERTypeDistribution) } func enrichCDXRepositoryURL(comp *cdx.Component, data *packages.Package) { enrichExternalReference(comp, data.RepositoryUrl, cdx.ERTypeVCS) } func enrichCDXDocumentationURL(comp *cdx.Component, data *packages.Package) { enrichExternalReference(comp, data.DocumentationUrl, cdx.ERTypeDocumentation) } func enrichCDXFirstReleasePublishedAt(comp *cdx.Component, data *packages.Package) { if data.FirstReleasePublishedAt == nil { return } timestamp := data.FirstReleasePublishedAt.UTC().Format(time.RFC3339) enrichProperty(comp, "ecosystems:first_release_published_at", timestamp) } func enrichCDXLatestReleasePublishedAt(comp *cdx.Component, data *packages.Package) { if data.LatestReleasePublishedAt == nil { return } timestamp := data.LatestReleasePublishedAt.UTC().Format(time.RFC3339) enrichProperty(comp, "ecosystems:latest_release_published_at", timestamp) } func enrichCDXRepoArchived(comp *cdx.Component, data *packages.Package) { if data.RepoMetadata != nil { if archived, ok := (*data.RepoMetadata)["archived"].(bool); ok && archived { enrichProperty(comp, "ecosystems:repository_archived", "true") } } } func enrichCDXLocation(comp *cdx.Component, data *packages.Package) { if data.RepoMetadata != nil { meta := *data.RepoMetadata if ownerRecord, ok := meta["owner_record"].(map[string]interface{}); ok { if location, ok := ownerRecord["location"].(string); ok { enrichProperty(comp, "ecosystems:owner_location", location) } } } } func enrichCDXAuthor(comp *cdx.Component, data *packages.Package) { if data.RepoMetadata != nil { meta := *data.RepoMetadata if ownerRecord, ok := meta["owner_record"].(map[string]interface{}); ok { if name, ok := ownerRecord["name"].(string); ok { comp.Author = name } } } } func enrichCDXSupplier(comp *cdx.Component, data *packages.Package) { if data.RepoMetadata != nil { meta := *data.RepoMetadata if ownerRecord, ok := meta["owner_record"].(map[string]interface{}); ok { if name, ok := ownerRecord["name"].(string); ok { supplier := cdx.OrganizationalEntity{ Name: name, } if website, ok := ownerRecord["website"].(string); ok { split := strings.Split(website, ", ") for i := range split { split[i] = strings.TrimSpace(split[i]) } supplier.URL = &split } comp.Supplier = &supplier } } } } func enrichCDXTopics(comp *cdx.Component, data *packages.Package) { if data.RepoMetadata != nil { meta := *data.RepoMetadata if topics, ok := meta["topics"].([]interface{}); ok { for _, topic := range topics { if s, ok := topic.(string); ok { enrichProperty(comp, "ecosystems:topic", s) } } } } } func enrichCDX(bom *cdx.BOM, logger *zerolog.Logger) { wg := sizedwaitgroup.New(20) cache := GetGlobalCache() comps := utils.DiscoverCDXComponents(bom) logger.Debug().Msgf("Detected %d packages", len(comps)) for i := range comps { wg.Add() go func(comp *cdx.Component) { defer wg.Done() l := logger.With().Str("bom-ref", comp.BOMRef).Logger() purl, err := packageurl.FromString(comp.PackageURL) if err != nil { l.Debug(). Err(err). Msg("Skipping package: no usable PackageURL") return } packageResp, err := cache.GetPackageData(purl) if err != nil { l.Debug(). Err(err). Msg("Skipping package: failed to get package data") return } if packageResp.JSON200 == nil { l.Debug(). Err(err). Msg("Skipping package: no data on ecosyste.ms response") return } for _, enrichFunc := range cdxPackageEnrichers { enrichFunc(comp, packageResp.JSON200) } packageVersionResp, err := cache.GetPackageVersionData(purl) if err != nil { l.Debug(). Err(err). Msg("Skipping package version enrichment: failed to get package version data") return } if packageVersionResp.JSON200 == nil { l.Debug(). Err(err). Msg("Skipping package version enrichment: no data on ecosyste.ms response") return } for _, enrichFunc := range cdxPackageVersionEnrichers { enrichFunc(comp, packageVersionResp.JSON200, packageResp.JSON200) } }(comps[i]) } wg.Wait() } ================================================ FILE: lib/ecosystems/enrich_cyclonedx_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "net/http" "testing" "time" cdx "github.com/CycloneDX/cyclonedx-go" "github.com/jarcoal/httpmock" "github.com/rs/zerolog" "github.com/stretchr/testify/assert" "github.com/snyk/parlay/ecosystems/packages" "github.com/snyk/parlay/lib/sbom" ) func TestEnrichSBOM_CycloneDX(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries/.*/packages/.*/versions`, func(r *http.Request) (*http.Response, error) { return httpmock.NewJsonResponse(200, map[string]interface{}{ // This is the license we expect to see for the specific package version "licenses": "MIT", }) }, ) httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, func(req *http.Request) (*http.Response, error) { return httpmock.NewJsonResponse(200, map[string]interface{}{ "description": "description", "normalized_licenses": []string{ // This license should be ignored as it corresponds to the latest version of the package "BSD-3-Clause", }, }) }) bom := &cdx.BOM{ Metadata: &cdx.Metadata{ Component: &cdx.Component{ BOMRef: "pkg:golang/github.com/ACME/Project@v1.0.0", Type: cdx.ComponentTypeApplication, Name: "Project", Version: "v1.0.0", PackageURL: "pkg:golang/github.com/ACME/Project@v1.0.0", }, }, Components: &[]cdx.Component{ { BOMRef: "pkg:golang/github.com/CycloneDX/cyclonedx-go@v0.3.0", Type: cdx.ComponentTypeLibrary, Name: "cyclonedx-go", Version: "v0.3.0", PackageURL: "pkg:golang/github.com/CycloneDX/cyclonedx-go@v0.3.0", }, }, } doc := &sbom.SBOMDocument{BOM: bom} logger := zerolog.Nop() EnrichSBOM(doc, &logger) components := *bom.Components component := components[0] licenses := *component.Licenses comp := cdx.LicenseChoice(cdx.LicenseChoice{Expression: "(MIT)"}) assert.Equal(t, "description", components[0].Description) assert.Equal(t, comp, licenses[0]) httpmock.GetTotalCallCount() calls := httpmock.GetCallCountInfo() assert.Equal(t, 2, calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) } func TestEnrichSBOM_CycloneDX_NestedComps(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, func(req *http.Request) (*http.Response, error) { return httpmock.NewJsonResponse(200, map[string]interface{}{}) }) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "@emotion/babel-plugin@11.11.0", Type: cdx.ComponentTypeLibrary, Name: "babel-plugin", Version: "v11.11.0", PackageURL: "pkg:npm/%40emotion/babel-plugin@11.11.0", Components: &[]cdx.Component{ { Type: cdx.ComponentTypeLibrary, Name: "convert-source-map", Version: "v1.9.0", BOMRef: "@emotion/babel-plugin@11.11.0|convert-source-map@1.9.0", PackageURL: "pkg:npm/convert-source-map@1.9.0", }, }, }, }, } doc := &sbom.SBOMDocument{BOM: bom} logger := zerolog.Nop() EnrichSBOM(doc, &logger) httpmock.GetTotalCallCount() calls := httpmock.GetCallCountInfo() assert.Equal(t, 4, calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) } func TestEnrichSBOMWithoutLicense(t *testing.T) { ResetGlobalCache() httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, func(req *http.Request) (*http.Response, error) { return httpmock.NewJsonResponse(200, map[string]interface{}{ "description": "description", "normalized_licenses": []string{}, }) }) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "pkg:golang/github.com/CycloneDX/cyclonedx-go@v0.3.0", Type: cdx.ComponentTypeLibrary, Name: "cyclonedx-go", Version: "v0.3.0", PackageURL: "pkg:golang/github.com/CycloneDX/cyclonedx-go@v0.3.0", }, }, } doc := &sbom.SBOMDocument{BOM: bom} logger := zerolog.Nop() EnrichSBOM(doc, &logger) components := *bom.Components assert.Equal(t, "description", components[0].Description) httpmock.GetTotalCallCount() calls := httpmock.GetCallCountInfo() assert.Equal(t, 2*len(components), calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) } func TestEnrichDescription(t *testing.T) { component := &cdx.Component{ Type: cdx.ComponentTypeLibrary, Name: "cyclonedx-go", Version: "v0.3.0", } desc := "description" pack := &packages.Package{ Description: &desc, } enrichCDXDescription(component, pack) assert.Equal(t, "description", component.Description) } func TestEnrichLicense(t *testing.T) { component := &cdx.Component{ Type: cdx.ComponentTypeLibrary, Name: "cyclonedx-go", Version: "v0.3.0", } versionedLicenses := "BSD-3-Clause" pkgVersionData := &packages.VersionWithDependencies{Licenses: &versionedLicenses} latestLicenses := []string{"Apache-2.0"} pkgData := &packages.Package{NormalizedLicenses: latestLicenses} enrichCDXLicense(component, pkgVersionData, pkgData) licenses := *component.Licenses comp := cdx.LicenseChoice(cdx.LicenseChoice{Expression: "(BSD-3-Clause)"}) assert.Equal(t, 1, len(licenses)) assert.Equal(t, comp, licenses[0]) } func TestEnrichLicenseNoVersionedLicense(t *testing.T) { component := &cdx.Component{ Type: cdx.ComponentTypeLibrary, Name: "cyclonedx-go", Version: "v0.3.0", } versionedLicenses := "" pkgVersionData := &packages.VersionWithDependencies{Licenses: &versionedLicenses} latestLicenses := []string{"Apache-2.0"} pkgData := &packages.Package{NormalizedLicenses: latestLicenses} enrichCDXLicense(component, pkgVersionData, pkgData) licenses := *component.Licenses comp := cdx.LicenseChoice(cdx.LicenseChoice{Expression: "(Apache-2.0)"}) assert.Equal(t, 1, len(licenses)) assert.Equal(t, comp, licenses[0]) } func TestEnrichLicenseNoLatestLicense(t *testing.T) { component := &cdx.Component{ Type: cdx.ComponentTypeLibrary, Name: "cyclonedx-go", Version: "v0.3.0", } versionedLicenses := "BSD-3-Clause" pkgVersionData := &packages.VersionWithDependencies{Licenses: &versionedLicenses} latestLicenses := []string{""} pkgData := &packages.Package{NormalizedLicenses: latestLicenses} enrichCDXLicense(component, pkgVersionData, pkgData) licenses := *component.Licenses comp := cdx.LicenseChoice(cdx.LicenseChoice{Expression: "(BSD-3-Clause)"}) assert.Equal(t, 1, len(licenses)) assert.Equal(t, comp, licenses[0]) } func TestEnrichBlankSBOM(t *testing.T) { bom := new(cdx.BOM) doc := &sbom.SBOMDocument{BOM: bom} logger := zerolog.Nop() EnrichSBOM(doc, &logger) assert.Nil(t, bom.Components) } func TestEnrichExternalReferenceWithNilURL(t *testing.T) { component := &cdx.Component{} packageData := &packages.Package{Homepage: nil} enrichExternalReference(component, packageData.Homepage, cdx.ERTypeWebsite) assert.Nil(t, component.ExternalReferences) } func TestEnrichExternalReferenceWithNonNullURL(t *testing.T) { component := &cdx.Component{} packageData := packages.Package{Homepage: pointerToString(t, "https://example.com")} enrichExternalReference(component, packageData.Homepage, cdx.ERTypeWebsite) expected := &[]cdx.ExternalReference{ {URL: "https://example.com", Type: cdx.ERTypeWebsite}, } assert.Equal(t, expected, component.ExternalReferences) } func TestEnrichHomepageWithNilHomepage(t *testing.T) { component := &cdx.Component{} packageData := &packages.Package{Homepage: nil} enrichCDXHomepage(component, packageData) assert.Nil(t, component.ExternalReferences) } func TestEnrichHomepageWithNonNullHomepage(t *testing.T) { component := &cdx.Component{} packageData := &packages.Package{Homepage: pointerToString(t, "https://example.com")} enrichCDXHomepage(component, packageData) expected := &[]cdx.ExternalReference{ {URL: "https://example.com", Type: cdx.ERTypeWebsite}, } assert.Equal(t, expected, component.ExternalReferences) } func TestEnrichRegistryURLWithNilRegistryURL(t *testing.T) { component := &cdx.Component{} packageData := &packages.Package{RegistryUrl: nil} enrichCDXRegistryURL(component, packageData) assert.Nil(t, component.ExternalReferences) } func TestEnrichRegistryURLWithNonNullRegistryURL(t *testing.T) { component := &cdx.Component{} packageData := &packages.Package{RegistryUrl: pointerToString(t, "https://example.com")} enrichCDXRegistryURL(component, packageData) expected := &[]cdx.ExternalReference{ {URL: "https://example.com", Type: cdx.ERTypeDistribution}, } assert.Equal(t, expected, component.ExternalReferences) } func pointerToString(t *testing.T, s string) *string { t.Helper() return &s } func TestEnrichLatestReleasePublishedAt(t *testing.T) { component := &cdx.Component{} packageData := &packages.Package{ LatestReleasePublishedAt: nil, } enrichCDXLatestReleasePublishedAt(component, packageData) assert.Nil(t, component.Properties) latestReleasePublishedAt := time.Date(2023, time.May, 1, 0, 0, 0, 0, time.UTC) packageData.LatestReleasePublishedAt = &latestReleasePublishedAt expectedTimestamp := latestReleasePublishedAt.UTC().Format(time.RFC3339) enrichCDXLatestReleasePublishedAt(component, packageData) assert.Len(t, *component.Properties, 1) prop := (*component.Properties)[0] assert.Equal(t, "ecosystems:latest_release_published_at", prop.Name) assert.Equal(t, expectedTimestamp, prop.Value) } func TestEnrichLocation(t *testing.T) { assert := assert.New(t) // Test case 1: packageData.RepoMetadata is nil component := &cdx.Component{Name: "test"} packageData := &packages.Package{} enrichCDXLocation(component, packageData) assert.Nil(component.Properties) // Test case 2: packageData.RepoMetadata is not nil, but "owner_record" is missing component = &cdx.Component{Name: "test"} packageData = &packages.Package{RepoMetadata: &map[string]interface{}{ "not_owner_record": map[string]interface{}{}, }} enrichCDXLocation(component, packageData) assert.Nil(component.Properties) // Test case 3: "location" field is missing in "owner_record" component = &cdx.Component{Name: "test"} packageData = &packages.Package{RepoMetadata: &map[string]interface{}{ "owner_record": map[string]interface{}{ "not_location": "test", }, }} enrichCDXLocation(component, packageData) assert.Nil(component.Properties) // Test case 4: "location" field is present in "owner_record" component = &cdx.Component{Name: "test"} packageData = &packages.Package{RepoMetadata: &map[string]interface{}{ "owner_record": map[string]interface{}{ "location": "test_location", }, }} enrichCDXLocation(component, packageData) assert.Equal(&[]cdx.Property{ {Name: "ecosystems:owner_location", Value: "test_location"}, }, component.Properties) } ================================================ FILE: lib/ecosystems/enrich_spdx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "errors" "strings" "github.com/package-url/packageurl-go" "github.com/rs/zerolog" "github.com/spdx/tools-golang/spdx" "github.com/spdx/tools-golang/spdx/v2/common" "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/snyk/parlay/ecosystems/packages" "github.com/snyk/parlay/internal/utils" ) func enrichSPDX(bom *spdx.Document, logger *zerolog.Logger) { packages := bom.Packages logger.Debug().Msgf("Detected %d packages", len(packages)) cache := GetGlobalCache() for _, pkg := range packages { purl, err := extractPurl(pkg) if err != nil { continue } packageResp, err := cache.GetPackageData(*purl) if err != nil { continue } pkgData := packageResp.JSON200 if pkgData == nil { continue } enrichSPDXDescription(pkg, pkgData) enrichSPDXHomepage(pkg, pkgData) enrichSPDXSupplier(pkg, pkgData) packageVersionResp, err := cache.GetPackageVersionData(*purl) if err != nil { continue } pkgVersionData := packageVersionResp.JSON200 if pkgVersionData == nil { continue } enrichSPDXLicense(pkg, pkgVersionData, pkgData) } } func extractPurl(pkg *v2_3.Package) (*packageurl.PackageURL, error) { for _, ref := range pkg.PackageExternalReferences { if ref.RefType != "purl" { continue } purl, err := packageurl.FromString(ref.Locator) if err != nil { return nil, err } return &purl, nil } return nil, errors.New("no purl found on SPDX package") } func enrichSPDXSupplier(pkg *v2_3.Package, data *packages.Package) { if data.RepoMetadata != nil { meta := *data.RepoMetadata if ownerRecord, ok := meta["owner_record"].(map[string]interface{}); ok { if name, ok := ownerRecord["name"].(string); ok && name != "" { pkg.PackageSupplier = &common.Supplier{ SupplierType: "Organization", Supplier: name, } } } } } func enrichSPDXLicense(pkg *v2_3.Package, pkgVersionData *packages.VersionWithDependencies, pkgData *packages.Package) { licenses := utils.GetLicensesFromEcosystemsLicense(pkgVersionData, pkgData) if len(licenses) > 0 { pkg.PackageLicenseConcluded = strings.Join(licenses, ",") } } func enrichSPDXHomepage(pkg *v2_3.Package, data *packages.Package) { if data.Homepage == nil { return } pkg.PackageHomePage = *data.Homepage } func enrichSPDXDescription(pkg *v2_3.Package, data *packages.Package) { if data.Description == nil { return } pkg.PackageDescription = *data.Description } ================================================ FILE: lib/ecosystems/enrich_spdx_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "bytes" "encoding/json" "net/http" "testing" "github.com/jarcoal/httpmock" "github.com/rs/zerolog" "github.com/spdx/tools-golang/spdx/v2/common" "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "github.com/snyk/parlay/lib/sbom" ) func parseJson(t *testing.T, jsonStr string) map[string]any { t.Helper() var result map[string]any require.NoError(t, json.Unmarshal([]byte(jsonStr), &result)) return result } func setupHttpmock(t *testing.T, packageVersionsResponse, packageResponse *string) { t.Helper() httpmock.Activate() if packageVersionsResponse != nil { httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries/.*/packages/.*/versions`, func(r *http.Request) (*http.Response, error) { return httpmock.NewJsonResponse(200, parseJson(t, *packageVersionsResponse)) }, ) } if packageResponse != nil { httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, func(req *http.Request) (*http.Response, error) { return httpmock.NewJsonResponse(200, parseJson(t, *packageResponse)) }) } } func TestEnrichSBOM_SPDX(t *testing.T) { packageVersionResponse := `{ "licenses": "MIT" }` packageResponse := `{ "description": "description", "normalized_licenses": ["BSD-3-Clause"], "homepage": "https://github.com/spdx/tools-golang", "repo_metadata": { "owner_record": { "name": "Acme Corp" } } }` setupHttpmock(t, &packageVersionResponse, &packageResponse) defer httpmock.DeactivateAndReset() doc, err := sbom.DecodeSBOMDocument([]byte(`{"spdxVersion":"SPDX-2.3","SPDXID":"SPDXRef-DOCUMENT"}`)) require.NoError(t, err) bom, ok := doc.BOM.(*v2_3.Document) require.True(t, ok) bom.Packages = []*v2_3.Package{ { PackageSPDXIdentifier: "pkg:golang/github.com/spdx/tools-golang@v0.5.2", PackageName: "github.com/spdx/tools-golang", PackageVersion: "v0.5.2", PackageExternalReferences: []*v2_3.PackageExternalReference{ { Category: common.CategoryPackageManager, RefType: "purl", Locator: "pkg:golang/github.com/spdx/tools-golang@v0.5.2", }, }, }, } logger := zerolog.Nop() EnrichSBOM(doc, &logger) pkgs := bom.Packages assert.Equal(t, "description", pkgs[0].PackageDescription) assert.Equal(t, "MIT", pkgs[0].PackageLicenseConcluded) assert.Equal(t, "https://github.com/spdx/tools-golang", pkgs[0].PackageHomePage) assert.Equal(t, "Organization", pkgs[0].PackageSupplier.SupplierType) assert.Equal(t, "Acme Corp", pkgs[0].PackageSupplier.Supplier) httpmock.GetTotalCallCount() calls := httpmock.GetCallCountInfo() assert.Equal(t, len(pkgs), calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) buf := bytes.NewBuffer(nil) require.NoError(t, doc.Encode(buf)) } func TestEnrichSBOM_MissingVersionedLicense(t *testing.T) { ResetGlobalCache() packageVersionResponse := `{ "licenses": "" }` packageResponse := `{ "description": "description", "normalized_licenses": ["BSD-3-Clause", "Apache-2.0"], "homepage": "https://github.com/spdx/tools-golang", "repo_metadata": { "owner_record": { "name": "Acme Corp" } } }` setupHttpmock(t, &packageVersionResponse, &packageResponse) defer httpmock.DeactivateAndReset() doc, err := sbom.DecodeSBOMDocument([]byte(`{"spdxVersion":"SPDX-2.3","SPDXID":"SPDXRef-DOCUMENT"}`)) require.NoError(t, err) bom, ok := doc.BOM.(*v2_3.Document) require.True(t, ok) bom.Packages = []*v2_3.Package{ { PackageSPDXIdentifier: "pkg:golang/github.com/spdx/tools-golang@v0.5.2", PackageName: "github.com/spdx/tools-golang", PackageVersion: "v0.5.2", PackageExternalReferences: []*v2_3.PackageExternalReference{ { Category: common.CategoryPackageManager, RefType: "purl", Locator: "pkg:golang/github.com/spdx/tools-golang@v0.5.2", }, }, }, } logger := zerolog.Nop() EnrichSBOM(doc, &logger) pkgs := bom.Packages assert.Equal(t, "description", pkgs[0].PackageDescription) assert.Equal(t, "BSD-3-Clause,Apache-2.0", pkgs[0].PackageLicenseConcluded) assert.Equal(t, "https://github.com/spdx/tools-golang", pkgs[0].PackageHomePage) assert.Equal(t, "Organization", pkgs[0].PackageSupplier.SupplierType) assert.Equal(t, "Acme Corp", pkgs[0].PackageSupplier.Supplier) httpmock.GetTotalCallCount() calls := httpmock.GetCallCountInfo() assert.Equal(t, len(pkgs), calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) buf := bytes.NewBuffer(nil) require.NoError(t, doc.Encode(buf)) } func TestEnrichSBOM_SPDX_NoSupplierName(t *testing.T) { packageResponse := `{ "description": "description", "normalized_licenses": ["BSD-3-Clause"], "homepage": "https://github.com/spdx/tools-golang", "repo_metadata": { "owner_record": { "name": "" } } }` setupHttpmock(t, nil, &packageResponse) defer httpmock.DeactivateAndReset() doc, err := sbom.DecodeSBOMDocument([]byte(`{"spdxVersion":"SPDX-2.3","SPDXID":"SPDXRef-DOCUMENT"}`)) require.NoError(t, err) bom, ok := doc.BOM.(*v2_3.Document) require.True(t, ok) bom.Packages = []*v2_3.Package{ { PackageSPDXIdentifier: "pkg:golang/github.com/spdx/tools-golang@v0.5.2", PackageName: "github.com/spdx/tools-golang", PackageVersion: "v0.5.2", PackageExternalReferences: []*v2_3.PackageExternalReference{ { Category: common.CategoryPackageManager, RefType: "purl", Locator: "pkg:golang/github.com/spdx/tools-golang@v0.5.2", }, }, }, } logger := zerolog.Nop() EnrichSBOM(doc, &logger) buf := bytes.NewBuffer(nil) require.NoError(t, doc.Encode(buf)) } ================================================ FILE: lib/ecosystems/package.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "context" "fmt" "net/http" "net/url" "github.com/package-url/packageurl-go" "github.com/snyk/parlay/ecosystems/packages" ) const server = "https://packages.ecosyste.ms/api/v1" // Version will be set by the build process var Version = "dev" func getUserAgent() string { return fmt.Sprintf("parlay (%s)", Version) } func GetPackageData(purl packageurl.PackageURL) (*packages.GetRegistryPackageResponse, error) { client, err := packages.NewClientWithResponses(server, packages.WithRequestEditorFn(func(ctx context.Context, req *http.Request) error { req.Header.Set("User-Agent", getUserAgent()) return nil })) if err != nil { return nil, err } name := purlToEcosystemsName(purl) registry := purlToEcosystemsRegistry(purl) resp, err := client.GetRegistryPackageWithResponse(context.Background(), registry, name) if err != nil { return nil, err } return resp, nil } func GetPackageVersionData(purl packageurl.PackageURL) (*packages.GetRegistryPackageVersionResponse, error) { client, err := packages.NewClientWithResponses(server, packages.WithRequestEditorFn(func(ctx context.Context, req *http.Request) error { req.Header.Set("User-Agent", getUserAgent()) return nil })) if err != nil { return nil, err } name := purlToEcosystemsName(purl) registry := purlToEcosystemsRegistry(purl) resp, err := client.GetRegistryPackageVersionWithResponse(context.Background(), registry, name, purl.Version) if err != nil { return nil, err } return resp, nil } func repositoryURLfromPurl(purl packageurl.PackageURL) *url.URL { if len(purl.Qualifiers) > 0 { qualifiersMap := purl.Qualifiers.Map() if repoURL, ok := qualifiersMap["repository_url"]; ok && repoURL != "" { parsedURL, err := url.Parse(repoURL) if err == nil && parsedURL.Host != "" { return parsedURL } } } return nil } func purlToEcosystemsRegistry(purl packageurl.PackageURL) string { if repoURL := repositoryURLfromPurl(purl); repoURL != nil { return repoURL.Host } return map[string]string{ packageurl.TypeApk: "alpine-edge", packageurl.TypeBower: "bower.io", packageurl.TypeBrew: "formulae.brew.sh", packageurl.TypeCargo: "crates.io", packageurl.TypeCarthage: "carthage", packageurl.TypeClojars: "clojars.org", packageurl.TypeCocoapods: "cocoapods.org", packageurl.TypeComposer: "packagist.org", packageurl.TypeConda: "anaconda.org", packageurl.TypeCpan: "metacpan.org", packageurl.TypeCran: "cran.r-project.org", packageurl.TypeDocker: "hub.docker.com", packageurl.TypeElm: "package.elm-lang.org", packageurl.TypeGem: "rubygems.org", packageurl.TypeGolang: "proxy.golang.org", packageurl.TypeHackage: "hackage.haskell.org", packageurl.TypeHex: "hex.pm", packageurl.TypeJulia: "juliahub.com", packageurl.TypeMaven: "repo1.maven.org", packageurl.TypeNPM: "npmjs.org", packageurl.TypeNuget: "nuget.org", packageurl.TypePub: "pub.dev", packageurl.TypePuppet: "forge.puppet.com", packageurl.TypePyPi: "pypi.org", packageurl.TypeSwift: "swiftpackageindex.com", }[purl.Type] } func purlToEcosystemsName(purl packageurl.PackageURL) string { name := purl.Name if purl.Namespace == "" { return name } switch purl.Type { // Most ecosystems require the package to be identified by the namespace // and name separated by a forward slash "/". default: name = fmt.Sprintf("%s/%s", purl.Namespace, purl.Name) // ecosyste.ms maven requires the group ID and artifact ID to be separated // by a colon ":", case packageurl.TypeMaven: name = fmt.Sprintf("%s:%s", purl.Namespace, purl.Name) // apk packages are only used by alpine, so the namespace isn't used in the // package name for the ecosyste.ms API case packageurl.TypeApk: break } return name } ================================================ FILE: lib/ecosystems/package_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "fmt" "net/http" "testing" "github.com/jarcoal/httpmock" "github.com/package-url/packageurl-go" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func TestGetPackageData(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewBytesResponder(200, []byte{}), ) purl, err := packageurl.FromString("pkg:maven/org.springframework.boot/spring-boot-starter-jdb") require.NoError(t, err) _, err = GetPackageData(purl) require.NoError(t, err) httpmock.GetTotalCallCount() calls := httpmock.GetCallCountInfo() assert.Equal(t, 1, calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) } func TestGetPackageDataUserAgent(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() var capturedUserAgent string httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, func(req *http.Request) (*http.Response, error) { capturedUserAgent = req.Header.Get("User-Agent") return httpmock.NewBytesResponse(200, []byte{}), nil }, ) purl, err := packageurl.FromString("pkg:npm/lodash@4.17.21") require.NoError(t, err) _, err = GetPackageData(purl) require.NoError(t, err) expectedUserAgent := fmt.Sprintf("parlay (%s)", Version) assert.Equal(t, expectedUserAgent, capturedUserAgent) // Verify it contains "parlay" and the version in parentheses assert.Contains(t, capturedUserAgent, "parlay") assert.Contains(t, capturedUserAgent, "(") assert.Contains(t, capturedUserAgent, ")") } func TestGetPackageVersionDataUserAgent(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() var capturedUserAgent string httpmock.RegisterResponder( "GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, func(req *http.Request) (*http.Response, error) { capturedUserAgent = req.Header.Get("User-Agent") return httpmock.NewBytesResponse(200, []byte{}), nil }, ) purl, err := packageurl.FromString("pkg:npm/lodash@4.17.21") require.NoError(t, err) _, err = GetPackageVersionData(purl) require.NoError(t, err) assert.Equal(t, fmt.Sprintf("parlay (%s)", Version), capturedUserAgent) } func TestPurlToEcosystemsRegistry(t *testing.T) { testCases := []struct { purlStr string expected string }{ {"pkg:npm/lodash@4.17.21", "npmjs.org"}, {"pkg:golang/github.com/golang/example/hello?go-get=1", "proxy.golang.org"}, {"pkg:nuget/Microsoft.AspNetCore.Http.Abstractions@2.2.0", "nuget.org"}, {"pkg:hex/plug@1.11.0", "hex.pm"}, {"pkg:maven/com.google.guava/guava@28.2-jre", "repo1.maven.org"}, {"pkg:maven/org.opensaml/opensaml-saml-api@4.3.2?repository_url=https%3A%2F%2Fbuild.shibboleth.net%2Fnexus%2Fcontent%2Frepositories%2Freleases%2F", "build.shibboleth.net"}, {"pkg:pypi/Django@2.2.7", "pypi.org"}, {"pkg:composer/symfony/http-foundation@5.3.0", "packagist.org"}, {"pkg:gem/rspec-core@3.10.1", "rubygems.org"}, {"pkg:cargo/rand@0.8.4", "crates.io"}, {"pkg:cocoapods/Firebase@7.0.0", "cocoapods.org"}, {"pkg:apk/alpine/curl@7.79.1-r0", "alpine-edge"}, {"pkg:swift/github.com/yonaskolb/XcodeGen@2.34.0", "swiftpackageindex.com"}, {"pkg:docker/library%2Falpine", "hub.docker.com"}, {"pkg:bower/jquery@3.6.0", "bower.io"}, {"pkg:brew/wget@1.21.3", "formulae.brew.sh"}, {"pkg:carthage/Alamofire/Alamofire@5.6.4", "carthage"}, {"pkg:clojars/ring/ring-core@1.9.5", "clojars.org"}, {"pkg:conda/numpy@1.23.5", "anaconda.org"}, {"pkg:cpan/DBI@1.643", "metacpan.org"}, {"pkg:cran/ggplot2@3.4.0", "cran.r-project.org"}, {"pkg:elm/elm/core@1.0.5", "package.elm-lang.org"}, {"pkg:hackage/aeson@2.1.0.0", "hackage.haskell.org"}, {"pkg:julia/Example@0.5.3", "juliahub.com"}, {"pkg:pub/http@0.13.5", "pub.dev"}, {"pkg:puppet/puppetlabs/stdlib@8.5.0", "forge.puppet.com"}, } for _, tc := range testCases { purl, err := packageurl.FromString(tc.purlStr) if err != nil { t.Errorf("Error creating PackageURL: %v", err) } got := purlToEcosystemsRegistry(purl) if got != tc.expected { t.Errorf("purlToEcosystemsRegistry(%q) = %q; expected %q", tc.purlStr, got, tc.expected) } } } func TestPurlToEcosystemsName(t *testing.T) { testCases := []struct { purlStr string expectedName string }{ { // Test case 1: When the package manager type is "npm" // and the namespace is not empty, the function should return // a url encoded string in the form of "/" purlStr: "pkg:npm/%40my-namespace/my-package", expectedName: "@my-namespace/my-package", }, { // Test case 2: When the package manager type is "npm" // and the namespace is empty, the function should return // the package name as is. purlStr: "pkg:npm/my-package", expectedName: "my-package", }, { // Test case 3: When the package manager type is "maven" // and the namespace is not empty, the function should return // a string in the form of ":" purlStr: "pkg:maven/my-group:my-artifact", expectedName: "my-group:my-artifact", }, { // Test case 4: When the package manager type is "maven" // and the namespace is empty, the function should return // the package name as is. purlStr: "pkg:maven/my-artifact", expectedName: "my-artifact", }, { // Test case 5: When the package manager type is "golang" // and the namespace is not empty, the function should return // a string in the form of "/" purlStr: "pkg:golang/example.com/foo/bar@v1.5.0", expectedName: "example.com/foo/bar", }, { // Test case 6: When the package manager type is "golang" // and the namespace has lots of weird characters, make sure // they get filtered properly purlStr: "pkg:golang/example.com/f.o_o/ba~r", expectedName: "example.com/f.o_o/ba~r", }, { // Test case 7: When the package manager type is "swift" purlStr: "pkg:swift/github.com/yonaskolb/XcodeGen@1", expectedName: "github.com/yonaskolb/XcodeGen", }, { // Test case 8: When the package manager type is "apk" purlStr: "pkg:apk/alpine/lf@30-r3", expectedName: "lf", }, } for _, testCase := range testCases { t.Run(fmt.Sprintf("Test %v", testCase.purlStr), func(t *testing.T) { purl, err := packageurl.FromString(testCase.purlStr) if err != nil { t.Fatalf("Failed to create PackageURL: %v", err) } result := purlToEcosystemsName(purl) if result != testCase.expectedName { t.Errorf("Expected %q, but got %q", testCase.expectedName, result) } }) } } ================================================ FILE: lib/ecosystems/repo.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "context" "net/http" "github.com/snyk/parlay/ecosystems/repos" ) const repos_server = "https://repos.ecosyste.ms/api/v1" func GetRepoData(url string) (*repos.RepositoriesLookupResponse, error) { client, err := repos.NewClientWithResponses(repos_server, repos.WithRequestEditorFn(func(ctx context.Context, req *http.Request) error { req.Header.Set("User-Agent", getUserAgent()) return nil })) if err != nil { return nil, err } params := repos.RepositoriesLookupParams{Url: &url} resp, err := client.RepositoriesLookupWithResponse(context.Background(), ¶ms) if err != nil { return nil, err } return resp, nil } ================================================ FILE: lib/ecosystems/repo_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package ecosystems import ( "fmt" "net/http" "testing" "github.com/jarcoal/httpmock" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func TestGetRepoData(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder( "GET", "https://repos.ecosyste.ms/api/v1/repositories/lookup", httpmock.NewBytesResponder(200, []byte{}), ) _, err := GetRepoData("https://github.com/golang/go") require.NoError(t, err) httpmock.GetTotalCallCount() calls := httpmock.GetCallCountInfo() assert.Equal(t, 1, calls["GET https://repos.ecosyste.ms/api/v1/repositories/lookup"]) } func TestGetRepoDataUserAgent(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() var capturedUserAgent string httpmock.RegisterResponder( "GET", "https://repos.ecosyste.ms/api/v1/repositories/lookup", func(req *http.Request) (*http.Response, error) { capturedUserAgent = req.Header.Get("User-Agent") return httpmock.NewBytesResponse(200, []byte{}), nil }, ) _, err := GetRepoData("https://github.com/golang/go") require.NoError(t, err) assert.Equal(t, fmt.Sprintf("parlay (%s)", Version), capturedUserAgent) } ================================================ FILE: lib/sbom/cyclonedx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package sbom import ( "bytes" "io" cdx "github.com/CycloneDX/cyclonedx-go" ) func decodeCycloneDX1_4JSON(b []byte) (*cdx.BOM, error) { return decodeCycloneDX(b, cdx.BOMFileFormatJSON) } func decodeCycloneDX1_4XML(b []byte) (*cdx.BOM, error) { return decodeCycloneDX(b, cdx.BOMFileFormatXML) } func decodeCycloneDX(b []byte, f cdx.BOMFileFormat) (*cdx.BOM, error) { bom := new(cdx.BOM) decoder := cdx.NewBOMDecoder(bytes.NewReader(b), f) if err := decoder.Decode(bom); err != nil { return nil, err } return bom, nil } func encodeCycloneDX1_4JSON(bom *cdx.BOM) encoderFn { return encodeCycloneDX(bom, cdx.BOMFileFormatJSON) } func encodeCycloneDX1_4XML(bom *cdx.BOM) encoderFn { return encodeCycloneDX(bom, cdx.BOMFileFormatXML) } func encodeCycloneDX(bom *cdx.BOM, f cdx.BOMFileFormat) encoderFn { return func(w io.Writer) error { return cdx.NewBOMEncoder(w, f).Encode(bom) } } ================================================ FILE: lib/sbom/decode.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package sbom import ( "bytes" "errors" "fmt" ) func DecodeSBOMDocument(b []byte) (*SBOMDocument, error) { doc := new(SBOMDocument) format, err := identifySBOMFormat(b) if err != nil { return nil, err } doc.Format = format switch doc.Format { case SBOMFormatCycloneDX1_4JSON: bom, err := decodeCycloneDX1_4JSON(b) if err != nil { return nil, fmt.Errorf("could not decode input: %w", err) } doc.BOM = bom doc.encode = encodeCycloneDX1_4JSON(bom) case SBOMFormatCycloneDX1_4XML: bom, err := decodeCycloneDX1_4XML(b) if err != nil { return nil, fmt.Errorf("could not decode input: %w", err) } doc.BOM = bom doc.encode = encodeCycloneDX1_4XML(bom) case SBOMFormatSPDX2_3JSON: bom, err := decodeSPDX2_3JSON(b) if err != nil { return nil, fmt.Errorf("could not decode input: %w", err) } doc.BOM = bom doc.encode = encodeSPDX2_3JSON(bom) default: return nil, fmt.Errorf("no decoder for format %s", doc.Format) } return doc, nil } func identifySBOMFormat(b []byte) (SBOMFormat, error) { if bytes.Contains(b, []byte("bomFormat")) && bytes.Contains(b, []byte("CycloneDX")) { return SBOMFormatCycloneDX1_4JSON, nil } if bytes.Contains(b, []byte("xmlns")) && bytes.Contains(b, []byte("cyclonedx")) { return SBOMFormatCycloneDX1_4XML, nil } if bytes.Contains(b, []byte("SPDX-2.3")) && bytes.Contains(b, []byte("SPDXRef-DOCUMENT")) { return SBOMFormatSPDX2_3JSON, nil } return "", errors.New("could not identify SBOM format") } ================================================ FILE: lib/sbom/decode_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package sbom import ( "testing" "github.com/CycloneDX/cyclonedx-go" "github.com/spdx/tools-golang/spdx" spdx_2_3 "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) var ( fixedCycloneDX1_4JSON = []byte(`{"bomFormat":"CycloneDX","specVersion":"1.4","version":1}`) fixedCycloneDX1_4XML = []byte(``) fixedSPDX2_3JSON = []byte(`{"SPDXID":"SPDXRef-DOCUMENT","spdxVersion":"SPDX-2.3"}`) fixedSPDX2_2JSON = []byte(`{"SPDXID":"SPDXRef-DOCUMENT","spdxVersion":"SPDX-2.2"}`) ) func TestDecodeSBOMDocument_CycloneDX1_4JSON(t *testing.T) { doc, err := DecodeSBOMDocument(fixedCycloneDX1_4JSON) require.NoError(t, err) bom, ok := doc.BOM.(*cyclonedx.BOM) require.True(t, ok) assert.Equal(t, SBOMFormatCycloneDX1_4JSON, doc.Format) assert.NotNil(t, doc.Encode) assert.Equal(t, cyclonedx.SpecVersion1_4, bom.SpecVersion) } func TestDecodeSBOMDocument_CycloneDX1_4XML(t *testing.T) { doc, err := DecodeSBOMDocument(fixedCycloneDX1_4XML) require.NoError(t, err) bom, ok := doc.BOM.(*cyclonedx.BOM) require.True(t, ok) assert.Equal(t, SBOMFormatCycloneDX1_4XML, doc.Format) assert.NotNil(t, doc.Encode) assert.Equal(t, cyclonedx.SpecVersion1_4, bom.SpecVersion) } func TestDecodeSBOMDocument_SPDX2_3JSON(t *testing.T) { doc, err := DecodeSBOMDocument(fixedSPDX2_3JSON) require.NoError(t, err) bom, ok := doc.BOM.(*spdx.Document) require.True(t, ok) assert.Equal(t, SBOMFormatSPDX2_3JSON, doc.Format) assert.NotNil(t, doc.Encode) assert.Equal(t, spdx_2_3.Version, bom.SPDXVersion) } func TestDecodeSBOMDocument_Unknown(t *testing.T) { doc, err := DecodeSBOMDocument(fixedSPDX2_2JSON) assert.ErrorContains(t, err, "could not identify SBOM format") assert.Nil(t, doc) } func Test_identifySBOMFormat(t *testing.T) { tc := map[string]struct { input []byte format string err string }{ "CycloneDX 1.4 JSON": { input: fixedCycloneDX1_4JSON, format: "CycloneDX 1.4 JSON", err: "", }, "CycloneDX 1.4 XML": { input: fixedCycloneDX1_4XML, format: "CycloneDX 1.4 XML", err: "", }, "Unknown format": { input: fixedSPDX2_2JSON, format: "", err: "could not identify SBOM format", }, } for name, tt := range tc { t.Run(name, func(t *testing.T) { format, err := identifySBOMFormat(tt.input) if err != nil { assert.ErrorContains(t, err, tt.err) } assert.Equal(t, tt.format, string(format)) }) } } ================================================ FILE: lib/sbom/encode.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package sbom import "io" type ( SBOMEncoder interface { Encode(w io.Writer) error } encoderFn func(io.Writer) error ) ================================================ FILE: lib/sbom/format.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package sbom type SBOMFormat string const ( SBOMFormatCycloneDX1_4JSON = SBOMFormat("CycloneDX 1.4 JSON") SBOMFormatCycloneDX1_4XML = SBOMFormat("CycloneDX 1.4 XML") SBOMFormatSPDX2_3JSON = SBOMFormat("SPDX 2.3 JSON") ) ================================================ FILE: lib/sbom/sbom.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package sbom import ( "fmt" "io" ) type SBOMDocument struct { BOM interface{} Format SBOMFormat encode encoderFn } var _ SBOMEncoder = (*SBOMDocument)(nil) func (d *SBOMDocument) Encode(w io.Writer) error { if d.encode == nil { return fmt.Errorf("no encoder for format %s", d.Format) } return d.encode(w) } ================================================ FILE: lib/sbom/spdx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package sbom import ( "bytes" "io" spdx_json "github.com/spdx/tools-golang/json" "github.com/spdx/tools-golang/spdx" ) func decodeSPDX2_3JSON(b []byte) (*spdx.Document, error) { return spdx_json.Read(bytes.NewReader(b)) } func encodeSPDX2_3JSON(bom *spdx.Document) encoderFn { return func(w io.Writer) error { return spdx_json.Write(bom, w) } } ================================================ FILE: lib/scorecard/enrich.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package scorecard import ( cdx "github.com/CycloneDX/cyclonedx-go" "github.com/spdx/tools-golang/spdx" "github.com/snyk/parlay/lib/sbom" ) func EnrichSBOM(doc *sbom.SBOMDocument) *sbom.SBOMDocument { switch bom := doc.BOM.(type) { case *cdx.BOM: enrichCDX(bom) case *spdx.Document: enrichSPDX(bom) } return doc } ================================================ FILE: lib/scorecard/enrich_cyclonedx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package scorecard import ( "net/http" "regexp" cdx "github.com/CycloneDX/cyclonedx-go" "github.com/package-url/packageurl-go" "github.com/remeh/sizedwaitgroup" "github.com/snyk/parlay/internal/utils" "github.com/snyk/parlay/lib/ecosystems" ) var httpProtocolsRe = regexp.MustCompile(`^https?:\/\/`) func cdxEnrichExternalReference(comp *cdx.Component, url, comment string, refType cdx.ExternalReferenceType) { ext := cdx.ExternalReference{ URL: url, Comment: comment, Type: refType, } if comp.ExternalReferences == nil { comp.ExternalReferences = &[]cdx.ExternalReference{ext} } else { *comp.ExternalReferences = append(*comp.ExternalReferences, ext) } } func enrichCDX(bom *cdx.BOM) { comps := utils.DiscoverCDXComponents(bom) wg := sizedwaitgroup.New(20) for i := range comps { wg.Add() go func(component *cdx.Component) { defer wg.Done() purl, err := packageurl.FromString(component.PackageURL) if err != nil { return } resp, err := ecosystems.GetPackageData(purl) if err != nil { return } if resp.JSON200 == nil || resp.JSON200.RepositoryUrl == nil || *resp.JSON200.RepositoryUrl == "" { return } scorecardUrl := httpProtocolsRe.ReplaceAllString(*resp.JSON200.RepositoryUrl, "https://api.securityscorecards.dev/projects/") response, err := http.Get(scorecardUrl) if err != nil { return } defer response.Body.Close() if response.StatusCode != http.StatusOK { return } cdxEnrichExternalReference(component, scorecardUrl, "OpenSSF Scorecard", cdx.ERTypeOther) }(comps[i]) } wg.Wait() } ================================================ FILE: lib/scorecard/enrich_spdx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package scorecard import ( "net/http" "strings" "github.com/remeh/sizedwaitgroup" "github.com/spdx/tools-golang/spdx" spdx_2_3 "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/snyk/parlay/internal/utils" "github.com/snyk/parlay/lib/ecosystems" ) func enrichSPDX(bom *spdx.Document) { wg := sizedwaitgroup.New(20) for i, pkg := range bom.Packages { wg.Add() go func(pkg *spdx_2_3.Package, i int) { defer wg.Done() purl, err := utils.GetPurlFromSPDXPackage(pkg) if err != nil { return } resp, err := ecosystems.GetPackageData(*purl) if err != nil || resp.JSON200 == nil || resp.JSON200.RepositoryUrl == nil { return } scURL := strings.ReplaceAll(*resp.JSON200.RepositoryUrl, "https://", "https://api.securityscorecards.dev/projects/") response, err := http.Get(scURL) if err != nil || response.StatusCode != http.StatusOK { return } pkg.PackageExternalReferences = append(pkg.PackageExternalReferences, &spdx_2_3.PackageExternalReference{ Category: spdx.CategoryOther, RefType: "openssfscorecard", Locator: scURL, }) }(pkg, i) } wg.Wait() } ================================================ FILE: lib/scorecard/enrich_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package scorecard import ( "errors" "net/http" "testing" cdx "github.com/CycloneDX/cyclonedx-go" "github.com/jarcoal/httpmock" "github.com/spdx/tools-golang/spdx" spdx_2_3 "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/stretchr/testify/assert" "github.com/snyk/parlay/lib/sbom" ) const scorecardURL = "https://api.securityscorecards.dev/projects/example.com/repository" func TestEnrichSBOM_CycloneDX(t *testing.T) { teardown := setupEcosystemsAPIMock(t) defer teardown() bom := &cdx.BOM{ Components: &[]cdx.Component{ { PackageURL: "pkg:type/example", }, }, } doc := &sbom.SBOMDocument{BOM: bom} EnrichSBOM(doc) assert.NotNil(t, bom.Components) assert.Len(t, *bom.Components, 1) enrichedComponent := (*bom.Components)[0] assert.NotNil(t, enrichedComponent.ExternalReferences) assert.Len(t, *enrichedComponent.ExternalReferences, 1) assert.Equal(t, scorecardURL, (*enrichedComponent.ExternalReferences)[0].URL) assert.Equal(t, "OpenSSF Scorecard", (*enrichedComponent.ExternalReferences)[0].Comment) assert.Equal(t, cdx.ERTypeOther, (*enrichedComponent.ExternalReferences)[0].Type) total := httpmock.GetTotalCallCount() assert.Equal(t, 2, total) calls := httpmock.GetCallCountInfo() assert.Equal(t, 1, calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) } func TestEnrichSBOM_CycloneDX_NestedComponents(t *testing.T) { teardown := setupEcosystemsAPIMock(t) defer teardown() bom := &cdx.BOM{ Components: &[]cdx.Component{ { PackageURL: "pkg:type/example", Components: &[]cdx.Component{ { PackageURL: "pkg:otherType/otherExample", }, }, }, }, } doc := &sbom.SBOMDocument{BOM: bom} EnrichSBOM(doc) assert.NotNil(t, bom.Components) assert.Len(t, *bom.Components, 1) for i := range *bom.Components { enrichedComponent := (*bom.Components)[i] assert.NotNil(t, enrichedComponent.ExternalReferences) assert.Len(t, *enrichedComponent.ExternalReferences, 1) assert.Equal(t, scorecardURL, (*enrichedComponent.ExternalReferences)[0].URL) assert.Equal(t, "OpenSSF Scorecard", (*enrichedComponent.ExternalReferences)[0].Comment) assert.Equal(t, cdx.ERTypeOther, (*enrichedComponent.ExternalReferences)[0].Type) } total := httpmock.GetTotalCallCount() assert.Equal(t, 4, total) calls := httpmock.GetCallCountInfo() assert.Equal(t, 2, calls[`GET =~^https://packages.ecosyste.ms/api/v1/registries`]) } func TestEnrichSBOM_ErrorFetchingPackageData(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewErrorResponder(assert.AnError)) httpmock.RegisterNoResponder(func(req *http.Request) (*http.Response, error) { return nil, errors.New("unexpected HTTP request: " + req.URL.String()) }) bom := &cdx.BOM{ Components: &[]cdx.Component{ { PackageURL: "pkg:/example", }, }, } doc := &sbom.SBOMDocument{BOM: bom} EnrichSBOM(doc) assert.NotNil(t, bom.Components) assert.Len(t, *bom.Components, 1) enrichedComponent := (*bom.Components)[0] assert.Nil(t, enrichedComponent.ExternalReferences) } func TestEnrichSBOM_ErrorFetchingScorecard(t *testing.T) { httpmock.Activate() defer httpmock.DeactivateAndReset() mockPackageData := `{"JSON200": {"RepositoryUrl": "https://example.com/repository"}}` httpmock.RegisterResponder("GET", `=~^https://packages.ecosyste.ms/api/v1/registries`, httpmock.NewStringResponder(http.StatusOK, mockPackageData)) httpmock.RegisterResponder("GET", "https://api.securityscorecards.dev/projects/example.com/repository", httpmock.NewErrorResponder(assert.AnError)) httpmock.RegisterNoResponder(func(req *http.Request) (*http.Response, error) { return nil, errors.New("unexpected HTTP request: " + req.URL.String()) }) bom := &cdx.BOM{ Components: &[]cdx.Component{ { PackageURL: "pkg:/example", }, }, } doc := &sbom.SBOMDocument{BOM: bom} EnrichSBOM(doc) assert.NotNil(t, bom.Components) assert.Len(t, *bom.Components, 1) enrichedComponent := (*bom.Components)[0] assert.Nil(t, enrichedComponent.ExternalReferences) } func TestEnrichSBOM_SPDX(t *testing.T) { teardown := setupEcosystemsAPIMock(t) defer teardown() bom := &spdx.Document{ Packages: []*spdx_2_3.Package{ { PackageExternalReferences: []*spdx_2_3.PackageExternalReference{ { Category: spdx.CategoryOther, RefType: "purl", Locator: "pkg:golang/snyk/parlay", }, }, }, }, } doc := &sbom.SBOMDocument{BOM: bom} EnrichSBOM(doc) pkg := bom.Packages[0] assert.NotNil(t, pkg.PackageExternalReferences) assert.Len(t, pkg.PackageExternalReferences, 2) scRef := pkg.PackageExternalReferences[1] assert.Equal(t, scorecardURL, scRef.Locator) assert.Equal(t, "openssfscorecard", scRef.RefType) assert.Equal(t, spdx.CategoryOther, scRef.Category) } func setupEcosystemsAPIMock(t *testing.T) func() { t.Helper() httpmock.Activate() httpmock.RegisterResponder( "GET", "=~^https://packages.ecosyste.ms/api/v1/registries", func(req *http.Request) (*http.Response, error) { return httpmock.NewJsonResponse(200, map[string]interface{}{ "repository_url": "https://example.com/repository", }) }, ) httpmock.RegisterResponder( "GET", scorecardURL, httpmock.NewStringResponder(http.StatusOK, "{}"), ) httpmock.RegisterNoResponder(func(req *http.Request) (*http.Response, error) { return nil, errors.New("unexpected HTTP request: " + req.URL.String()) }) return httpmock.DeactivateAndReset } ================================================ FILE: lib/snyk/config.go ================================================ /* * © 2024 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( "context" "fmt" "net/http" ) // Version will be set by the build process var Version = "dev" type Config struct { SnykAPIURL string APIToken string } func DefaultConfig() *Config { return &Config{ SnykAPIURL: "https://api.snyk.io", } } func getUserAgent() string { return fmt.Sprintf("parlay (%s)", Version) } func addParlayUserAgent(ctx context.Context, req *http.Request) error { req.Header.Set("User-Agent", getUserAgent()) return nil } ================================================ FILE: lib/snyk/enrich.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( cdx "github.com/CycloneDX/cyclonedx-go" "github.com/rs/zerolog" "github.com/spdx/tools-golang/spdx" "github.com/snyk/parlay/lib/sbom" ) const ( snykAdvisorWebURL = "https://snyk.io/advisor" snykVulnerabilityDBWebURL = "https://security.snyk.io" ) func EnrichSBOM(cfg *Config, doc *sbom.SBOMDocument, logger *zerolog.Logger) *sbom.SBOMDocument { switch bom := doc.BOM.(type) { case *cdx.BOM: enrichCycloneDX(cfg, bom, logger) case *spdx.Document: enrichSPDX(cfg, bom, logger) } return doc } ================================================ FILE: lib/snyk/enrich_cyclonedx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( "encoding/json" "strconv" "sync" "time" cdx "github.com/CycloneDX/cyclonedx-go" "github.com/package-url/packageurl-go" "github.com/remeh/sizedwaitgroup" "github.com/rs/zerolog" "github.com/snyk/parlay/internal/utils" "github.com/snyk/parlay/snyk/issues" ) type cdxEnricher = func(*Config, *cdx.Component, *packageurl.PackageURL) type cdxPurlGroup struct { purl packageurl.PackageURL components []*cdx.Component } var cdxEnrichers = []cdxEnricher{ enrichCDXSnykAdvisorData, enrichCDXSnykVulnerabilityDBData, } func enrichCDXSnykVulnerabilityDBData(cfg *Config, component *cdx.Component, purl *packageurl.PackageURL) { url := SnykVulnURL(cfg, purl) if url != "" { ext := cdx.ExternalReference{ URL: url, Comment: "Snyk Vulnerability DB", Type: "Other", } if component.ExternalReferences == nil { component.ExternalReferences = &[]cdx.ExternalReference{ext} } else { *component.ExternalReferences = append(*component.ExternalReferences, ext) } } } func enrichCDXSnykAdvisorData(cfg *Config, component *cdx.Component, purl *packageurl.PackageURL) { url := SnykAdvisorURL(cfg, purl) if url != "" { ext := cdx.ExternalReference{ URL: url, Comment: "Snyk Advisor", Type: "Other", } if component.ExternalReferences == nil { component.ExternalReferences = &[]cdx.ExternalReference{ext} } else { *component.ExternalReferences = append(*component.ExternalReferences, ext) } } } func enrichCycloneDX(cfg *Config, bom *cdx.BOM, logger *zerolog.Logger) *cdx.BOM { auth, err := AuthFromToken(cfg.APIToken) if err != nil { logger.Fatal().Err(err).Msg("Failed to authenticate") return nil } orgID, err := SnykOrgID(cfg, auth) if err != nil { logger.Error().Err(err).Msg("Failed to infer preferred Snyk organization") return nil } logger.Debug().Str("org_id", orgID.String()).Msg("Inferred Snyk organization ID") var mutex = &sync.Mutex{} vulnerabilities := make(map[*cdx.Component][]issues.CommonIssueModelVThree) wg := sizedwaitgroup.New(20) comps := utils.DiscoverCDXComponents(bom) logger.Debug().Msgf("Detected %d packages", len(comps)) // Group components by PURL to deduplicate API calls purlGroups := make(map[string]*cdxPurlGroup) for i := range comps { component := comps[i] l := logger.With().Str("bom-ref", component.BOMRef).Logger() purl, err := packageurl.FromString(component.PackageURL) if err != nil { l.Debug(). Err(err). Msg("Could not identify package") continue } for _, enrichFunc := range cdxEnrichers { enrichFunc(cfg, component, &purl) } key := purl.ToString() group, ok := purlGroups[key] if !ok { group = &cdxPurlGroup{purl: purl} purlGroups[key] = group } group.components = append(group.components, component) } logger.Debug().Msgf("Detected %d unique PURLs", len(purlGroups)) // Fetch vulnerabilities for each unique PURL for _, group := range purlGroups { wg.Add() go func() { defer wg.Done() l := logger.With(). Str("purl", group.purl.ToString()). Logger() resp, err := GetPackageVulnerabilities(cfg, &group.purl, auth, orgID, logger) if err != nil { l.Err(err). Msg("Failed to fetch vulnerabilities for package") return } packageData := resp.Body var packageDoc issues.IssuesWithPurlsResponse if err := json.Unmarshal(packageData, &packageDoc); err != nil { l.Err(err). Str("status", resp.Status()). Msg("Failed to decode Snyk vulnerability response") return } if packageDoc.Data != nil { mutex.Lock() for _, component := range group.components { vulnerabilities[component] = *packageDoc.Data } mutex.Unlock() } }() } wg.Wait() var vulns []cdx.Vulnerability for comp, v := range vulnerabilities { for _, issue := range v { vuln := cdx.Vulnerability{ BOMRef: comp.BOMRef, } if issue.Id != nil { vuln.ID = *issue.Id } if issue.Attributes.Title != nil { vuln.Description = *issue.Attributes.Title } if issue.Attributes.Description != nil { vuln.Detail = *issue.Attributes.Description } if issue.Attributes.CreatedAt != nil { created := *issue.Attributes.CreatedAt vuln.Created = created.UTC().Format(time.RFC3339) } if issue.Attributes.UpdatedAt != nil { updated := *issue.Attributes.UpdatedAt vuln.Updated = updated.UTC().Format(time.RFC3339) } if issue.Attributes.Problems != nil { problems := *issue.Attributes.Problems for _, problem := range problems { switch problem.Source { case "CWE": id := problem.Id[4:] cwe, err := strconv.Atoi(id) if err == nil { if vuln.CWEs == nil { cwes := []int{cwe} vuln.CWEs = &cwes } else { *vuln.CWEs = append(*vuln.CWEs, cwe) } } case "CVE", "GHAS", "RHSA": s := cdx.Source{ Name: problem.Source, } ref := cdx.VulnerabilityReference{ ID: problem.Id, Source: &s, } if vuln.References == nil { refs := []cdx.VulnerabilityReference{ref} vuln.References = &refs } else { *vuln.References = append(*vuln.References, ref) } } } if issue.Attributes.Slots.References != nil { for _, ref := range *issue.Attributes.Slots.References { ad := cdx.Advisory{ Title: *ref.Title, URL: *ref.Url, } if vuln.Advisories == nil { ads := []cdx.Advisory{ad} vuln.Advisories = &ads } else { *vuln.Advisories = append(*vuln.Advisories, ad) } } } if issue.Attributes.Severities != nil { for _, sev := range *issue.Attributes.Severities { var source cdx.Source if sev.Source != nil { source = cdx.Source{ Name: *sev.Source, } } else { source = cdx.Source{ Name: "Snyk", } } if source.Name == "Snyk" { source.URL = snykVulnerabilityDBWebURL } if sev.Score != nil { score := float64(*sev.Score) rating := cdx.VulnerabilityRating{ Source: &source, Score: &score, Severity: levelToCdxSeverity(sev.Level), Method: versionToCdxMethod(sev.Version), Vector: *sev.Vector, } if vuln.Ratings == nil { ratings := []cdx.VulnerabilityRating{rating} vuln.Ratings = &ratings } else { *vuln.Ratings = append(*vuln.Ratings, rating) } } } } vulns = append(vulns, vuln) } } } logger.Debug().Msgf("Found %d vulnerabilities", len(vulns)) if len(vulns) > 0 { bom.Vulnerabilities = &vulns } return bom } func levelToCdxSeverity(level *string) (severity cdx.Severity) { switch *level { case "critical": severity = cdx.SeverityCritical case "high": severity = cdx.SeverityHigh case "medium": severity = cdx.SeverityMedium case "low": severity = cdx.SeverityLow default: severity = cdx.SeverityUnknown } return } func versionToCdxMethod(version *string) (method cdx.ScoringMethod) { switch *version { case "3.0": method = cdx.ScoringMethodCVSSv3 case "3.1": method = cdx.ScoringMethodCVSSv31 case "4.0": method = cdx.ScoringMethodCVSSv4 default: method = cdx.ScoringMethodOther } return } ================================================ FILE: lib/snyk/enrich_spdx.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( "encoding/json" "fmt" "net/url" "sync" "github.com/package-url/packageurl-go" "github.com/remeh/sizedwaitgroup" "github.com/rs/zerolog" "github.com/spdx/tools-golang/spdx" spdx_2_3 "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/snyk/parlay/internal/utils" "github.com/snyk/parlay/snyk/issues" ) type spdxEnricher = func(*Config, *spdx_2_3.Package, *packageurl.PackageURL) type spdxPurlGroup struct { purl packageurl.PackageURL packages []*spdx_2_3.Package } var spdxEnrichers = []spdxEnricher{ enrichSPDXSnykAdvisorData, enrichSPDXSnykVulnerabilityDBData, } func enrichSPDXSnykAdvisorData(cfg *Config, component *spdx_2_3.Package, purl *packageurl.PackageURL) { url := SnykAdvisorURL(cfg, purl) if url != "" { ext := &spdx_2_3.PackageExternalReference{ Locator: url, RefType: "advisory", Category: spdx.CategoryOther, ExternalRefComment: "Snyk Advisor", } if component.PackageExternalReferences == nil { component.PackageExternalReferences = []*spdx_2_3.PackageExternalReference{ext} } else { component.PackageExternalReferences = append(component.PackageExternalReferences, ext) } } } func enrichSPDXSnykVulnerabilityDBData(cfg *Config, component *spdx_2_3.Package, purl *packageurl.PackageURL) { url := SnykVulnURL(cfg, purl) if url != "" { ext := &spdx_2_3.PackageExternalReference{ Locator: url, RefType: "url", Category: spdx.CategoryOther, ExternalRefComment: "Snyk Vulnerability DB", } if component.PackageExternalReferences == nil { component.PackageExternalReferences = []*spdx_2_3.PackageExternalReference{ext} } else { component.PackageExternalReferences = append(component.PackageExternalReferences, ext) } } } func enrichSPDX(cfg *Config, bom *spdx.Document, logger *zerolog.Logger) *spdx.Document { auth, err := AuthFromToken(cfg.APIToken) if err != nil { logger.Fatal(). Err(err). Msg("Failed to authenticate") return nil } orgID, err := SnykOrgID(cfg, auth) if err != nil { logger.Fatal(). Err(err). Msg("Failed to infer preferred Snyk organization") return nil } mutex := &sync.Mutex{} wg := sizedwaitgroup.New(20) vulnerabilities := make(map[*spdx_2_3.Package][]issues.CommonIssueModelVThree) packages := bom.Packages logger.Debug().Msgf("Detected %d packages", len(packages)) // Group packages by PURL to deduplicate API calls purlGroups := make(map[string]*spdxPurlGroup) for _, pkg := range packages { l := logger.With().Str("SPDXID", string(pkg.PackageSPDXIdentifier)).Logger() purl, err := utils.GetPurlFromSPDXPackage(pkg) if err != nil || purl == nil { l.Debug().Msg("Could not identify package") continue } for _, enrichFn := range spdxEnrichers { enrichFn(cfg, pkg, purl) } key := purl.ToString() group, ok := purlGroups[key] if !ok { group = &spdxPurlGroup{purl: *purl} purlGroups[key] = group } group.packages = append(group.packages, pkg) } logger.Debug().Msgf("Detected %d unique PURLs", len(purlGroups)) // Fetch vulnerabilities for each unique PURL for _, group := range purlGroups { wg.Add() go func() { defer wg.Done() l := logger.With(). Str("purl", group.purl.ToString()). Logger() resp, err := GetPackageVulnerabilities(cfg, &group.purl, auth, orgID, logger) if err != nil { l.Err(err). Msg("Failed to fetch vulnerabilities for package") return } packageData := resp.Body var packageDoc issues.IssuesWithPurlsResponse if err := json.Unmarshal(packageData, &packageDoc); err != nil { l.Err(err). Str("status", resp.Status()). Msg("Failed to decode Snyk vulnerability response") return } if packageDoc.Data != nil { mutex.Lock() for _, pkg := range group.packages { vulnerabilities[pkg] = *packageDoc.Data } mutex.Unlock() } }() } wg.Wait() for pkg, vulns := range vulnerabilities { for _, issue := range vulns { if issue.Id == nil { continue } ref := &spdx_2_3.PackageExternalReference{ Category: spdx.CategorySecurity, RefType: spdx.SecurityAdvisory, Locator: fmt.Sprintf( "%s/vuln/%s", snykVulnerabilityDBWebURL, url.PathEscape(*issue.Id)), } if issue.Attributes.Title != nil { ref.ExternalRefComment = *issue.Attributes.Title } pkg.PackageExternalReferences = append(pkg.PackageExternalReferences, ref) } } return bom } ================================================ FILE: lib/snyk/enrich_test.go ================================================ package snyk import ( _ "embed" "net/http" "net/http/httptest" "sync/atomic" "testing" cdx "github.com/CycloneDX/cyclonedx-go" "github.com/rs/zerolog" spdx "github.com/spdx/tools-golang/spdx/v2/common" spdx_2_3 "github.com/spdx/tools-golang/spdx/v2/v2_3" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "github.com/snyk/parlay/lib/sbom" ) var ( //go:embed testdata/numpy_issues.json numpyIssues []byte //go:embed testdata/pandas_issues.json pandasIssues []byte //go:embed testdata/no_issues.json noIssues []byte ) func TestEnrichSBOM_CycloneDXWithVulnerabilities(t *testing.T) { svc := setupTestEnv(t) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "pkg:pypi/numpy@1.16.0", Name: "numpy", Version: "1.16.0", PackageURL: "pkg:pypi/numpy@1.16.0", }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) require.NotNil(t, bom.Vulnerabilities) assert.Len(t, *bom.Vulnerabilities, 1) vuln := (*bom.Vulnerabilities)[0] assert.Equal(t, "pkg:pypi/numpy@1.16.0", vuln.BOMRef) assert.Equal(t, "SNYK-PYTHON-NUMPY-73513", vuln.ID) assert.NotNil(t, vuln.Ratings) assert.Len(t, *vuln.Ratings, 4) assert.Equal(t, (*vuln.Ratings)[0].Source, &cdx.Source{Name: "Snyk", URL: "https://security.snyk.io"}) assert.Equal(t, (*vuln.Ratings)[0].Method, cdx.ScoringMethodCVSSv31) assert.Equal(t, (*vuln.Ratings)[1].Source, &cdx.Source{Name: "NVD"}) assert.Equal(t, (*vuln.Ratings)[1].Method, cdx.ScoringMethodCVSSv3) } func TestEnrichSBOM_CycloneDXDeduplicatesRequests(t *testing.T) { var numRequests int32 mux := http.NewServeMux() mux.HandleFunc( "GET /rest/self", func(w http.ResponseWriter, r *http.Request) { respond(w, selfBody) }) mux.HandleFunc( "GET /rest/orgs/{org_id}/packages/{purl}/issues", func(w http.ResponseWriter, r *http.Request) { atomic.AddInt32(&numRequests, 1) respond(w, numpyIssues) }) srv := httptest.NewServer(mux) t.Cleanup(srv.Close) cfg := DefaultConfig() cfg.APIToken = "asdf" cfg.SnykAPIURL = srv.URL logger := zerolog.Nop() svc := NewService(cfg, &logger) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "pkg:pypi/numpy@1.16.0", Name: "numpy", Version: "1.16.0", PackageURL: "pkg:pypi/numpy@1.16.0", }, { BOMRef: "pkg:pypi/numpy@1.16.0#dup", Name: "numpy", Version: "1.16.0", PackageURL: "pkg:pypi/numpy@1.16.0", }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) assert.Equal(t, int32(1), atomic.LoadInt32(&numRequests)) require.NotNil(t, bom.Vulnerabilities) vulnByRef := map[string]int{} for _, vuln := range *bom.Vulnerabilities { vulnByRef[vuln.BOMRef]++ } assert.Greater(t, vulnByRef["pkg:pypi/numpy@1.16.0"], 0) assert.Greater(t, vulnByRef["pkg:pypi/numpy@1.16.0#dup"], 0) } func TestEnrichSBOM_CycloneDXExternalRefs(t *testing.T) { svc := setupTestEnv(t) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "pkg:pypi/numpy@1.16.0", Name: "numpy", Version: "1.16.0", PackageURL: "pkg:pypi/numpy@1.16.0", }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) require.NotNil(t, bom.Components) refs := (*bom.Components)[0].ExternalReferences assert.Len(t, *refs, 2) ref1 := (*refs)[0] assert.Equal(t, "https://snyk.io/advisor/python/numpy", ref1.URL) assert.Equal(t, "Snyk Advisor", ref1.Comment) assert.Equal(t, cdx.ExternalReferenceType("Other"), ref1.Type) ref2 := (*refs)[1] assert.Equal(t, "https://security.snyk.io/package/pip/numpy", ref2.URL) assert.Equal(t, "Snyk Vulnerability DB", ref2.Comment) assert.Equal(t, cdx.ExternalReferenceType("Other"), ref2.Type) } func TestEnrichSBOM_CycloneDXExternalRefs_WithNamespace(t *testing.T) { svc := setupTestEnv(t) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "@emotion/react@11.11.3", Name: "react", Version: "11.11.3", PackageURL: "pkg:npm/%40emotion/react@11.11.3", }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) require.NotNil(t, bom.Components) refs := (*bom.Components)[0].ExternalReferences assert.Len(t, *refs, 2) ref1 := (*refs)[0] assert.Equal(t, "https://snyk.io/advisor/npm-package/@emotion/react", ref1.URL) assert.Equal(t, "Snyk Advisor", ref1.Comment) assert.Equal(t, cdx.ExternalReferenceType("Other"), ref1.Type) ref2 := (*refs)[1] assert.Equal(t, "https://security.snyk.io/package/npm/@emotion%2Freact", ref2.URL) assert.Equal(t, "Snyk Vulnerability DB", ref2.Comment) assert.Equal(t, cdx.ExternalReferenceType("Other"), ref2.Type) } func TestEnrichSBOM_CycloneDXWithVulnerabilities_NestedComponents(t *testing.T) { svc := setupTestEnv(t) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "pkg:pypi/pandas@0.15.0", Name: "pandas", Version: "0.15.0", PackageURL: "pkg:pypi/pandas@0.15.0", Components: &[]cdx.Component{ { BOMRef: "pkg:pypi/numpy@1.16.0", Name: "numpy", Version: "1.16.0", PackageURL: "pkg:pypi/numpy@1.16.0", }, }, }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) require.NotNil(t, bom.Vulnerabilities) assert.Len(t, *bom.Vulnerabilities, 2) } func TestEnrichSBOM_CycloneDXWithoutVulnerabilities(t *testing.T) { svc := setupTestEnv(t) bom := &cdx.BOM{ Components: &[]cdx.Component{ { BOMRef: "pkg:pypi/werkzeug@2.2.3", Name: "werkzeug", Version: "2.2.3", PackageURL: "pkg:pypi/werkzeug@2.2.3", }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) assert.Nil(t, bom.Vulnerabilities, "should not extend vulnerabilities if there are none") } func TestEnrichSBOM_SPDXWithVulnerabilities(t *testing.T) { svc := setupTestEnv(t) bom := &spdx_2_3.Document{ Packages: []*spdx_2_3.Package{ { PackageSPDXIdentifier: "pkg:pypi/numpy@1.16.0", PackageName: "numpy", PackageVersion: "1.16.0", PackageExternalReferences: []*spdx_2_3.PackageExternalReference{ { Category: spdx.CategoryPackageManager, RefType: "purl", Locator: "pkg:pypi/numpy@1.16.0", }, }, }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) vulnRef := bom.Packages[0].PackageExternalReferences[3] assert.Equal(t, "SECURITY", vulnRef.Category) assert.Equal(t, "advisory", vulnRef.RefType) assert.Equal(t, "https://security.snyk.io/vuln/SNYK-PYTHON-NUMPY-73513", vulnRef.Locator) assert.Equal(t, "Arbitrary Code Execution", vulnRef.ExternalRefComment) } func TestEnrichSBOM_SPDXDeduplicatesRequests(t *testing.T) { var numRequests int32 mux := http.NewServeMux() mux.HandleFunc( "GET /rest/self", func(w http.ResponseWriter, r *http.Request) { respond(w, selfBody) }) mux.HandleFunc( "GET /rest/orgs/{org_id}/packages/{purl}/issues", func(w http.ResponseWriter, r *http.Request) { atomic.AddInt32(&numRequests, 1) respond(w, numpyIssues) }) srv := httptest.NewServer(mux) t.Cleanup(srv.Close) cfg := DefaultConfig() cfg.APIToken = "asdf" cfg.SnykAPIURL = srv.URL logger := zerolog.Nop() svc := NewService(cfg, &logger) bom := &spdx_2_3.Document{ Packages: []*spdx_2_3.Package{ { PackageSPDXIdentifier: "pkg:pypi/numpy@1.16.0", PackageName: "numpy", PackageVersion: "1.16.0", PackageExternalReferences: []*spdx_2_3.PackageExternalReference{ { Category: spdx.CategoryPackageManager, RefType: "purl", Locator: "pkg:pypi/numpy@1.16.0", }, }, }, { PackageSPDXIdentifier: "pkg:pypi/numpy@1.16.0-dup", PackageName: "numpy", PackageVersion: "1.16.0", PackageExternalReferences: []*spdx_2_3.PackageExternalReference{ { Category: spdx.CategoryPackageManager, RefType: "purl", Locator: "pkg:pypi/numpy@1.16.0", }, }, }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) assert.Equal(t, int32(1), atomic.LoadInt32(&numRequests)) expectedLocator := "https://security.snyk.io/vuln/SNYK-PYTHON-NUMPY-73513" for _, pkg := range bom.Packages { hasVulnRef := false for _, ref := range pkg.PackageExternalReferences { if ref.Category == spdx.CategorySecurity && ref.RefType == "advisory" && ref.Locator == expectedLocator { hasVulnRef = true break } } assert.Truef(t, hasVulnRef, "expected vulnerability reference for %s", pkg.PackageSPDXIdentifier) } } func TestEnrichSBOM_SPDXExternalRefs(t *testing.T) { svc := setupTestEnv(t) bom := &spdx_2_3.Document{ Packages: []*spdx_2_3.Package{ { PackageSPDXIdentifier: "pkg:pypi/numpy@1.16.0", PackageName: "numpy", PackageVersion: "1.16.0", PackageExternalReferences: []*spdx_2_3.PackageExternalReference{ { Category: spdx.CategoryPackageManager, RefType: "purl", Locator: "pkg:pypi/numpy@1.16.0", }, }, }, }, } doc := &sbom.SBOMDocument{BOM: bom} svc.EnrichSBOM(doc) assert.NotNil(t, bom.Packages) refs := (*bom.Packages[0]).PackageExternalReferences assert.Len(t, refs, 4) ref1 := refs[1] assert.Equal(t, "https://snyk.io/advisor/python/numpy", ref1.Locator) assert.Equal(t, "Snyk Advisor", ref1.ExternalRefComment) assert.Equal(t, "advisory", ref1.RefType) assert.Equal(t, spdx.CategoryOther, ref1.Category) ref2 := refs[2] assert.Equal(t, "https://security.snyk.io/package/pip/numpy", ref2.Locator) assert.Equal(t, "Snyk Vulnerability DB", ref2.ExternalRefComment) assert.Equal(t, "url", ref2.RefType) assert.Equal(t, spdx.CategoryOther, ref2.Category) } func setupTestEnv(t *testing.T) Service { t.Helper() mux := http.NewServeMux() mux.HandleFunc( "GET /rest/self", func(w http.ResponseWriter, r *http.Request) { respond(w, selfBody) }) mux.HandleFunc( "GET /rest/orgs/{org_id}/packages/{purl}/issues", func(w http.ResponseWriter, r *http.Request) { respond(w, noIssues) }) mux.HandleFunc( "GET /rest/orgs/{org_id}/packages/pkg%3Apypi%2Fnumpy%401.16.0/issues", func(w http.ResponseWriter, r *http.Request) { respond(w, numpyIssues) }) mux.HandleFunc( "GET /rest/orgs/{org_id}/packages/pkg%3Apypi%2Fpandas%400.15.0/issues", func(w http.ResponseWriter, r *http.Request) { respond(w, pandasIssues) }) srv := httptest.NewServer(mux) t.Cleanup(srv.Close) cfg := DefaultConfig() cfg.APIToken = "asdf" cfg.SnykAPIURL = srv.URL logger := zerolog.Nop() svc := NewService(cfg, &logger) return svc } func respond(w http.ResponseWriter, data []byte) { w.Header().Set("content-type", "application/vnd.api+json") if _, err := w.Write(data); err != nil { panic(err) } } ================================================ FILE: lib/snyk/package.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( "context" "fmt" "net/http" "strconv" "time" "github.com/deepmap/oapi-codegen/pkg/securityprovider" "github.com/google/uuid" "github.com/hashicorp/go-retryablehttp" "github.com/package-url/packageurl-go" "github.com/rs/zerolog" "github.com/snyk/parlay/snyk/issues" ) const version = "2024-06-26" func purlToSnykAdvisor(purl *packageurl.PackageURL) string { return map[string]string{ packageurl.TypeNPM: "npm-package", packageurl.TypePyPi: "python", packageurl.TypeGolang: "golang", packageurl.TypeDocker: "docker", }[purl.Type] } func SnykAdvisorURL(cfg *Config, purl *packageurl.PackageURL) string { ecosystem := purlToSnykAdvisor(purl) if ecosystem == "" { return "" } url := snykAdvisorWebURL + "/" + ecosystem + "/" if purl.Namespace != "" { url += purl.Namespace + "/" } url += purl.Name return url } func purlToSnykVulnDB(purl *packageurl.PackageURL) string { return map[string]string{ packageurl.TypeCargo: "cargo", packageurl.TypeCocoapods: "cocoapods", packageurl.TypeComposer: "composer", packageurl.TypeGolang: "golang", packageurl.TypeHex: "hex", packageurl.TypeMaven: "maven", packageurl.TypeNPM: "npm", packageurl.TypeNuget: "nuget", packageurl.TypePyPi: "pip", packageurl.TypePub: "pub", packageurl.TypeGem: "rubygems", packageurl.TypeSwift: "swift", }[purl.Type] } func SnykVulnURL(cfg *Config, purl *packageurl.PackageURL) string { ecosystem := purlToSnykVulnDB(purl) if ecosystem == "" { return "" } url := snykVulnerabilityDBWebURL + "/package/" + ecosystem + "/" if purl.Namespace != "" { url += purl.Namespace + "%2F" } url += purl.Name return url } func GetPackageVulnerabilities(cfg *Config, purl *packageurl.PackageURL, auth *securityprovider.SecurityProviderApiKey, orgID *uuid.UUID, logger *zerolog.Logger) (*issues.FetchIssuesPerPurlResponse, error) { client, err := issues.NewClientWithResponses( cfg.SnykAPIURL+"/rest", issues.WithRequestEditorFn(auth.Intercept), issues.WithRequestEditorFn(addParlayUserAgent), issues.WithHTTPClient(getRetryClient(logger))) if err != nil { return nil, err } params := issues.FetchIssuesPerPurlParams{Version: version} resp, err := client.FetchIssuesPerPurlWithResponse(context.Background(), *orgID, purl.ToString(), ¶ms) if err != nil { return nil, err } if resp.StatusCode() != http.StatusOK { return resp, fmt.Errorf("unsuccessful request (%s)", resp.Status()) } return resp, nil } func getRetryClient(logger *zerolog.Logger) *http.Client { rc := retryablehttp.NewClient() rc.RetryMax = 20 rc.Logger = nil rc.ErrorHandler = retryablehttp.PassthroughErrorHandler rc.ResponseLogHook = func(_ retryablehttp.Logger, r *http.Response) { if r != nil && r.StatusCode >= 400 { logger.Warn().Msgf("Unexpected status code (%s) for %s %s", r.Status, r.Request.Method, r.Request.URL.String()) } } rc.Backoff = func(min, max time.Duration, attemptNum int, resp *http.Response) time.Duration { if resp != nil { if sleep, ok := parseRateLimitHeader(resp.Header.Get("X-RateLimit-Reset")); ok { logger.Warn(). Dur("Retry-After", sleep). Msg("Getting rate-limited, waiting...") return sleep } } return retryablehttp.DefaultBackoff(min, max, attemptNum, resp) } return rc.StandardClient() } func parseRateLimitHeader(v string) (time.Duration, bool) { if v == "" { return 0, false } if sec, err := strconv.ParseInt(v, 10, 64); err == nil { return time.Duration(sec) * time.Second, true } return 0, false } ================================================ FILE: lib/snyk/package_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( "net/http" "net/http/httptest" "testing" "github.com/google/uuid" "github.com/package-url/packageurl-go" "github.com/rs/zerolog" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func TestGetPackageVulnerabilities_RetryRateLimited(t *testing.T) { logger := zerolog.Nop() var numRequests int srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { numRequests++ if numRequests == 1 { w.Header().Set("X-RateLimit-Reset", "1") w.WriteHeader(http.StatusTooManyRequests) return } w.Header().Set("Content-Type", "application/vnd.json+api") _, err := w.Write([]byte(`{"data":[{"type":"issues","id":"VULN-ID"}]}`)) require.NoError(t, err) })) cfg := DefaultConfig() cfg.SnykAPIURL = srv.URL auth, err := AuthFromToken("asdf") require.NoError(t, err) purl, err := packageurl.FromString("pkg:golang/github.com/snyk/parlay") require.NoError(t, err) orgID := uuid.New() issues, err := GetPackageVulnerabilities(cfg, &purl, auth, &orgID, &logger) require.NoError(t, err) assert.Equal(t, 2, numRequests, "retries failed requests") assert.NotNil(t, issues, "should retrieve issues") } func TestGetPackageVulnerabilities_HandlesNilResponses(t *testing.T) { logger := zerolog.Nop() var numRequests int var srv *httptest.Server srv = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { numRequests++ if numRequests < 5 { w.Header().Set("X-RateLimit-Reset", "0") w.WriteHeader(http.StatusTooManyRequests) return } // Induce a client error which results in a nil response srv.CloseClientConnections() })) cfg := DefaultConfig() cfg.SnykAPIURL = srv.URL auth, err := AuthFromToken("asdf") require.NoError(t, err) purl, err := packageurl.FromString("pkg:golang/github.com/snyk/parlay") require.NoError(t, err) orgID := uuid.New() issues, err := GetPackageVulnerabilities(cfg, &purl, auth, &orgID, &logger) require.Error(t, err) assert.Nil(t, issues) } func TestGetPackageVulnerabilities_SetsUserAgent(t *testing.T) { logger := zerolog.Nop() srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { assert.Contains(t, r.Header.Get("User-Agent"), "parlay") })) defer srv.Close() cfg := DefaultConfig() cfg.SnykAPIURL = srv.URL auth, err := AuthFromToken("asdf") require.NoError(t, err) purl, err := packageurl.FromString("pkg:golang/github.com/snyk/parlay") require.NoError(t, err) orgID := uuid.New() _, err = GetPackageVulnerabilities(cfg, &purl, auth, &orgID, &logger) require.NoError(t, err) } ================================================ FILE: lib/snyk/self.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( "context" "errors" "fmt" "net/http" "github.com/deepmap/oapi-codegen/pkg/securityprovider" "github.com/google/uuid" "github.com/snyk/parlay/snyk/users" ) const experimentalVersion = "2023-04-28~experimental" func SnykOrgID(cfg *Config, auth *securityprovider.SecurityProviderApiKey) (*uuid.UUID, error) { experimental, err := users.NewClientWithResponses( cfg.SnykAPIURL+"/rest", users.WithRequestEditorFn(auth.Intercept), users.WithRequestEditorFn(addParlayUserAgent)) if err != nil { return nil, err } userParams := users.GetSelfParams{Version: experimentalVersion} self, err := experimental.GetSelfWithResponse(context.Background(), &userParams) if err != nil { return nil, err } if self.HTTPResponse.StatusCode != http.StatusOK { return nil, fmt.Errorf("Failed to get user info (%s).", self.HTTPResponse.Status) } user, err := self.ApplicationvndApiJSON200.Data.Attributes.AsUser20240422() if err != nil { return nil, err } if org := user.DefaultOrgContext; org != nil { return org, nil } return nil, errors.New("Failed to get org ID.") } func AuthFromToken(token string) (*securityprovider.SecurityProviderApiKey, error) { if token == "" { return nil, errors.New("Must provide a SNYK_TOKEN environment variable") } auth, err := securityprovider.NewSecurityProviderApiKey("header", "Authorization", fmt.Sprintf("token %s", token)) if err != nil { return nil, err } return auth, nil } ================================================ FILE: lib/snyk/self_test.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package snyk import ( _ "embed" "net/http" "net/http/httptest" "testing" "github.com/deepmap/oapi-codegen/pkg/securityprovider" "github.com/google/uuid" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) //go:embed testdata/self.json var selfBody []byte func TestSnykOrgID_Success(t *testing.T) { srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { respond(w, selfBody) })) defer srv.Close() cfg := DefaultConfig() cfg.SnykAPIURL = srv.URL auth, err := securityprovider.NewSecurityProviderApiKey("header", "authorization", "asdf") require.NoError(t, err) actualOrg, err := SnykOrgID(cfg, auth) assert.NoError(t, err) assert.Equal(t, uuid.MustParse("00000000-0000-0000-0000-000000000000"), *actualOrg) } func TestSnykOrgID_Unauthorized(t *testing.T) { srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusUnauthorized) respond(w, []byte(`{"msg":"unauthorized"}`)) })) defer srv.Close() cfg := DefaultConfig() cfg.SnykAPIURL = srv.URL auth, err := securityprovider.NewSecurityProviderApiKey("header", "authorization", "asdf") require.NoError(t, err) actualOrg, err := SnykOrgID(cfg, auth) assert.ErrorContains(t, err, "Failed to get user info (401 Unauthorized)") assert.Nil(t, actualOrg) } func TestSnykOrgID_SetsUserAgent(t *testing.T) { srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { assert.Contains(t, r.Header.Get("User-Agent"), "parlay") respond(w, selfBody) })) defer srv.Close() cfg := DefaultConfig() cfg.SnykAPIURL = srv.URL auth, err := securityprovider.NewSecurityProviderApiKey("header", "authorization", "asdf") require.NoError(t, err) _, err = SnykOrgID(cfg, auth) require.NoError(t, err) } ================================================ FILE: lib/snyk/service.go ================================================ package snyk import ( "github.com/deepmap/oapi-codegen/pkg/securityprovider" "github.com/google/uuid" "github.com/package-url/packageurl-go" "github.com/rs/zerolog" "github.com/snyk/parlay/lib/sbom" "github.com/snyk/parlay/snyk/issues" ) type Service interface { EnrichSBOM(*sbom.SBOMDocument) *sbom.SBOMDocument GetPackageVulnerabilities(*packageurl.PackageURL) (*issues.FetchIssuesPerPurlResponse, error) } type serviceImpl struct { cfg *Config logger *zerolog.Logger } var _ Service = (*serviceImpl)(nil) func NewService(cfg *Config, logger *zerolog.Logger) Service { return &serviceImpl{cfg, logger} } func (svc *serviceImpl) EnrichSBOM(doc *sbom.SBOMDocument) *sbom.SBOMDocument { return EnrichSBOM(svc.cfg, doc, svc.logger) } func (svc *serviceImpl) GetPackageVulnerabilities(purl *packageurl.PackageURL) (*issues.FetchIssuesPerPurlResponse, error) { auth, err := svc.getAuth() if err != nil { return nil, err } orgID, err := svc.getOrgID(auth) if err != nil { return nil, err } return GetPackageVulnerabilities(svc.cfg, purl, auth, orgID, svc.logger) } func (svc *serviceImpl) getAuth() (*securityprovider.SecurityProviderApiKey, error) { return AuthFromToken(svc.cfg.APIToken) } func (svc *serviceImpl) getOrgID(auth *securityprovider.SecurityProviderApiKey) (*uuid.UUID, error) { return SnykOrgID(svc.cfg, auth) } ================================================ FILE: lib/snyk/testdata/no_issues.json ================================================ { "jsonapi": { "version": "1.0" }, "data": [], "links": { "self": "/orgs/00000000-0000-0000-0000-000000000000/packages/pkg%3A/issues?version=2024-06-26&limit=1000&offset=0" }, "meta": { "package": {} } } ================================================ FILE: lib/snyk/testdata/numpy_issues.json ================================================ { "jsonapi": { "version": "1.0" }, "data": [ { "id": "SNYK-PYTHON-NUMPY-73513", "type": "issue", "attributes": { "title": "Arbitrary Code Execution", "type": "package_vulnerability", "created_at": "2019-01-16T14:11:37.000761Z", "updated_at": "2024-03-11T09:53:52.032659Z", "description": "## Overview\n[numpy](https://github.com/numpy/numpy) is a fundamental package needed for scientific computing with Python.\n\nAffected versions of this package are vulnerable to Arbitrary Code Execution. It uses the pickle Python module unsafely, which allows remote attackers to execute arbitrary code via a crafted serialized object, as demonstrated by a `numpy.load` call.\r\n\r\nPoC by nanshihui:\r\n```py\r\nimport numpy\r\nfrom numpy import __version__\r\nprint __version__\r\nimport os\r\nimport pickle\r\nclass Test(object):\r\n def __init__(self):\r\n self.a = 1\r\n\r\n def __reduce__(self):\r\n return (os.system,('ls',))\r\ntmpdaa = Test()\r\nwith open(\"a-file.pickle\",'wb') as f:\r\n pickle.dump(tmpdaa,f)\r\nnumpy.load('a-file.pickle')\r\n```\n## Remediation\nUpgrade `numpy` to version 1.16.3 or higher.\n## References\n- [GitHub Commit](https://github.com/numpy/numpy/commit/89b688732b37616c9d26623f81aaee1703c30ffb)\n- [GitHub Issue](https://github.com/numpy/numpy/issues/12759)\n- [GitHub PR](https://github.com/numpy/numpy/pull/13359)\n- [PoC](https://github.com/RayScri/CVE-2019-6446)\n", "problems": [ { "id": "CVE-2019-6446", "source": "CVE" }, { "id": "CWE-94", "source": "CWE" } ], "coordinates": [ { "remedies": [ { "type": "indeterminate", "description": "Upgrade the package version to 1.16.3 to fix this vulnerability", "details": { "upgrade_package": "1.16.3" } } ], "representations": [ { "resource_path": "[0,1.16.3)" }, { "package": { "name": "numpy", "version": "1.16.0", "type": "pypi", "url": "pkg:pypi/numpy@1.16.0" } } ] } ], "severities": [ { "type": "primary", "source": "Snyk", "level": "critical", "score": 9.8, "version": "3.1", "vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H/E:P" }, { "type": "secondary", "source": "NVD", "level": "critical", "score": 9.8, "version": "3.0", "vector": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H" }, { "type": "secondary", "source": "SUSE", "level": "high", "score": 7.8, "version": "3.0", "vector": "CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H" }, { "type": "secondary", "source": "Red Hat", "level": "high", "score": 8.8, "version": "3.0", "vector": "CVSS:3.0/AV:N/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H" } ], "effective_severity_level": "critical", "slots": { "disclosure_time": "2019-01-16T12:26:38Z", "publication_time": "2019-01-16T13:50:50Z", "exploit_details": { "sources": [ "Snyk" ], "maturity_levels": [ { "type": "primary", "level": "Proof of Concept", "format": "CVSSv4" }, { "type": "secondary", "level": "Proof of Concept", "format": "CVSSv3" } ] }, "references": [ { "url": "https://github.com/numpy/numpy/commit/89b688732b37616c9d26623f81aaee1703c30ffb", "title": "GitHub Commit" }, { "url": "https://github.com/numpy/numpy/issues/12759", "title": "GitHub Issue" }, { "url": "https://github.com/numpy/numpy/pull/13359", "title": "GitHub PR" }, { "url": "https://github.com/RayScri/CVE-2019-6446", "title": "PoC" } ] } } } ], "links": { "self": "/orgs/00000000-0000-0000-0000-000000000000/packages/pkg%3Apypi%2Fnumpy%401.16.0/issues?version=2024-06-26&limit=1000&offset=0" }, "meta": { "package": { "name": "numpy", "type": "pypi", "url": "pkg:pypi/numpy@1.16.0", "version": "1.16.0" } } } ================================================ FILE: lib/snyk/testdata/pandas_issues.json ================================================ { "jsonapi": { "version": "1.0" }, "data": [ { "id": "SNYK-PYTHON-PANDAS-5879012", "type": "issue", "attributes": { "title": "SQL Injection", "type": "package_vulnerability", "created_at": "2023-09-01T12:57:12.082697Z", "updated_at": "2024-03-06T14:03:52.403793Z", "description": "## Overview\n[pandas](https://pypi.org/project/pandas/) is a Python package providing data structures designed to make working with structured (tabular, multidimensional, potentially heterogeneous) and time series data both easy and intuitive.\n\nAffected versions of this package are vulnerable to SQL Injection via `sql.py`, due to improper input sanitization.\n## Remediation\nUpgrade `pandas` to version 0.16.0 or higher.\n## References\n- [GitHub Commit](https://github.com/pandas-dev/pandas/commit/a774ee84485412459f7205cccd87b639022afd07)\n- [GitHub PR](https://github.com/pandas-dev/pandas/pull/8986)\n", "problems": [ { "id": "CWE-89", "source": "CWE" }, { "id": "PVE-2023-99975", "source": "PVE" } ], "coordinates": [ { "remedies": [ { "type": "indeterminate", "description": "Upgrade the package version to 0.16.0 to fix this vulnerability", "details": { "upgrade_package": "0.16.0" } } ], "representations": [ { "resource_path": "[,0.16.0)" }, { "package": { "name": "pandas", "version": "0.15.0", "type": "pypi", "url": "pkg:pypi/pandas@0.15.0" } } ] } ], "severities": [ { "type": "primary", "source": "Snyk", "level": "high", "score": 7.3, "version": "3.1", "vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:L" } ], "effective_severity_level": "high", "slots": { "disclosure_time": "2023-09-01T06:35:07Z", "publication_time": "2023-09-03T09:33:34.590125Z", "exploit_details": { "sources": [], "maturity_levels": [ { "type": "primary", "level": "Not Defined", "format": "CVSSv4" }, { "type": "secondary", "level": "Not Defined", "format": "CVSSv3" } ] }, "references": [ { "url": "https://github.com/pandas-dev/pandas/commit/a774ee84485412459f7205cccd87b639022afd07", "title": "GitHub Commit" }, { "url": "https://github.com/pandas-dev/pandas/pull/8986", "title": "GitHub PR" } ] } } } ], "links": { "self": "/orgs/00000000-0000-0000-0000-000000000000/packages/pkg%3Apypi%2Fpandas%400.15.0/issues?version=2024-06-26&limit=1000&offset=0" }, "meta": { "package": { "name": "pandas", "type": "pypi", "url": "pkg:pypi/pandas@0.15.0", "version": "0.15.0" } } } ================================================ FILE: lib/snyk/testdata/self.json ================================================ { "jsonapi": { "version": "1.0" }, "data": { "type": "user", "id": "00000000-0000-0000-0000-000000000000", "attributes": { "name": "jane.doe@example.com", "default_org_context": "00000000-0000-0000-0000-000000000000", "username": "jane.doe@example.com", "email": "jane.doe@example.com", "avatar_url": "http://example.com/avatar.png" } }, "links": { "self": "/self?version=2024-06-26~experimental" } } ================================================ FILE: main.go ================================================ /* * © 2023 Snyk Limited All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package main import ( "os" "github.com/snyk/parlay/internal/commands" ) func main() { if err := commands.NewDefaultCommand().Execute(); err != nil { os.Exit(1) } } ================================================ FILE: snyk/issues/issues.go ================================================ // Package issues provides primitives to interact with the openapi HTTP API. // // Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT. package issues import ( "bytes" "context" "encoding/json" "errors" "fmt" "io" "net/http" "net/url" "strings" "time" "github.com/oapi-codegen/runtime" openapi_types "github.com/oapi-codegen/runtime/types" ) const ( APITokenScopes = "APIToken.Scopes" BearerAuthScopes = "BearerAuth.Scopes" ) // Defines values for ClassTypeDef. const ( Compliance ClassTypeDef = "compliance" RuleCategory ClassTypeDef = "rule-category" Weakness ClassTypeDef = "weakness" ) // Defines values for CommonIssueModelVThreeAttributesEffectiveSeverityLevel. const ( CommonIssueModelVThreeAttributesEffectiveSeverityLevelCritical CommonIssueModelVThreeAttributesEffectiveSeverityLevel = "critical" CommonIssueModelVThreeAttributesEffectiveSeverityLevelHigh CommonIssueModelVThreeAttributesEffectiveSeverityLevel = "high" CommonIssueModelVThreeAttributesEffectiveSeverityLevelInfo CommonIssueModelVThreeAttributesEffectiveSeverityLevel = "info" CommonIssueModelVThreeAttributesEffectiveSeverityLevelLow CommonIssueModelVThreeAttributesEffectiveSeverityLevel = "low" CommonIssueModelVThreeAttributesEffectiveSeverityLevelMedium CommonIssueModelVThreeAttributesEffectiveSeverityLevel = "medium" ) // Defines values for IgnoreType. const ( Ignore IgnoreType = "ignore" ) // Defines values for IssueAttributesCoordinatesReachability. const ( Function IssueAttributesCoordinatesReachability = "function" NoInfo IssueAttributesCoordinatesReachability = "no-info" NotApplicable IssueAttributesCoordinatesReachability = "not-applicable" Package IssueAttributesCoordinatesReachability = "package" ) // Defines values for IssueAttributesCoordinatesRemediesType. const ( IssueAttributesCoordinatesRemediesTypeArm IssueAttributesCoordinatesRemediesType = "arm" IssueAttributesCoordinatesRemediesTypeAutomated IssueAttributesCoordinatesRemediesType = "automated" IssueAttributesCoordinatesRemediesTypeCli IssueAttributesCoordinatesRemediesType = "cli" IssueAttributesCoordinatesRemediesTypeCloudformation IssueAttributesCoordinatesRemediesType = "cloudformation" IssueAttributesCoordinatesRemediesTypeIndeterminate IssueAttributesCoordinatesRemediesType = "indeterminate" IssueAttributesCoordinatesRemediesTypeKubernetes IssueAttributesCoordinatesRemediesType = "kubernetes" IssueAttributesCoordinatesRemediesTypeManual IssueAttributesCoordinatesRemediesType = "manual" IssueAttributesCoordinatesRemediesTypeRuleResultMessage IssueAttributesCoordinatesRemediesType = "rule_result_message" IssueAttributesCoordinatesRemediesTypeTerraform IssueAttributesCoordinatesRemediesType = "terraform" ) // Defines values for IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType. const ( IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentTypeAws IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType = "aws" IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentTypeAzure IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType = "azure" IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentTypeAzureAd IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType = "azure_ad" IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentTypeCli IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType = "cli" IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentTypeGoogle IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType = "google" IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentTypeScm IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType = "scm" IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentTypeTfc IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType = "tfc" ) // Defines values for IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType. const ( Arm IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "arm" Cfn IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "cfn" CloudScan IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "cloud_scan" K8s IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "k8s" Tf IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "tf" TfHcl IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "tf_hcl" TfPlan IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "tf_plan" TfState IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType = "tf_state" ) // Defines values for IssueAttributesCoordinatesRepresentations2CloudResourceResourceType. const ( IssueAttributesCoordinatesRepresentations2CloudResourceResourceTypeCloud IssueAttributesCoordinatesRepresentations2CloudResourceResourceType = "cloud" IssueAttributesCoordinatesRepresentations2CloudResourceResourceTypeIac IssueAttributesCoordinatesRepresentations2CloudResourceResourceType = "iac" ) // Defines values for IssueAttributesEffectiveSeverityLevel. const ( IssueAttributesEffectiveSeverityLevelCritical IssueAttributesEffectiveSeverityLevel = "critical" IssueAttributesEffectiveSeverityLevelHigh IssueAttributesEffectiveSeverityLevel = "high" IssueAttributesEffectiveSeverityLevelInfo IssueAttributesEffectiveSeverityLevel = "info" IssueAttributesEffectiveSeverityLevelLow IssueAttributesEffectiveSeverityLevel = "low" IssueAttributesEffectiveSeverityLevelMedium IssueAttributesEffectiveSeverityLevel = "medium" ) // Defines values for IssueAttributesStatus. const ( IssueAttributesStatusOpen IssueAttributesStatus = "open" IssueAttributesStatusResolved IssueAttributesStatus = "resolved" ) // Defines values for IssueType. const ( IssueTypeIssue IssueType = "issue" ) // Defines values for OrganizationType. const ( Organization OrganizationType = "organization" ) // Defines values for ProblemTypeDef. const ( Rule ProblemTypeDef = "rule" Vulnerability ProblemTypeDef = "vulnerability" ) // Defines values for ResolutionTypeDef. const ( Disappeared ResolutionTypeDef = "disappeared" Fixed ResolutionTypeDef = "fixed" ) // Defines values for ScanItemType. const ( Environment ScanItemType = "environment" Project ScanItemType = "project" ) // Defines values for TestExecutionType. const ( CustomExecution TestExecutionType = "custom-execution" TestWorkflowExecution TestExecutionType = "test-workflow-execution" ) // Defines values for TypeDef. const ( TypeDefCloud TypeDef = "cloud" TypeDefCode TypeDef = "code" TypeDefConfig TypeDef = "config" TypeDefCustom TypeDef = "custom" TypeDefLicense TypeDef = "license" TypeDefPackageVulnerability TypeDef = "package_vulnerability" ) // Defines values for ListGroupIssuesParamsEffectiveSeverityLevel. const ( ListGroupIssuesParamsEffectiveSeverityLevelCritical ListGroupIssuesParamsEffectiveSeverityLevel = "critical" ListGroupIssuesParamsEffectiveSeverityLevelHigh ListGroupIssuesParamsEffectiveSeverityLevel = "high" ListGroupIssuesParamsEffectiveSeverityLevelInfo ListGroupIssuesParamsEffectiveSeverityLevel = "info" ListGroupIssuesParamsEffectiveSeverityLevelLow ListGroupIssuesParamsEffectiveSeverityLevel = "low" ListGroupIssuesParamsEffectiveSeverityLevelMedium ListGroupIssuesParamsEffectiveSeverityLevel = "medium" ) // Defines values for ListGroupIssuesParamsStatus. const ( ListGroupIssuesParamsStatusOpen ListGroupIssuesParamsStatus = "open" ListGroupIssuesParamsStatusResolved ListGroupIssuesParamsStatus = "resolved" ) // Defines values for ListOrgIssuesParamsEffectiveSeverityLevel. const ( ListOrgIssuesParamsEffectiveSeverityLevelCritical ListOrgIssuesParamsEffectiveSeverityLevel = "critical" ListOrgIssuesParamsEffectiveSeverityLevelHigh ListOrgIssuesParamsEffectiveSeverityLevel = "high" ListOrgIssuesParamsEffectiveSeverityLevelInfo ListOrgIssuesParamsEffectiveSeverityLevel = "info" ListOrgIssuesParamsEffectiveSeverityLevelLow ListOrgIssuesParamsEffectiveSeverityLevel = "low" ListOrgIssuesParamsEffectiveSeverityLevelMedium ListOrgIssuesParamsEffectiveSeverityLevel = "medium" ) // Defines values for ListOrgIssuesParamsStatus. const ( Open ListOrgIssuesParamsStatus = "open" Resolved ListOrgIssuesParamsStatus = "resolved" ) // ActualVersion Resolved API version type ActualVersion = string // BulkPackageUrlsRequestBody defines model for BulkPackageUrlsRequestBody. type BulkPackageUrlsRequestBody struct { Data struct { Attributes struct { // Purls An array of Package URLs (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required. Purls []string `json:"purls"` } `json:"attributes"` Type *Types `json:"type,omitempty"` } `json:"data"` } // CVSSSource defines model for CVSSSource. type CVSSSource struct { Level string `json:"level"` // ModificationTime The time this CVSS data was last updated ModificationTime time.Time `json:"modification_time"` Score float32 `json:"score"` Source string `json:"source"` Vector string `json:"vector"` Version string `json:"version"` } // Class defines model for Class. type Class struct { Id string `json:"id"` Source string `json:"source"` Type ClassTypeDef `json:"type"` // Url An optional URL for this class. Url *string `json:"url,omitempty"` } // ClassTypeDef defines model for ClassTypeDef. type ClassTypeDef string // CommonIssueModelVThree defines model for CommonIssueModelVThree. type CommonIssueModelVThree struct { Attributes *struct { Coordinates *[]Coordinate `json:"coordinates,omitempty"` CreatedAt *time.Time `json:"created_at,omitempty"` // Description A description of the issue in Markdown format Description *string `json:"description,omitempty"` // EffectiveSeverityLevel The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies. EffectiveSeverityLevel *CommonIssueModelVThreeAttributesEffectiveSeverityLevel `json:"effective_severity_level,omitempty"` Problems *[]Problem3 `json:"problems,omitempty"` // Severities An array of dictionaries containing all known data related to the vulnerability Severities *[]Severity3 `json:"severities,omitempty"` Slots *Slots `json:"slots,omitempty"` // Title A human-readable title for this issue. Title *string `json:"title,omitempty"` // Type The issue type Type *string `json:"type,omitempty"` // UpdatedAt When the vulnerability information was last modified. UpdatedAt *time.Time `json:"updated_at,omitempty"` } `json:"attributes,omitempty"` // Id The Snyk ID of the vulnerability. Id *string `json:"id,omitempty"` // Type The type of the REST resource. Always ‘issue’. Type *string `json:"type,omitempty"` } // CommonIssueModelVThreeAttributesEffectiveSeverityLevel The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies. type CommonIssueModelVThreeAttributesEffectiveSeverityLevel string // Coordinate defines model for Coordinate. type Coordinate struct { Remedies *[]Remedy3 `json:"remedies,omitempty"` // Representations The affected versions of this vulnerability. Representations []Coordinate_Representations_Item `json:"representations"` } // Coordinate_Representations_Item defines model for Coordinate.representations.Item. type Coordinate_Representations_Item struct { union json.RawMessage } // DeployedRiskFactor defines model for DeployedRiskFactor. type DeployedRiskFactor struct { IncludedInScore *bool `json:"included_in_score,omitempty"` Links *RiskFactorLinks `json:"links,omitempty"` Name string `json:"name"` UpdatedAt time.Time `json:"updated_at"` Value bool `json:"value"` } // Error defines model for Error. type Error struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` // Links A link that leads to further details about this particular occurrance of the problem. Links *ErrorLink `json:"links,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } // ErrorDocument defines model for ErrorDocument. type ErrorDocument struct { Errors []Error `json:"errors"` Jsonapi JsonApi `json:"jsonapi"` } // ErrorLink A link that leads to further details about this particular occurrance of the problem. type ErrorLink struct { About *LinkProperty `json:"about,omitempty"` } // ExploitDetails Details about the exploits type ExploitDetails struct { // MaturityLevels List of maturity levels MaturityLevels *[]MaturityLevel `json:"maturity_levels,omitempty"` // Sources Sources for determining exploit maturity level, e.g., CISA, ExploitDB, Snyk. Sources *[]string `json:"sources,omitempty"` } // IgnoreType defines model for IgnoreType. type IgnoreType string // Issue A Snyk Issue. type Issue struct { // Attributes issue attributes Attributes IssueAttributes `json:"attributes"` Id openapi_types.UUID `json:"id"` // Relationships issue relationships Relationships IssueRelationships `json:"relationships"` Type IssueType `json:"type"` } // IssueAttributes issue attributes type IssueAttributes struct { // Classes A list of details for weakness data, policy, etc that are the class of this issue's source. Classes *[]Class `json:"classes,omitempty"` // Coordinates Where the issue originated, specific to issue type. Details on what // code, package, etc introduced the issue. An issue may be caused by // more than one coordinate. Coordinates *[]struct { IsFixableManually *bool `json:"is_fixable_manually,omitempty"` IsFixableSnyk *bool `json:"is_fixable_snyk,omitempty"` IsFixableUpstream *bool `json:"is_fixable_upstream,omitempty"` IsPatchable *bool `json:"is_patchable,omitempty"` IsPinnable *bool `json:"is_pinnable,omitempty"` IsUpgradeable *bool `json:"is_upgradeable,omitempty"` Reachability *IssueAttributesCoordinatesReachability `json:"reachability,omitempty"` Remedies *[]struct { // CorrelationId An optional identifier for correlating remedies between coordinates or across issues. They are scoped // to a single Project and test run. Remedies with the same correlation_id must have the same contents. CorrelationId *string `json:"correlation_id,omitempty"` // Description A markdown-formatted optional description of this remedy. Links are not permitted. Description *string `json:"description,omitempty"` Meta *struct { // Data Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized. Data map[string]interface{} `json:"data"` // SchemaVersion A schema version identifier the metadata object validates against. Note: this information is // only relevant in the domain of the API consumer: the issues system always considers metadata // just as an arbitrary object. SchemaVersion string `json:"schema_version"` } `json:"meta,omitempty"` Type IssueAttributesCoordinatesRemediesType `json:"type"` } `json:"remedies,omitempty"` // Representations A list of precise locations that surface an issue. A coordinate may have multiple representations. Representations *[]IssueAttributes_Coordinates_Representations_Item `json:"representations,omitempty"` } `json:"coordinates,omitempty"` // CreatedAt The creation time of this issue. CreatedAt time.Time `json:"created_at"` // Description A markdown-formatted optional description of this issue. Links are not permitted. Description *string `json:"description,omitempty"` // EffectiveSeverityLevel The computed effective severity of this issue. This is either the highest level from all included severities, // or an overridden value set via group level policy. EffectiveSeverityLevel IssueAttributesEffectiveSeverityLevel `json:"effective_severity_level"` ExploitDetails *struct { MaturityLevels []struct { Format string `json:"format"` Level string `json:"level"` } `json:"maturity_levels"` Sources []string `json:"sources"` } `json:"exploit_details,omitempty"` // Ignored A flag indicating if the issue is being ignored. Derived from the issue's ignore, which provides more details. Ignored bool `json:"ignored"` // Key An opaque key used for uniquely identifying this issue across test runs, within a project. Key string `json:"key"` // Problems A list of details for vulnerability data, policy, etc that are the source of this issue. Problems *[]Problem `json:"problems,omitempty"` // Resolution An optional field recording when and via what means an issue was resolved, if it was resolved. // Resolved issues are retained for XX days. Resolution *Resolution `json:"resolution,omitempty"` // Risk Risk prioritization information for an issue Risk *Risk `json:"risk,omitempty"` Severities *[]CVSSSource `json:"severities,omitempty"` // Status The issue's status. Derived from the issue's resolution, which provides more details. Status IssueAttributesStatus `json:"status"` // Title A human-readable title for this issue. Title string `json:"title"` // Tool An opaque identifier for corelating across test runs. Tool *string `json:"tool,omitempty"` // Type The type of an issue. Type TypeDef `json:"type"` // UpdatedAt The time when this issue was last modified. UpdatedAt time.Time `json:"updated_at"` } // IssueAttributesCoordinatesReachability defines model for IssueAttributes.Coordinates.Reachability. type IssueAttributesCoordinatesReachability string // IssueAttributesCoordinatesRemediesType defines model for IssueAttributes.Coordinates.Remedies.Type. type IssueAttributesCoordinatesRemediesType string // IssueAttributesCoordinatesRepresentations0 An object that contains an opaque identifying string. type IssueAttributesCoordinatesRepresentations0 struct { ResourcePath string `json:"resourcePath"` } // IssueAttributesCoordinatesRepresentations1 An object that contains a list of opaque identifying strings. type IssueAttributesCoordinatesRepresentations1 struct { Dependency struct { // PackageName The package name the issue was found in PackageName string `json:"package_name"` // PackageVersion The package version the issue was found in PackageVersion string `json:"package_version"` } `json:"dependency"` } // IssueAttributesCoordinatesRepresentations2 A resource location to some service, like a cloud resource. type IssueAttributesCoordinatesRepresentations2 struct { CloudResource struct { Environment struct { // Id Internal ID for an environment. Id openapi_types.UUID `json:"id"` Name string `json:"name"` // NativeId An optional native identifier for this environment. For example, a cloud account id. NativeId *string `json:"native_id,omitempty"` Type IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType `json:"type"` } `json:"environment"` Resource *struct { // IacMappingsCount Amount of IaC resources this resource maps to. IacMappingsCount *int64 `json:"iac_mappings_count,omitempty"` // Id Internal ID for a resource. Id *openapi_types.UUID `json:"id,omitempty"` InputType IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType `json:"input_type"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` // NativeId An optional native identifier for this resource. For example, a cloud resource id. NativeId *string `json:"native_id,omitempty"` Platform *string `json:"platform,omitempty"` ResourceType *string `json:"resource_type,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *IssueAttributesCoordinatesRepresentations2CloudResourceResourceType `json:"type,omitempty"` } `json:"resource,omitempty"` } `json:"cloud_resource"` } // IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType defines model for IssueAttributes.Coordinates.Representations.2.CloudResource.Environment.Type. type IssueAttributesCoordinatesRepresentations2CloudResourceEnvironmentType string // IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType defines model for IssueAttributes.Coordinates.Representations.2.CloudResource.Resource.InputType. type IssueAttributesCoordinatesRepresentations2CloudResourceResourceInputType string // IssueAttributesCoordinatesRepresentations2CloudResourceResourceType defines model for IssueAttributes.Coordinates.Representations.2.CloudResource.Resource.Type. type IssueAttributesCoordinatesRepresentations2CloudResourceResourceType string // IssueAttributesCoordinatesRepresentations3 A location within a file. type IssueAttributesCoordinatesRepresentations3 struct { SourceLocation struct { // File A path to the file containing this issue, relative to the root of the project target, // formatted using POSIX separators. File string `json:"file"` Region *struct { End struct { Column int `json:"column"` Line int `json:"line"` } `json:"end"` Start struct { Column int `json:"column"` Line int `json:"line"` } `json:"start"` } `json:"region,omitempty"` } `json:"sourceLocation"` } // IssueAttributes_Coordinates_Representations_Item defines model for IssueAttributes.Coordinates.Representations.Item. type IssueAttributes_Coordinates_Representations_Item struct { union json.RawMessage } // IssueAttributesEffectiveSeverityLevel The computed effective severity of this issue. This is either the highest level from all included severities, // or an overridden value set via group level policy. type IssueAttributesEffectiveSeverityLevel string // IssueAttributesStatus The issue's status. Derived from the issue's resolution, which provides more details. type IssueAttributesStatus string // IssueRelationships issue relationships type IssueRelationships struct { // Ignore An optional reference to an ignore rule that marks this issue as ignored. Ignore *struct { Data struct { Id string `json:"id"` Type IgnoreType `json:"type"` } `json:"data"` } `json:"ignore,omitempty"` Organization struct { Data struct { Id openapi_types.UUID `json:"id"` Type OrganizationType `json:"type"` } `json:"data"` } `json:"organization"` ScanItem struct { Data struct { Id openapi_types.UUID `json:"id"` Type ScanItemType `json:"type"` } `json:"data"` } `json:"scan_item"` // TestExecutions The "test execution" that identified this Issues. This ID represents // a grouping of issues, that were identified by some analysis run, to produce // Issues. TestExecutions *struct { // Data List of metadata associated with the test executions that identified this issue Data []struct { Id string `json:"id"` Type TestExecutionType `json:"type"` } `json:"data"` } `json:"test_executions,omitempty"` } // IssueType defines model for IssueType. type IssueType string // IssuesMeta defines model for IssuesMeta. type IssuesMeta struct { Package *PackageMeta `json:"package,omitempty"` } // IssuesResponse defines model for IssuesResponse. type IssuesResponse struct { Data *[]CommonIssueModelVThree `json:"data,omitempty"` Jsonapi *JsonApi `json:"jsonapi,omitempty"` Links *PaginatedLinks `json:"links,omitempty"` Meta *IssuesMeta `json:"meta,omitempty"` } // IssuesWithPurlsResponse defines model for IssuesWithPurlsResponse. type IssuesWithPurlsResponse struct { Data *[]CommonIssueModelVThree `json:"data,omitempty"` Jsonapi *JsonApi `json:"jsonapi,omitempty"` Links *PaginatedLinks `json:"links,omitempty"` Meta *struct { Errors *[]Error `json:"errors,omitempty"` } `json:"meta,omitempty"` } // JsonApi defines model for JsonApi. type JsonApi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } // LinkProperty defines model for LinkProperty. type LinkProperty struct { union json.RawMessage } // LinkProperty0 A string containing the link’s URL. type LinkProperty0 = string // LinkProperty1 defines model for . type LinkProperty1 struct { // Href A string containing the link’s URL. Href string `json:"href"` // Meta Free-form object that may contain non-standard information. Meta *Meta `json:"meta,omitempty"` } // LoadedPackageRiskFactor defines model for LoadedPackageRiskFactor. type LoadedPackageRiskFactor struct { IncludedInScore *bool `json:"included_in_score,omitempty"` Links *RiskFactorLinks `json:"links,omitempty"` Name string `json:"name"` UpdatedAt time.Time `json:"updated_at"` Value bool `json:"value"` } // MaturityLevel Details about the maturity level type MaturityLevel struct { // Format The standard by which the “maturity” value is shown. Format *string `json:"format,omitempty"` // Level Exploit maturity of the vulnerability. For CVSSv3: Proof of Concept, Functional, High. For CVSSv4: Unreported, Proof of Concept, Attacked. Level *string `json:"level,omitempty"` // Type Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector. Type *string `json:"type,omitempty"` } // Meta Free-form object that may contain non-standard information. type Meta map[string]interface{} // OSConditionRiskFactor defines model for OSConditionRiskFactor. type OSConditionRiskFactor struct { IncludedInScore *bool `json:"included_in_score,omitempty"` Links *RiskFactorLinks `json:"links,omitempty"` Name string `json:"name"` UpdatedAt time.Time `json:"updated_at"` Value bool `json:"value"` } // OrganizationType defines model for OrganizationType. type OrganizationType string // PackageMeta defines model for PackageMeta. type PackageMeta struct { // Name The package’s name Name *string `json:"name,omitempty"` // Namespace A name prefix, such as a maven group id or docker image owner Namespace *string `json:"namespace,omitempty"` // Type The package type or protocol Type *string `json:"type,omitempty"` // Url The purl of the package Url *string `json:"url,omitempty"` // Version The version of the package Version *string `json:"version,omitempty"` } // PackageRepresentation defines model for PackageRepresentation. type PackageRepresentation struct { Package *PackageMeta `json:"package,omitempty"` } // PaginatedLinks defines model for PaginatedLinks. type PaginatedLinks struct { First *LinkProperty `json:"first,omitempty"` Last *LinkProperty `json:"last,omitempty"` Next *LinkProperty `json:"next,omitempty"` Prev *LinkProperty `json:"prev,omitempty"` Self *LinkProperty `json:"self,omitempty"` } // Problem defines model for Problem. type Problem struct { // DisclosedAt When this problem was disclosed to the public. DisclosedAt *time.Time `json:"disclosed_at,omitempty"` // DiscoveredAt When this problem was first discovered. DiscoveredAt *time.Time `json:"discovered_at,omitempty"` Id string `json:"id"` Source string `json:"source"` Type ProblemTypeDef `json:"type"` // UpdatedAt When this problem was last updated. UpdatedAt *time.Time `json:"updated_at,omitempty"` // Url An optional URL for this problem. Url *string `json:"url,omitempty"` } // Problem3 defines model for Problem3. type Problem3 struct { // DisclosedAt When this problem was disclosed to the public. DisclosedAt *time.Time `json:"disclosed_at,omitempty"` // DiscoveredAt When this problem was first discovered. DiscoveredAt *time.Time `json:"discovered_at,omitempty"` Id string `json:"id"` Source string `json:"source"` // UpdatedAt When this problem was last updated. UpdatedAt *time.Time `json:"updated_at,omitempty"` // Url An optional URL for this problem. Url *string `json:"url,omitempty"` } // ProblemTypeDef defines model for ProblemTypeDef. type ProblemTypeDef string // PublicFacingRiskFactor defines model for PublicFacingRiskFactor. type PublicFacingRiskFactor struct { IncludedInScore *bool `json:"included_in_score,omitempty"` Links *RiskFactorLinks `json:"links,omitempty"` Name string `json:"name"` UpdatedAt time.Time `json:"updated_at"` Value bool `json:"value"` } // QueryVersion Requested API version type QueryVersion = string // Remedy3 defines model for Remedy3. type Remedy3 struct { // Description A markdown-formatted optional description of this remedy. Description *string `json:"description,omitempty"` Details *struct { // UpgradePackage A minimum version to upgrade to in order to remedy the issue. UpgradePackage *string `json:"upgrade_package,omitempty"` } `json:"details,omitempty"` // Type The type of the remedy. Always ‘indeterminate’. Type *string `json:"type,omitempty"` } // Resolution An optional field recording when and via what means an issue was resolved, if it was resolved. // Resolved issues are retained for XX days. type Resolution struct { // Details Optional details about the resolution. Used by Snyk Cloud so far. Details *string `json:"details,omitempty"` // ResolvedAt The time when this issue was resolved. ResolvedAt time.Time `json:"resolved_at"` Type ResolutionTypeDef `json:"type"` } // ResolutionTypeDef defines model for ResolutionTypeDef. type ResolutionTypeDef string // ResourcePath defines model for ResourcePath. type ResourcePath = string // ResourcePathRepresentation An object that contains an opaque identifying string. type ResourcePathRepresentation struct { ResourcePath ResourcePath `json:"resource_path"` } // Risk Risk prioritization information for an issue type Risk struct { // Factors Risk factors identified for an issue Factors []RiskFactor `json:"factors"` // Score Risk prioritization score based on an analysis model Score *RiskScore `json:"score,omitempty"` } // RiskFactor defines model for RiskFactor. type RiskFactor struct { union json.RawMessage } // RiskFactorLinks defines model for RiskFactorLinks. type RiskFactorLinks struct { Evidence *LinkProperty `json:"evidence,omitempty"` } // RiskScore Risk prioritization score based on an analysis model type RiskScore struct { // Model Risk scoring model used to calculate the score value Model string `json:"model"` UpdatedAt *time.Time `json:"updated_at,omitempty"` // Value Risk score value, which may be used for overall prioritization Value int `json:"value"` } // ScanItemType defines model for ScanItemType. type ScanItemType string // Severity3 defines model for Severity3. type Severity3 struct { // Level Level of severity calculated via vector Level *string `json:"level,omitempty"` // Score The CVSS score calculated from the vector, representing the severity of the vulnerability on a scale from 0 to 10. Score *float32 `json:"score"` // Source The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application. Source *string `json:"source,omitempty"` // Type Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector. Type *string `json:"type,omitempty"` // Vector CVSS vector string detailing the metrics of a vulnerability. Vector *string `json:"vector"` // Version CVSS version being described. Version *string `json:"version,omitempty"` } // Slots defines model for Slots. type Slots struct { // DisclosureTime The time at which this vulnerability was disclosed. DisclosureTime *time.Time `json:"disclosure_time,omitempty"` // ExploitDetails Details about the exploits ExploitDetails *ExploitDetails `json:"exploit_details,omitempty"` // PublicationTime The time at which this vulnerability was published. PublicationTime *string `json:"publication_time,omitempty"` References *[]struct { // Title Descriptor for an external reference to the issue Title *string `json:"title,omitempty"` // Url URL for an external reference to the issue Url *string `json:"url,omitempty"` } `json:"references,omitempty"` } // TestExecutionType defines model for TestExecutionType. type TestExecutionType string // TypeDef The type of an issue. type TypeDef string // Types defines model for Types. type Types = string // CreatedAfter defines model for CreatedAfter. type CreatedAfter = time.Time // CreatedBefore defines model for CreatedBefore. type CreatedBefore = time.Time // EffectiveSeverityLevel defines model for EffectiveSeverityLevel. type EffectiveSeverityLevel = []string // EndingBefore defines model for EndingBefore. type EndingBefore = string // Ignored defines model for Ignored. type Ignored = bool // Limit defines model for Limit. type Limit = int32 // OrgId defines model for OrgId. type OrgId = openapi_types.UUID // PackageUrl defines model for PackageUrl. type PackageUrl = string // PathIssueId20240123 defines model for PathIssueId20240123. type PathIssueId20240123 = openapi_types.UUID // ScanItemId defines model for ScanItemId. type ScanItemId = openapi_types.UUID // StartingAfter defines model for StartingAfter. type StartingAfter = string // Status defines model for Status. type Status = []string // Type The type of an issue. type Type = TypeDef // UpdatedAfter defines model for UpdatedAfter. type UpdatedAfter = time.Time // UpdatedBefore defines model for UpdatedBefore. type UpdatedBefore = time.Time // Version Requested API version type Version = QueryVersion // N400 defines model for 400. type N400 = ErrorDocument // N401 defines model for 401. type N401 = ErrorDocument // N403 defines model for 403. type N403 = ErrorDocument // N404 defines model for 404. type N404 = ErrorDocument // N409 defines model for 409. type N409 = ErrorDocument // N500 defines model for 500. type N500 = ErrorDocument // GetIssue20020240123 defines model for GetIssue20020240123. type GetIssue20020240123 struct { // Data A Snyk Issue. Data Issue `json:"data"` Jsonapi JsonApi `json:"jsonapi"` Links *PaginatedLinks `json:"links,omitempty"` } // ListIssues200 defines model for ListIssues200. type ListIssues200 struct { Data []Issue `json:"data"` Jsonapi JsonApi `json:"jsonapi"` Links *PaginatedLinks `json:"links,omitempty"` } // ListGroupIssuesParams defines parameters for ListGroupIssues. type ListGroupIssuesParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` // StartingAfter Return the page of results immediately after this cursor StartingAfter *StartingAfter `form:"starting_after,omitempty" json:"starting_after,omitempty"` // EndingBefore Return the page of results immediately before this cursor EndingBefore *EndingBefore `form:"ending_before,omitempty" json:"ending_before,omitempty"` // Limit Number of results to return per page Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"` // ScanItemId A scan item id to filter issues through their scan item relationship. ScanItemId *ScanItemId `form:"scan_item.id,omitempty" json:"scan_item.id,omitempty"` // ScanItemType A scan item types to filter issues through their scan item relationship. ScanItemType *ScanItemType `form:"scan_item.type,omitempty" json:"scan_item.type,omitempty"` // Type An issue type to filter issues. Type *Type `form:"type,omitempty" json:"type,omitempty"` // UpdatedBefore A filter to select issues updated before this date. UpdatedBefore *UpdatedBefore `form:"updated_before,omitempty" json:"updated_before,omitempty"` // UpdatedAfter A filter to select issues updated after this date. UpdatedAfter *UpdatedAfter `form:"updated_after,omitempty" json:"updated_after,omitempty"` // CreatedBefore A filter to select issues created before this date. CreatedBefore *CreatedBefore `form:"created_before,omitempty" json:"created_before,omitempty"` // CreatedAfter A filter to select issues created after this date. CreatedAfter *CreatedAfter `form:"created_after,omitempty" json:"created_after,omitempty"` // EffectiveSeverityLevel One or more effective severity levels to filter issues. EffectiveSeverityLevel *EffectiveSeverityLevel `form:"effective_severity_level,omitempty" json:"effective_severity_level,omitempty"` // Status An issue's status Status *Status `form:"status,omitempty" json:"status,omitempty"` // Ignored Whether an issue is ignored or not. Ignored *Ignored `form:"ignored,omitempty" json:"ignored,omitempty"` } // ListGroupIssuesParamsEffectiveSeverityLevel defines parameters for ListGroupIssues. type ListGroupIssuesParamsEffectiveSeverityLevel string // ListGroupIssuesParamsStatus defines parameters for ListGroupIssues. type ListGroupIssuesParamsStatus string // GetGroupIssueByIssueIDParams defines parameters for GetGroupIssueByIssueID. type GetGroupIssueByIssueIDParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` } // ListOrgIssuesParams defines parameters for ListOrgIssues. type ListOrgIssuesParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` // StartingAfter Return the page of results immediately after this cursor StartingAfter *StartingAfter `form:"starting_after,omitempty" json:"starting_after,omitempty"` // EndingBefore Return the page of results immediately before this cursor EndingBefore *EndingBefore `form:"ending_before,omitempty" json:"ending_before,omitempty"` // Limit Number of results to return per page Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"` // ScanItemId A scan item id to filter issues through their scan item relationship. ScanItemId *ScanItemId `form:"scan_item.id,omitempty" json:"scan_item.id,omitempty"` // ScanItemType A scan item types to filter issues through their scan item relationship. ScanItemType *ScanItemType `form:"scan_item.type,omitempty" json:"scan_item.type,omitempty"` // Type An issue type to filter issues. Type *Type `form:"type,omitempty" json:"type,omitempty"` // UpdatedBefore A filter to select issues updated before this date. UpdatedBefore *UpdatedBefore `form:"updated_before,omitempty" json:"updated_before,omitempty"` // UpdatedAfter A filter to select issues updated after this date. UpdatedAfter *UpdatedAfter `form:"updated_after,omitempty" json:"updated_after,omitempty"` // CreatedBefore A filter to select issues created before this date. CreatedBefore *CreatedBefore `form:"created_before,omitempty" json:"created_before,omitempty"` // CreatedAfter A filter to select issues created after this date. CreatedAfter *CreatedAfter `form:"created_after,omitempty" json:"created_after,omitempty"` // EffectiveSeverityLevel One or more effective severity levels to filter issues. EffectiveSeverityLevel *EffectiveSeverityLevel `form:"effective_severity_level,omitempty" json:"effective_severity_level,omitempty"` // Status An issue's status Status *Status `form:"status,omitempty" json:"status,omitempty"` // Ignored Whether an issue is ignored or not. Ignored *Ignored `form:"ignored,omitempty" json:"ignored,omitempty"` } // ListOrgIssuesParamsEffectiveSeverityLevel defines parameters for ListOrgIssues. type ListOrgIssuesParamsEffectiveSeverityLevel string // ListOrgIssuesParamsStatus defines parameters for ListOrgIssues. type ListOrgIssuesParamsStatus string // GetOrgIssueByIssueIDParams defines parameters for GetOrgIssueByIssueID. type GetOrgIssueByIssueIDParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` } // ListIssuesForManyPurlsParams defines parameters for ListIssuesForManyPurls. type ListIssuesForManyPurlsParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` } // FetchIssuesPerPurlParams defines parameters for FetchIssuesPerPurl. type FetchIssuesPerPurlParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` // Offset Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0. Offset *float32 `form:"offset,omitempty" json:"offset,omitempty"` // Limit Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000. Limit *float32 `form:"limit,omitempty" json:"limit,omitempty"` } // ListIssuesForManyPurlsApplicationVndAPIPlusJSONRequestBody defines body for ListIssuesForManyPurls for application/vnd.api+json ContentType. type ListIssuesForManyPurlsApplicationVndAPIPlusJSONRequestBody = BulkPackageUrlsRequestBody // AsResourcePathRepresentation returns the union data inside the Coordinate_Representations_Item as a ResourcePathRepresentation func (t Coordinate_Representations_Item) AsResourcePathRepresentation() (ResourcePathRepresentation, error) { var body ResourcePathRepresentation err := json.Unmarshal(t.union, &body) return body, err } // FromResourcePathRepresentation overwrites any union data inside the Coordinate_Representations_Item as the provided ResourcePathRepresentation func (t *Coordinate_Representations_Item) FromResourcePathRepresentation(v ResourcePathRepresentation) error { b, err := json.Marshal(v) t.union = b return err } // MergeResourcePathRepresentation performs a merge with any union data inside the Coordinate_Representations_Item, using the provided ResourcePathRepresentation func (t *Coordinate_Representations_Item) MergeResourcePathRepresentation(v ResourcePathRepresentation) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsPackageRepresentation returns the union data inside the Coordinate_Representations_Item as a PackageRepresentation func (t Coordinate_Representations_Item) AsPackageRepresentation() (PackageRepresentation, error) { var body PackageRepresentation err := json.Unmarshal(t.union, &body) return body, err } // FromPackageRepresentation overwrites any union data inside the Coordinate_Representations_Item as the provided PackageRepresentation func (t *Coordinate_Representations_Item) FromPackageRepresentation(v PackageRepresentation) error { b, err := json.Marshal(v) t.union = b return err } // MergePackageRepresentation performs a merge with any union data inside the Coordinate_Representations_Item, using the provided PackageRepresentation func (t *Coordinate_Representations_Item) MergePackageRepresentation(v PackageRepresentation) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } func (t Coordinate_Representations_Item) MarshalJSON() ([]byte, error) { b, err := t.union.MarshalJSON() return b, err } func (t *Coordinate_Representations_Item) UnmarshalJSON(b []byte) error { err := t.union.UnmarshalJSON(b) return err } // AsIssueAttributesCoordinatesRepresentations0 returns the union data inside the IssueAttributes_Coordinates_Representations_Item as a IssueAttributesCoordinatesRepresentations0 func (t IssueAttributes_Coordinates_Representations_Item) AsIssueAttributesCoordinatesRepresentations0() (IssueAttributesCoordinatesRepresentations0, error) { var body IssueAttributesCoordinatesRepresentations0 err := json.Unmarshal(t.union, &body) return body, err } // FromIssueAttributesCoordinatesRepresentations0 overwrites any union data inside the IssueAttributes_Coordinates_Representations_Item as the provided IssueAttributesCoordinatesRepresentations0 func (t *IssueAttributes_Coordinates_Representations_Item) FromIssueAttributesCoordinatesRepresentations0(v IssueAttributesCoordinatesRepresentations0) error { b, err := json.Marshal(v) t.union = b return err } // MergeIssueAttributesCoordinatesRepresentations0 performs a merge with any union data inside the IssueAttributes_Coordinates_Representations_Item, using the provided IssueAttributesCoordinatesRepresentations0 func (t *IssueAttributes_Coordinates_Representations_Item) MergeIssueAttributesCoordinatesRepresentations0(v IssueAttributesCoordinatesRepresentations0) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsIssueAttributesCoordinatesRepresentations1 returns the union data inside the IssueAttributes_Coordinates_Representations_Item as a IssueAttributesCoordinatesRepresentations1 func (t IssueAttributes_Coordinates_Representations_Item) AsIssueAttributesCoordinatesRepresentations1() (IssueAttributesCoordinatesRepresentations1, error) { var body IssueAttributesCoordinatesRepresentations1 err := json.Unmarshal(t.union, &body) return body, err } // FromIssueAttributesCoordinatesRepresentations1 overwrites any union data inside the IssueAttributes_Coordinates_Representations_Item as the provided IssueAttributesCoordinatesRepresentations1 func (t *IssueAttributes_Coordinates_Representations_Item) FromIssueAttributesCoordinatesRepresentations1(v IssueAttributesCoordinatesRepresentations1) error { b, err := json.Marshal(v) t.union = b return err } // MergeIssueAttributesCoordinatesRepresentations1 performs a merge with any union data inside the IssueAttributes_Coordinates_Representations_Item, using the provided IssueAttributesCoordinatesRepresentations1 func (t *IssueAttributes_Coordinates_Representations_Item) MergeIssueAttributesCoordinatesRepresentations1(v IssueAttributesCoordinatesRepresentations1) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsIssueAttributesCoordinatesRepresentations2 returns the union data inside the IssueAttributes_Coordinates_Representations_Item as a IssueAttributesCoordinatesRepresentations2 func (t IssueAttributes_Coordinates_Representations_Item) AsIssueAttributesCoordinatesRepresentations2() (IssueAttributesCoordinatesRepresentations2, error) { var body IssueAttributesCoordinatesRepresentations2 err := json.Unmarshal(t.union, &body) return body, err } // FromIssueAttributesCoordinatesRepresentations2 overwrites any union data inside the IssueAttributes_Coordinates_Representations_Item as the provided IssueAttributesCoordinatesRepresentations2 func (t *IssueAttributes_Coordinates_Representations_Item) FromIssueAttributesCoordinatesRepresentations2(v IssueAttributesCoordinatesRepresentations2) error { b, err := json.Marshal(v) t.union = b return err } // MergeIssueAttributesCoordinatesRepresentations2 performs a merge with any union data inside the IssueAttributes_Coordinates_Representations_Item, using the provided IssueAttributesCoordinatesRepresentations2 func (t *IssueAttributes_Coordinates_Representations_Item) MergeIssueAttributesCoordinatesRepresentations2(v IssueAttributesCoordinatesRepresentations2) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsIssueAttributesCoordinatesRepresentations3 returns the union data inside the IssueAttributes_Coordinates_Representations_Item as a IssueAttributesCoordinatesRepresentations3 func (t IssueAttributes_Coordinates_Representations_Item) AsIssueAttributesCoordinatesRepresentations3() (IssueAttributesCoordinatesRepresentations3, error) { var body IssueAttributesCoordinatesRepresentations3 err := json.Unmarshal(t.union, &body) return body, err } // FromIssueAttributesCoordinatesRepresentations3 overwrites any union data inside the IssueAttributes_Coordinates_Representations_Item as the provided IssueAttributesCoordinatesRepresentations3 func (t *IssueAttributes_Coordinates_Representations_Item) FromIssueAttributesCoordinatesRepresentations3(v IssueAttributesCoordinatesRepresentations3) error { b, err := json.Marshal(v) t.union = b return err } // MergeIssueAttributesCoordinatesRepresentations3 performs a merge with any union data inside the IssueAttributes_Coordinates_Representations_Item, using the provided IssueAttributesCoordinatesRepresentations3 func (t *IssueAttributes_Coordinates_Representations_Item) MergeIssueAttributesCoordinatesRepresentations3(v IssueAttributesCoordinatesRepresentations3) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } func (t IssueAttributes_Coordinates_Representations_Item) MarshalJSON() ([]byte, error) { b, err := t.union.MarshalJSON() return b, err } func (t *IssueAttributes_Coordinates_Representations_Item) UnmarshalJSON(b []byte) error { err := t.union.UnmarshalJSON(b) return err } // AsLinkProperty0 returns the union data inside the LinkProperty as a LinkProperty0 func (t LinkProperty) AsLinkProperty0() (LinkProperty0, error) { var body LinkProperty0 err := json.Unmarshal(t.union, &body) return body, err } // FromLinkProperty0 overwrites any union data inside the LinkProperty as the provided LinkProperty0 func (t *LinkProperty) FromLinkProperty0(v LinkProperty0) error { b, err := json.Marshal(v) t.union = b return err } // MergeLinkProperty0 performs a merge with any union data inside the LinkProperty, using the provided LinkProperty0 func (t *LinkProperty) MergeLinkProperty0(v LinkProperty0) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsLinkProperty1 returns the union data inside the LinkProperty as a LinkProperty1 func (t LinkProperty) AsLinkProperty1() (LinkProperty1, error) { var body LinkProperty1 err := json.Unmarshal(t.union, &body) return body, err } // FromLinkProperty1 overwrites any union data inside the LinkProperty as the provided LinkProperty1 func (t *LinkProperty) FromLinkProperty1(v LinkProperty1) error { b, err := json.Marshal(v) t.union = b return err } // MergeLinkProperty1 performs a merge with any union data inside the LinkProperty, using the provided LinkProperty1 func (t *LinkProperty) MergeLinkProperty1(v LinkProperty1) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } func (t LinkProperty) MarshalJSON() ([]byte, error) { b, err := t.union.MarshalJSON() return b, err } func (t *LinkProperty) UnmarshalJSON(b []byte) error { err := t.union.UnmarshalJSON(b) return err } // AsDeployedRiskFactor returns the union data inside the RiskFactor as a DeployedRiskFactor func (t RiskFactor) AsDeployedRiskFactor() (DeployedRiskFactor, error) { var body DeployedRiskFactor err := json.Unmarshal(t.union, &body) return body, err } // FromDeployedRiskFactor overwrites any union data inside the RiskFactor as the provided DeployedRiskFactor func (t *RiskFactor) FromDeployedRiskFactor(v DeployedRiskFactor) error { v.Name = "deployed" b, err := json.Marshal(v) t.union = b return err } // MergeDeployedRiskFactor performs a merge with any union data inside the RiskFactor, using the provided DeployedRiskFactor func (t *RiskFactor) MergeDeployedRiskFactor(v DeployedRiskFactor) error { v.Name = "deployed" b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsOSConditionRiskFactor returns the union data inside the RiskFactor as a OSConditionRiskFactor func (t RiskFactor) AsOSConditionRiskFactor() (OSConditionRiskFactor, error) { var body OSConditionRiskFactor err := json.Unmarshal(t.union, &body) return body, err } // FromOSConditionRiskFactor overwrites any union data inside the RiskFactor as the provided OSConditionRiskFactor func (t *RiskFactor) FromOSConditionRiskFactor(v OSConditionRiskFactor) error { v.Name = "os_condition" b, err := json.Marshal(v) t.union = b return err } // MergeOSConditionRiskFactor performs a merge with any union data inside the RiskFactor, using the provided OSConditionRiskFactor func (t *RiskFactor) MergeOSConditionRiskFactor(v OSConditionRiskFactor) error { v.Name = "os_condition" b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsPublicFacingRiskFactor returns the union data inside the RiskFactor as a PublicFacingRiskFactor func (t RiskFactor) AsPublicFacingRiskFactor() (PublicFacingRiskFactor, error) { var body PublicFacingRiskFactor err := json.Unmarshal(t.union, &body) return body, err } // FromPublicFacingRiskFactor overwrites any union data inside the RiskFactor as the provided PublicFacingRiskFactor func (t *RiskFactor) FromPublicFacingRiskFactor(v PublicFacingRiskFactor) error { v.Name = "public_facing" b, err := json.Marshal(v) t.union = b return err } // MergePublicFacingRiskFactor performs a merge with any union data inside the RiskFactor, using the provided PublicFacingRiskFactor func (t *RiskFactor) MergePublicFacingRiskFactor(v PublicFacingRiskFactor) error { v.Name = "public_facing" b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsLoadedPackageRiskFactor returns the union data inside the RiskFactor as a LoadedPackageRiskFactor func (t RiskFactor) AsLoadedPackageRiskFactor() (LoadedPackageRiskFactor, error) { var body LoadedPackageRiskFactor err := json.Unmarshal(t.union, &body) return body, err } // FromLoadedPackageRiskFactor overwrites any union data inside the RiskFactor as the provided LoadedPackageRiskFactor func (t *RiskFactor) FromLoadedPackageRiskFactor(v LoadedPackageRiskFactor) error { v.Name = "loaded_package" b, err := json.Marshal(v) t.union = b return err } // MergeLoadedPackageRiskFactor performs a merge with any union data inside the RiskFactor, using the provided LoadedPackageRiskFactor func (t *RiskFactor) MergeLoadedPackageRiskFactor(v LoadedPackageRiskFactor) error { v.Name = "loaded_package" b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } func (t RiskFactor) Discriminator() (string, error) { var discriminator struct { Discriminator string `json:"name"` } err := json.Unmarshal(t.union, &discriminator) return discriminator.Discriminator, err } func (t RiskFactor) ValueByDiscriminator() (interface{}, error) { discriminator, err := t.Discriminator() if err != nil { return nil, err } switch discriminator { case "deployed": return t.AsDeployedRiskFactor() case "loaded_package": return t.AsLoadedPackageRiskFactor() case "os_condition": return t.AsOSConditionRiskFactor() case "public_facing": return t.AsPublicFacingRiskFactor() default: return nil, errors.New("unknown discriminator value: " + discriminator) } } func (t RiskFactor) MarshalJSON() ([]byte, error) { b, err := t.union.MarshalJSON() return b, err } func (t *RiskFactor) UnmarshalJSON(b []byte) error { err := t.union.UnmarshalJSON(b) return err } // RequestEditorFn is the function signature for the RequestEditor callback function type RequestEditorFn func(ctx context.Context, req *http.Request) error // Doer performs HTTP requests. // // The standard http.Client implements this interface. type HttpRequestDoer interface { Do(req *http.Request) (*http.Response, error) } // Client which conforms to the OpenAPI3 specification for this service. type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn } // ClientOption allows setting custom parameters during construction type ClientOption func(*Client) error // Creates a new Client, with reasonable defaults func NewClient(server string, opts ...ClientOption) (*Client, error) { // create a client with sane default values client := Client{ Server: server, } // mutate client and add all optional params for _, o := range opts { if err := o(&client); err != nil { return nil, err } } // ensure the server URL always has a trailing slash if !strings.HasSuffix(client.Server, "/") { client.Server += "/" } // create httpClient, if not already present if client.Client == nil { client.Client = &http.Client{} } return &client, nil } // WithHTTPClient allows overriding the default Doer, which is // automatically created using http.Client. This is useful for tests. func WithHTTPClient(doer HttpRequestDoer) ClientOption { return func(c *Client) error { c.Client = doer return nil } } // WithRequestEditorFn allows setting up a callback function, which will be // called right before sending the request. This can be used to mutate the request. func WithRequestEditorFn(fn RequestEditorFn) ClientOption { return func(c *Client) error { c.RequestEditors = append(c.RequestEditors, fn) return nil } } // The interface specification for the client above. type ClientInterface interface { // ListGroupIssues request ListGroupIssues(ctx context.Context, groupId openapi_types.UUID, params *ListGroupIssuesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetGroupIssueByIssueID request GetGroupIssueByIssueID(ctx context.Context, groupId openapi_types.UUID, issueId PathIssueId20240123, params *GetGroupIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*http.Response, error) // ListOrgIssues request ListOrgIssues(ctx context.Context, orgId openapi_types.UUID, params *ListOrgIssuesParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetOrgIssueByIssueID request GetOrgIssueByIssueID(ctx context.Context, orgId openapi_types.UUID, issueId PathIssueId20240123, params *GetOrgIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*http.Response, error) // ListIssuesForManyPurlsWithBody request with any body ListIssuesForManyPurlsWithBody(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) ListIssuesForManyPurlsWithApplicationVndAPIPlusJSONBody(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) // FetchIssuesPerPurl request FetchIssuesPerPurl(ctx context.Context, orgId OrgId, purl PackageUrl, params *FetchIssuesPerPurlParams, reqEditors ...RequestEditorFn) (*http.Response, error) } func (c *Client) ListGroupIssues(ctx context.Context, groupId openapi_types.UUID, params *ListGroupIssuesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewListGroupIssuesRequest(c.Server, groupId, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetGroupIssueByIssueID(ctx context.Context, groupId openapi_types.UUID, issueId PathIssueId20240123, params *GetGroupIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetGroupIssueByIssueIDRequest(c.Server, groupId, issueId, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) ListOrgIssues(ctx context.Context, orgId openapi_types.UUID, params *ListOrgIssuesParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewListOrgIssuesRequest(c.Server, orgId, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetOrgIssueByIssueID(ctx context.Context, orgId openapi_types.UUID, issueId PathIssueId20240123, params *GetOrgIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetOrgIssueByIssueIDRequest(c.Server, orgId, issueId, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) ListIssuesForManyPurlsWithBody(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewListIssuesForManyPurlsRequestWithBody(c.Server, orgId, params, contentType, body) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) ListIssuesForManyPurlsWithApplicationVndAPIPlusJSONBody(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewListIssuesForManyPurlsRequestWithApplicationVndAPIPlusJSONBody(c.Server, orgId, params, body) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) FetchIssuesPerPurl(ctx context.Context, orgId OrgId, purl PackageUrl, params *FetchIssuesPerPurlParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewFetchIssuesPerPurlRequest(c.Server, orgId, purl, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } // NewListGroupIssuesRequest generates requests for ListGroupIssues func NewListGroupIssuesRequest(server string, groupId openapi_types.UUID, params *ListGroupIssuesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "group_id", runtime.ParamLocationPath, groupId) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/groups/%s/issues", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } if params.StartingAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "starting_after", runtime.ParamLocationQuery, *params.StartingAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.EndingBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "ending_before", runtime.ParamLocationQuery, *params.EndingBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Limit != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "limit", runtime.ParamLocationQuery, *params.Limit); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.ScanItemId != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "scan_item.id", runtime.ParamLocationQuery, *params.ScanItemId); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.ScanItemType != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "scan_item.type", runtime.ParamLocationQuery, *params.ScanItemType); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Type != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "type", runtime.ParamLocationQuery, *params.Type); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_before", runtime.ParamLocationQuery, *params.UpdatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_before", runtime.ParamLocationQuery, *params.CreatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.EffectiveSeverityLevel != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", false, "effective_severity_level", runtime.ParamLocationQuery, *params.EffectiveSeverityLevel); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Status != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", false, "status", runtime.ParamLocationQuery, *params.Status); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Ignored != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "ignored", runtime.ParamLocationQuery, *params.Ignored); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetGroupIssueByIssueIDRequest generates requests for GetGroupIssueByIssueID func NewGetGroupIssueByIssueIDRequest(server string, groupId openapi_types.UUID, issueId PathIssueId20240123, params *GetGroupIssueByIssueIDParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "group_id", runtime.ParamLocationPath, groupId) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "issue_id", runtime.ParamLocationPath, issueId) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/groups/%s/issues/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewListOrgIssuesRequest generates requests for ListOrgIssues func NewListOrgIssuesRequest(server string, orgId openapi_types.UUID, params *ListOrgIssuesParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "org_id", runtime.ParamLocationPath, orgId) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/orgs/%s/issues", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } if params.StartingAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "starting_after", runtime.ParamLocationQuery, *params.StartingAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.EndingBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "ending_before", runtime.ParamLocationQuery, *params.EndingBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Limit != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "limit", runtime.ParamLocationQuery, *params.Limit); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.ScanItemId != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "scan_item.id", runtime.ParamLocationQuery, *params.ScanItemId); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.ScanItemType != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "scan_item.type", runtime.ParamLocationQuery, *params.ScanItemType); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Type != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "type", runtime.ParamLocationQuery, *params.Type); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_before", runtime.ParamLocationQuery, *params.UpdatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.UpdatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "updated_after", runtime.ParamLocationQuery, *params.UpdatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedBefore != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_before", runtime.ParamLocationQuery, *params.CreatedBefore); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.CreatedAfter != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "created_after", runtime.ParamLocationQuery, *params.CreatedAfter); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.EffectiveSeverityLevel != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", false, "effective_severity_level", runtime.ParamLocationQuery, *params.EffectiveSeverityLevel); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Status != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", false, "status", runtime.ParamLocationQuery, *params.Status); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Ignored != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "ignored", runtime.ParamLocationQuery, *params.Ignored); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetOrgIssueByIssueIDRequest generates requests for GetOrgIssueByIssueID func NewGetOrgIssueByIssueIDRequest(server string, orgId openapi_types.UUID, issueId PathIssueId20240123, params *GetOrgIssueByIssueIDParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "org_id", runtime.ParamLocationPath, orgId) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "issue_id", runtime.ParamLocationPath, issueId) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/orgs/%s/issues/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewListIssuesForManyPurlsRequestWithApplicationVndAPIPlusJSONBody calls the generic ListIssuesForManyPurls builder with application/vnd.api+json body func NewListIssuesForManyPurlsRequestWithApplicationVndAPIPlusJSONBody(server string, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsApplicationVndAPIPlusJSONRequestBody) (*http.Request, error) { var bodyReader io.Reader buf, err := json.Marshal(body) if err != nil { return nil, err } bodyReader = bytes.NewReader(buf) return NewListIssuesForManyPurlsRequestWithBody(server, orgId, params, "application/vnd.api+json", bodyReader) } // NewListIssuesForManyPurlsRequestWithBody generates requests for ListIssuesForManyPurls with any type of body func NewListIssuesForManyPurlsRequestWithBody(server string, orgId OrgId, params *ListIssuesForManyPurlsParams, contentType string, body io.Reader) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "org_id", runtime.ParamLocationPath, orgId) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/orgs/%s/packages/issues", pathParam0) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("POST", queryURL.String(), body) if err != nil { return nil, err } req.Header.Add("Content-Type", contentType) return req, nil } // NewFetchIssuesPerPurlRequest generates requests for FetchIssuesPerPurl func NewFetchIssuesPerPurlRequest(server string, orgId OrgId, purl PackageUrl, params *FetchIssuesPerPurlParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "org_id", runtime.ParamLocationPath, orgId) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "purl", runtime.ParamLocationQuery, purl) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/orgs/%s/packages/%s/issues", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } if params.Offset != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "offset", runtime.ParamLocationQuery, *params.Offset); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } if params.Limit != nil { if queryFrag, err := runtime.StyleParamWithLocation("form", true, "limit", runtime.ParamLocationQuery, *params.Limit); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } func (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error { for _, r := range c.RequestEditors { if err := r(ctx, req); err != nil { return err } } for _, r := range additionalEditors { if err := r(ctx, req); err != nil { return err } } return nil } // ClientWithResponses builds on ClientInterface to offer response payloads type ClientWithResponses struct { ClientInterface } // NewClientWithResponses creates a new ClientWithResponses, which wraps // Client with return type handling func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { client, err := NewClient(server, opts...) if err != nil { return nil, err } return &ClientWithResponses{client}, nil } // WithBaseURL overrides the baseURL. func WithBaseURL(baseURL string) ClientOption { return func(c *Client) error { newBaseURL, err := url.Parse(baseURL) if err != nil { return err } c.Server = newBaseURL.String() return nil } } // ClientWithResponsesInterface is the interface specification for the client with responses above. type ClientWithResponsesInterface interface { // ListGroupIssuesWithResponse request ListGroupIssuesWithResponse(ctx context.Context, groupId openapi_types.UUID, params *ListGroupIssuesParams, reqEditors ...RequestEditorFn) (*ListGroupIssuesResponse, error) // GetGroupIssueByIssueIDWithResponse request GetGroupIssueByIssueIDWithResponse(ctx context.Context, groupId openapi_types.UUID, issueId PathIssueId20240123, params *GetGroupIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*GetGroupIssueByIssueIDResponse, error) // ListOrgIssuesWithResponse request ListOrgIssuesWithResponse(ctx context.Context, orgId openapi_types.UUID, params *ListOrgIssuesParams, reqEditors ...RequestEditorFn) (*ListOrgIssuesResponse, error) // GetOrgIssueByIssueIDWithResponse request GetOrgIssueByIssueIDWithResponse(ctx context.Context, orgId openapi_types.UUID, issueId PathIssueId20240123, params *GetOrgIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*GetOrgIssueByIssueIDResponse, error) // ListIssuesForManyPurlsWithBodyWithResponse request with any body ListIssuesForManyPurlsWithBodyWithResponse(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ListIssuesForManyPurlsResponse, error) ListIssuesForManyPurlsWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*ListIssuesForManyPurlsResponse, error) // FetchIssuesPerPurlWithResponse request FetchIssuesPerPurlWithResponse(ctx context.Context, orgId OrgId, purl PackageUrl, params *FetchIssuesPerPurlParams, reqEditors ...RequestEditorFn) (*FetchIssuesPerPurlResponse, error) } type ListGroupIssuesResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *ListIssues200 ApplicationvndApiJSON401 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON403 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON404 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON500 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } } // Status returns HTTPResponse.Status func (r ListGroupIssuesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r ListGroupIssuesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetGroupIssueByIssueIDResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *GetIssue20020240123 ApplicationvndApiJSON400 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON401 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON403 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON404 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON409 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON500 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } } // Status returns HTTPResponse.Status func (r GetGroupIssueByIssueIDResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetGroupIssueByIssueIDResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type ListOrgIssuesResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *ListIssues200 ApplicationvndApiJSON401 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON403 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON404 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON500 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } } // Status returns HTTPResponse.Status func (r ListOrgIssuesResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r ListOrgIssuesResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetOrgIssueByIssueIDResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *GetIssue20020240123 ApplicationvndApiJSON400 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON401 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON403 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON404 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON409 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } ApplicationvndApiJSON500 *struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } } // Status returns HTTPResponse.Status func (r GetOrgIssueByIssueIDResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetOrgIssueByIssueIDResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type ListIssuesForManyPurlsResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *IssuesWithPurlsResponse ApplicationvndApiJSON400 *N400 ApplicationvndApiJSON401 *N401 ApplicationvndApiJSON403 *N403 ApplicationvndApiJSON404 *N404 ApplicationvndApiJSON409 *N409 ApplicationvndApiJSON500 *N500 } // Status returns HTTPResponse.Status func (r ListIssuesForManyPurlsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r ListIssuesForManyPurlsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type FetchIssuesPerPurlResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *IssuesResponse ApplicationvndApiJSON400 *N400 ApplicationvndApiJSON401 *N401 ApplicationvndApiJSON403 *N403 ApplicationvndApiJSON404 *N404 ApplicationvndApiJSON409 *N409 ApplicationvndApiJSON500 *N500 } // Status returns HTTPResponse.Status func (r FetchIssuesPerPurlResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r FetchIssuesPerPurlResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } // ListGroupIssuesWithResponse request returning *ListGroupIssuesResponse func (c *ClientWithResponses) ListGroupIssuesWithResponse(ctx context.Context, groupId openapi_types.UUID, params *ListGroupIssuesParams, reqEditors ...RequestEditorFn) (*ListGroupIssuesResponse, error) { rsp, err := c.ListGroupIssues(ctx, groupId, params, reqEditors...) if err != nil { return nil, err } return ParseListGroupIssuesResponse(rsp) } // GetGroupIssueByIssueIDWithResponse request returning *GetGroupIssueByIssueIDResponse func (c *ClientWithResponses) GetGroupIssueByIssueIDWithResponse(ctx context.Context, groupId openapi_types.UUID, issueId PathIssueId20240123, params *GetGroupIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*GetGroupIssueByIssueIDResponse, error) { rsp, err := c.GetGroupIssueByIssueID(ctx, groupId, issueId, params, reqEditors...) if err != nil { return nil, err } return ParseGetGroupIssueByIssueIDResponse(rsp) } // ListOrgIssuesWithResponse request returning *ListOrgIssuesResponse func (c *ClientWithResponses) ListOrgIssuesWithResponse(ctx context.Context, orgId openapi_types.UUID, params *ListOrgIssuesParams, reqEditors ...RequestEditorFn) (*ListOrgIssuesResponse, error) { rsp, err := c.ListOrgIssues(ctx, orgId, params, reqEditors...) if err != nil { return nil, err } return ParseListOrgIssuesResponse(rsp) } // GetOrgIssueByIssueIDWithResponse request returning *GetOrgIssueByIssueIDResponse func (c *ClientWithResponses) GetOrgIssueByIssueIDWithResponse(ctx context.Context, orgId openapi_types.UUID, issueId PathIssueId20240123, params *GetOrgIssueByIssueIDParams, reqEditors ...RequestEditorFn) (*GetOrgIssueByIssueIDResponse, error) { rsp, err := c.GetOrgIssueByIssueID(ctx, orgId, issueId, params, reqEditors...) if err != nil { return nil, err } return ParseGetOrgIssueByIssueIDResponse(rsp) } // ListIssuesForManyPurlsWithBodyWithResponse request with arbitrary body returning *ListIssuesForManyPurlsResponse func (c *ClientWithResponses) ListIssuesForManyPurlsWithBodyWithResponse(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ListIssuesForManyPurlsResponse, error) { rsp, err := c.ListIssuesForManyPurlsWithBody(ctx, orgId, params, contentType, body, reqEditors...) if err != nil { return nil, err } return ParseListIssuesForManyPurlsResponse(rsp) } func (c *ClientWithResponses) ListIssuesForManyPurlsWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*ListIssuesForManyPurlsResponse, error) { rsp, err := c.ListIssuesForManyPurlsWithApplicationVndAPIPlusJSONBody(ctx, orgId, params, body, reqEditors...) if err != nil { return nil, err } return ParseListIssuesForManyPurlsResponse(rsp) } // FetchIssuesPerPurlWithResponse request returning *FetchIssuesPerPurlResponse func (c *ClientWithResponses) FetchIssuesPerPurlWithResponse(ctx context.Context, orgId OrgId, purl PackageUrl, params *FetchIssuesPerPurlParams, reqEditors ...RequestEditorFn) (*FetchIssuesPerPurlResponse, error) { rsp, err := c.FetchIssuesPerPurl(ctx, orgId, purl, params, reqEditors...) if err != nil { return nil, err } return ParseFetchIssuesPerPurlResponse(rsp) } // ParseListGroupIssuesResponse parses an HTTP response from a ListGroupIssuesWithResponse call func ParseListGroupIssuesResponse(rsp *http.Response) (*ListGroupIssuesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &ListGroupIssuesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest ListIssues200 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseGetGroupIssueByIssueIDResponse parses an HTTP response from a GetGroupIssueByIssueIDWithResponse call func ParseGetGroupIssueByIssueIDResponse(rsp *http.Response) (*GetGroupIssueByIssueIDResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetGroupIssueByIssueIDResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest GetIssue20020240123 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 409: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON409 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseListOrgIssuesResponse parses an HTTP response from a ListOrgIssuesWithResponse call func ParseListOrgIssuesResponse(rsp *http.Response) (*ListOrgIssuesResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &ListOrgIssuesResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest ListIssues200 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseGetOrgIssueByIssueIDResponse parses an HTTP response from a GetOrgIssueByIssueIDWithResponse call func ParseGetOrgIssueByIssueIDResponse(rsp *http.Response) (*GetOrgIssueByIssueIDResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetOrgIssueByIssueIDResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest GetIssue20020240123 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 409: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON409 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest struct { Errors []struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } `json:"errors"` Jsonapi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseListIssuesForManyPurlsResponse parses an HTTP response from a ListIssuesForManyPurlsWithResponse call func ParseListIssuesForManyPurlsResponse(rsp *http.Response) (*ListIssuesForManyPurlsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &ListIssuesForManyPurlsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest IssuesWithPurlsResponse if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest N400 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest N401 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest N403 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest N404 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 409: var dest N409 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON409 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest N500 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseFetchIssuesPerPurlResponse parses an HTTP response from a FetchIssuesPerPurlWithResponse call func ParseFetchIssuesPerPurlResponse(rsp *http.Response) (*FetchIssuesPerPurlResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &FetchIssuesPerPurlResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest IssuesResponse if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest N400 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest N401 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest N403 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest N404 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 409: var dest N409 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON409 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest N500 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } ================================================ FILE: snyk/users/users.go ================================================ // Package users provides primitives to interact with the openapi HTTP API. // // Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT. package users import ( "bytes" "context" "encoding/json" "fmt" "io" "net/http" "net/url" "strings" "time" "github.com/oapi-codegen/runtime" openapi_types "github.com/oapi-codegen/runtime/types" ) const ( APITokenScopes = "APIToken.Scopes" BearerAuthScopes = "BearerAuth.Scopes" ) // Defines values for Principal20240422Type. const ( Principal20240422TypeAppInstance Principal20240422Type = "app_instance" Principal20240422TypeServiceAccount Principal20240422Type = "service_account" Principal20240422TypeUser Principal20240422Type = "user" ) // Defines values for UserAttributesMembershipStrategy. const ( Direct UserAttributesMembershipStrategy = "direct" Indirect UserAttributesMembershipStrategy = "indirect" ) // Defines values for UserSettingsType. const ( UserSettingsTypeUserSettings UserSettingsType = "user_settings" ) // ActualVersion Resolved API version type ActualVersion = string // AppInstance defines model for AppInstance. type AppInstance struct { // DefaultOrgContext ID of the default org for the service account. DefaultOrgContext *openapi_types.UUID `json:"default_org_context,omitempty"` // Name The name of the service account. Name string `json:"name"` } // Error defines model for Error. type Error struct { // Code An application-specific error code, expressed as a string value. Code *string `json:"code,omitempty"` // Detail A human-readable explanation specific to this occurrence of the problem. Detail string `json:"detail"` // Id A unique identifier for this particular occurrence of the problem. Id *openapi_types.UUID `json:"id,omitempty"` // Links A link that leads to further details about this particular occurrance of the problem. Links *ErrorLink `json:"links,omitempty"` Meta *map[string]interface{} `json:"meta,omitempty"` Source *struct { // Parameter A string indicating which URI query parameter caused the error. Parameter *string `json:"parameter,omitempty"` // Pointer A JSON Pointer [RFC6901] to the associated entity in the request document. Pointer *string `json:"pointer,omitempty"` } `json:"source,omitempty"` // Status The HTTP status code applicable to this problem, expressed as a string value. Status string `json:"status"` // Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Title *string `json:"title,omitempty"` } // ErrorDocument defines model for ErrorDocument. type ErrorDocument struct { Errors []Error `json:"errors"` Jsonapi JsonApi `json:"jsonapi"` } // ErrorLink A link that leads to further details about this particular occurrance of the problem. type ErrorLink struct { About *LinkProperty `json:"about,omitempty"` } // JsonApi defines model for JsonApi. type JsonApi struct { // Version Version of the JSON API specification this server supports. Version string `json:"version"` } // LinkProperty defines model for LinkProperty. type LinkProperty struct { union json.RawMessage } // LinkProperty0 A string containing the link’s URL. type LinkProperty0 = string // LinkProperty1 defines model for . type LinkProperty1 struct { // Href A string containing the link’s URL. Href string `json:"href"` // Meta Free-form object that may contain non-standard information. Meta *Meta `json:"meta,omitempty"` } // Links defines model for Links. type Links struct { First *LinkProperty `json:"first,omitempty"` Last *LinkProperty `json:"last,omitempty"` Next *LinkProperty `json:"next,omitempty"` Prev *LinkProperty `json:"prev,omitempty"` Related *LinkProperty `json:"related,omitempty"` Self *LinkProperty `json:"self,omitempty"` } // Meta Free-form object that may contain non-standard information. type Meta map[string]interface{} // Principal20240422 defines model for Principal20240422. type Principal20240422 struct { Attributes Principal20240422_Attributes `json:"attributes"` // Id The Snyk ID corresponding to this user, service account or app Id openapi_types.UUID `json:"id"` // Type Content type. Type Principal20240422Type `json:"type"` } // Principal20240422_Attributes defines model for Principal20240422.Attributes. type Principal20240422_Attributes struct { union json.RawMessage } // Principal20240422Type Content type. type Principal20240422Type string // QueryVersion Requested API version type QueryVersion = string // ServiceAccount20240422 defines model for ServiceAccount20240422. type ServiceAccount20240422 struct { // DefaultOrgContext ID of the default org for the service account. DefaultOrgContext *openapi_types.UUID `json:"default_org_context,omitempty"` // Name The name of the service account. Name string `json:"name"` } // User defines model for User. type User struct { Attributes struct { // Active Whether the user status is enabled or not Active *bool `json:"active,omitempty"` // Email The email of the user. Email *string `json:"email,omitempty"` Membership *struct { // CreatedAt The date the membership was established. CreatedAt *time.Time `json:"created_at,omitempty"` // Strategy Whether the membership is a direct, or indirect membership. Strategy *UserAttributesMembershipStrategy `json:"strategy,omitempty"` } `json:"membership,omitempty"` // Name The name of the user. Name *string `json:"name,omitempty"` // Username The username of the user. Username *string `json:"username,omitempty"` } `json:"attributes"` // Id The Snyk ID corresponding to this user Id openapi_types.UUID `json:"id"` // Type Content type. Type string `json:"type"` } // UserAttributesMembershipStrategy Whether the membership is a direct, or indirect membership. type UserAttributesMembershipStrategy string // User20240422 defines model for User20240422. type User20240422 struct { // AvatarUrl The avatar url of the user. AvatarUrl string `json:"avatar_url"` // DefaultOrgContext ID of the default org for the user. DefaultOrgContext *openapi_types.UUID `json:"default_org_context,omitempty"` // Email The email of the user. Email string `json:"email"` // Name The name of the user. Name string `json:"name"` // Username The username of the user. Username *string `json:"username,omitempty"` } // UserPatchRequestBody defines model for UserPatchRequestBody. type UserPatchRequestBody struct { Attributes struct { Membership *struct { // Role Role name Role *string `json:"role,omitempty"` } `json:"membership"` } `json:"attributes"` // Id The Snyk ID corresponding to this user Id openapi_types.UUID `json:"id"` // Type Content type Type string `json:"type"` } // UserPreferredOrgSettings defines model for UserPreferredOrgSettings. type UserPreferredOrgSettings struct { // PreferredOrg The org to use for operations when there is no explicit org in context PreferredOrg *struct { // Id The id of the preferred org Id openapi_types.UUID `json:"id"` } `json:"preferred_org,omitempty"` } // UserSettings user settings type UserSettings struct { Attributes *UserSettings_Attributes `json:"attributes,omitempty"` // Id The id of the user Id openapi_types.UUID `json:"id"` // Type The resource type Type UserSettingsType `json:"type"` } // UserSettings_Attributes defines model for UserSettings.Attributes. type UserSettings_Attributes struct { union json.RawMessage } // UserSettingsType The resource type type UserSettingsType string // Version Requested API version type Version = QueryVersion // N400 defines model for 400. type N400 = ErrorDocument // N401 defines model for 401. type N401 = ErrorDocument // N403 defines model for 403. type N403 = ErrorDocument // N404 defines model for 404. type N404 = ErrorDocument // N500 defines model for 500. type N500 = ErrorDocument // UpdateUserApplicationVndAPIPlusJSONBody defines parameters for UpdateUser. type UpdateUserApplicationVndAPIPlusJSONBody struct { Data *UserPatchRequestBody `json:"data,omitempty"` } // UpdateUserParams defines parameters for UpdateUser. type UpdateUserParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` } // GetUserParams defines parameters for GetUser. type GetUserParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` } // GetSelfParams defines parameters for GetSelf. type GetSelfParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` } // GetUserSettingsParams defines parameters for GetUserSettings. type GetUserSettingsParams struct { // Version The requested version of the endpoint to process the request Version Version `form:"version" json:"version"` } // UpdateUserApplicationVndAPIPlusJSONRequestBody defines body for UpdateUser for application/vnd.api+json ContentType. type UpdateUserApplicationVndAPIPlusJSONRequestBody UpdateUserApplicationVndAPIPlusJSONBody // AsLinkProperty0 returns the union data inside the LinkProperty as a LinkProperty0 func (t LinkProperty) AsLinkProperty0() (LinkProperty0, error) { var body LinkProperty0 err := json.Unmarshal(t.union, &body) return body, err } // FromLinkProperty0 overwrites any union data inside the LinkProperty as the provided LinkProperty0 func (t *LinkProperty) FromLinkProperty0(v LinkProperty0) error { b, err := json.Marshal(v) t.union = b return err } // MergeLinkProperty0 performs a merge with any union data inside the LinkProperty, using the provided LinkProperty0 func (t *LinkProperty) MergeLinkProperty0(v LinkProperty0) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsLinkProperty1 returns the union data inside the LinkProperty as a LinkProperty1 func (t LinkProperty) AsLinkProperty1() (LinkProperty1, error) { var body LinkProperty1 err := json.Unmarshal(t.union, &body) return body, err } // FromLinkProperty1 overwrites any union data inside the LinkProperty as the provided LinkProperty1 func (t *LinkProperty) FromLinkProperty1(v LinkProperty1) error { b, err := json.Marshal(v) t.union = b return err } // MergeLinkProperty1 performs a merge with any union data inside the LinkProperty, using the provided LinkProperty1 func (t *LinkProperty) MergeLinkProperty1(v LinkProperty1) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } func (t LinkProperty) MarshalJSON() ([]byte, error) { b, err := t.union.MarshalJSON() return b, err } func (t *LinkProperty) UnmarshalJSON(b []byte) error { err := t.union.UnmarshalJSON(b) return err } // AsUser20240422 returns the union data inside the Principal20240422_Attributes as a User20240422 func (t Principal20240422_Attributes) AsUser20240422() (User20240422, error) { var body User20240422 err := json.Unmarshal(t.union, &body) return body, err } // FromUser20240422 overwrites any union data inside the Principal20240422_Attributes as the provided User20240422 func (t *Principal20240422_Attributes) FromUser20240422(v User20240422) error { b, err := json.Marshal(v) t.union = b return err } // MergeUser20240422 performs a merge with any union data inside the Principal20240422_Attributes, using the provided User20240422 func (t *Principal20240422_Attributes) MergeUser20240422(v User20240422) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsServiceAccount20240422 returns the union data inside the Principal20240422_Attributes as a ServiceAccount20240422 func (t Principal20240422_Attributes) AsServiceAccount20240422() (ServiceAccount20240422, error) { var body ServiceAccount20240422 err := json.Unmarshal(t.union, &body) return body, err } // FromServiceAccount20240422 overwrites any union data inside the Principal20240422_Attributes as the provided ServiceAccount20240422 func (t *Principal20240422_Attributes) FromServiceAccount20240422(v ServiceAccount20240422) error { b, err := json.Marshal(v) t.union = b return err } // MergeServiceAccount20240422 performs a merge with any union data inside the Principal20240422_Attributes, using the provided ServiceAccount20240422 func (t *Principal20240422_Attributes) MergeServiceAccount20240422(v ServiceAccount20240422) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } // AsAppInstance returns the union data inside the Principal20240422_Attributes as a AppInstance func (t Principal20240422_Attributes) AsAppInstance() (AppInstance, error) { var body AppInstance err := json.Unmarshal(t.union, &body) return body, err } // FromAppInstance overwrites any union data inside the Principal20240422_Attributes as the provided AppInstance func (t *Principal20240422_Attributes) FromAppInstance(v AppInstance) error { b, err := json.Marshal(v) t.union = b return err } // MergeAppInstance performs a merge with any union data inside the Principal20240422_Attributes, using the provided AppInstance func (t *Principal20240422_Attributes) MergeAppInstance(v AppInstance) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } func (t Principal20240422_Attributes) MarshalJSON() ([]byte, error) { b, err := t.union.MarshalJSON() return b, err } func (t *Principal20240422_Attributes) UnmarshalJSON(b []byte) error { err := t.union.UnmarshalJSON(b) return err } // AsUserPreferredOrgSettings returns the union data inside the UserSettings_Attributes as a UserPreferredOrgSettings func (t UserSettings_Attributes) AsUserPreferredOrgSettings() (UserPreferredOrgSettings, error) { var body UserPreferredOrgSettings err := json.Unmarshal(t.union, &body) return body, err } // FromUserPreferredOrgSettings overwrites any union data inside the UserSettings_Attributes as the provided UserPreferredOrgSettings func (t *UserSettings_Attributes) FromUserPreferredOrgSettings(v UserPreferredOrgSettings) error { b, err := json.Marshal(v) t.union = b return err } // MergeUserPreferredOrgSettings performs a merge with any union data inside the UserSettings_Attributes, using the provided UserPreferredOrgSettings func (t *UserSettings_Attributes) MergeUserPreferredOrgSettings(v UserPreferredOrgSettings) error { b, err := json.Marshal(v) if err != nil { return err } merged, err := runtime.JSONMerge(t.union, b) t.union = merged return err } func (t UserSettings_Attributes) MarshalJSON() ([]byte, error) { b, err := t.union.MarshalJSON() return b, err } func (t *UserSettings_Attributes) UnmarshalJSON(b []byte) error { err := t.union.UnmarshalJSON(b) return err } // RequestEditorFn is the function signature for the RequestEditor callback function type RequestEditorFn func(ctx context.Context, req *http.Request) error // Doer performs HTTP requests. // // The standard http.Client implements this interface. type HttpRequestDoer interface { Do(req *http.Request) (*http.Response, error) } // Client which conforms to the OpenAPI3 specification for this service. type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn } // ClientOption allows setting custom parameters during construction type ClientOption func(*Client) error // Creates a new Client, with reasonable defaults func NewClient(server string, opts ...ClientOption) (*Client, error) { // create a client with sane default values client := Client{ Server: server, } // mutate client and add all optional params for _, o := range opts { if err := o(&client); err != nil { return nil, err } } // ensure the server URL always has a trailing slash if !strings.HasSuffix(client.Server, "/") { client.Server += "/" } // create httpClient, if not already present if client.Client == nil { client.Client = &http.Client{} } return &client, nil } // WithHTTPClient allows overriding the default Doer, which is // automatically created using http.Client. This is useful for tests. func WithHTTPClient(doer HttpRequestDoer) ClientOption { return func(c *Client) error { c.Client = doer return nil } } // WithRequestEditorFn allows setting up a callback function, which will be // called right before sending the request. This can be used to mutate the request. func WithRequestEditorFn(fn RequestEditorFn) ClientOption { return func(c *Client) error { c.RequestEditors = append(c.RequestEditors, fn) return nil } } // The interface specification for the client above. type ClientInterface interface { // UpdateUserWithBody request with any body UpdateUserWithBody(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) UpdateUserWithApplicationVndAPIPlusJSONBody(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) // GetUser request GetUser(ctx context.Context, orgId openapi_types.UUID, id openapi_types.UUID, params *GetUserParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetSelf request GetSelf(ctx context.Context, params *GetSelfParams, reqEditors ...RequestEditorFn) (*http.Response, error) // GetUserSettings request GetUserSettings(ctx context.Context, params *GetUserSettingsParams, reqEditors ...RequestEditorFn) (*http.Response, error) } func (c *Client) UpdateUserWithBody(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewUpdateUserRequestWithBody(c.Server, groupId, id, params, contentType, body) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) UpdateUserWithApplicationVndAPIPlusJSONBody(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewUpdateUserRequestWithApplicationVndAPIPlusJSONBody(c.Server, groupId, id, params, body) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetUser(ctx context.Context, orgId openapi_types.UUID, id openapi_types.UUID, params *GetUserParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetUserRequest(c.Server, orgId, id, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetSelf(ctx context.Context, params *GetSelfParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetSelfRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } func (c *Client) GetUserSettings(ctx context.Context, params *GetUserSettingsParams, reqEditors ...RequestEditorFn) (*http.Response, error) { req, err := NewGetUserSettingsRequest(c.Server, params) if err != nil { return nil, err } req = req.WithContext(ctx) if err := c.applyEditors(ctx, req, reqEditors); err != nil { return nil, err } return c.Client.Do(req) } // NewUpdateUserRequestWithApplicationVndAPIPlusJSONBody calls the generic UpdateUser builder with application/vnd.api+json body func NewUpdateUserRequestWithApplicationVndAPIPlusJSONBody(server string, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserApplicationVndAPIPlusJSONRequestBody) (*http.Request, error) { var bodyReader io.Reader buf, err := json.Marshal(body) if err != nil { return nil, err } bodyReader = bytes.NewReader(buf) return NewUpdateUserRequestWithBody(server, groupId, id, params, "application/vnd.api+json", bodyReader) } // NewUpdateUserRequestWithBody generates requests for UpdateUser with any type of body func NewUpdateUserRequestWithBody(server string, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, contentType string, body io.Reader) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "group_id", runtime.ParamLocationPath, groupId) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "id", runtime.ParamLocationPath, id) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/groups/%s/users/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("PATCH", queryURL.String(), body) if err != nil { return nil, err } req.Header.Add("Content-Type", contentType) return req, nil } // NewGetUserRequest generates requests for GetUser func NewGetUserRequest(server string, orgId openapi_types.UUID, id openapi_types.UUID, params *GetUserParams) (*http.Request, error) { var err error var pathParam0 string pathParam0, err = runtime.StyleParamWithLocation("simple", false, "org_id", runtime.ParamLocationPath, orgId) if err != nil { return nil, err } var pathParam1 string pathParam1, err = runtime.StyleParamWithLocation("simple", false, "id", runtime.ParamLocationPath, id) if err != nil { return nil, err } serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/orgs/%s/users/%s", pathParam0, pathParam1) if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetSelfRequest generates requests for GetSelf func NewGetSelfRequest(server string, params *GetSelfParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/self") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } // NewGetUserSettingsRequest generates requests for GetUserSettings func NewGetUserSettingsRequest(server string, params *GetUserSettingsParams) (*http.Request, error) { var err error serverURL, err := url.Parse(server) if err != nil { return nil, err } operationPath := fmt.Sprintf("/self/settings") if operationPath[0] == '/' { operationPath = "." + operationPath } queryURL, err := serverURL.Parse(operationPath) if err != nil { return nil, err } if params != nil { queryValues := queryURL.Query() if queryFrag, err := runtime.StyleParamWithLocation("form", true, "version", runtime.ParamLocationQuery, params.Version); err != nil { return nil, err } else if parsed, err := url.ParseQuery(queryFrag); err != nil { return nil, err } else { for k, v := range parsed { for _, v2 := range v { queryValues.Add(k, v2) } } } queryURL.RawQuery = queryValues.Encode() } req, err := http.NewRequest("GET", queryURL.String(), nil) if err != nil { return nil, err } return req, nil } func (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error { for _, r := range c.RequestEditors { if err := r(ctx, req); err != nil { return err } } for _, r := range additionalEditors { if err := r(ctx, req); err != nil { return err } } return nil } // ClientWithResponses builds on ClientInterface to offer response payloads type ClientWithResponses struct { ClientInterface } // NewClientWithResponses creates a new ClientWithResponses, which wraps // Client with return type handling func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { client, err := NewClient(server, opts...) if err != nil { return nil, err } return &ClientWithResponses{client}, nil } // WithBaseURL overrides the baseURL. func WithBaseURL(baseURL string) ClientOption { return func(c *Client) error { newBaseURL, err := url.Parse(baseURL) if err != nil { return err } c.Server = newBaseURL.String() return nil } } // ClientWithResponsesInterface is the interface specification for the client with responses above. type ClientWithResponsesInterface interface { // UpdateUserWithBodyWithResponse request with any body UpdateUserWithBodyWithResponse(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error) UpdateUserWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error) // GetUserWithResponse request GetUserWithResponse(ctx context.Context, orgId openapi_types.UUID, id openapi_types.UUID, params *GetUserParams, reqEditors ...RequestEditorFn) (*GetUserResponse, error) // GetSelfWithResponse request GetSelfWithResponse(ctx context.Context, params *GetSelfParams, reqEditors ...RequestEditorFn) (*GetSelfResponse, error) // GetUserSettingsWithResponse request GetUserSettingsWithResponse(ctx context.Context, params *GetUserSettingsParams, reqEditors ...RequestEditorFn) (*GetUserSettingsResponse, error) } type UpdateUserResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON400 *N400 ApplicationvndApiJSON401 *N401 ApplicationvndApiJSON403 *N403 ApplicationvndApiJSON404 *N404 ApplicationvndApiJSON500 *N500 } // Status returns HTTPResponse.Status func (r UpdateUserResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r UpdateUserResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetUserResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *struct { Data User `json:"data"` Jsonapi JsonApi `json:"jsonapi"` } ApplicationvndApiJSON400 *N400 ApplicationvndApiJSON401 *N401 ApplicationvndApiJSON403 *N403 ApplicationvndApiJSON404 *N404 ApplicationvndApiJSON500 *N500 } // Status returns HTTPResponse.Status func (r GetUserResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetUserResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetSelfResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *struct { Data Principal20240422 `json:"data"` Jsonapi JsonApi `json:"jsonapi"` Links Links `json:"links"` } ApplicationvndApiJSON400 *N400 ApplicationvndApiJSON401 *N401 ApplicationvndApiJSON403 *N403 ApplicationvndApiJSON404 *N404 ApplicationvndApiJSON500 *N500 } // Status returns HTTPResponse.Status func (r GetSelfResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetSelfResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } type GetUserSettingsResponse struct { Body []byte HTTPResponse *http.Response ApplicationvndApiJSON200 *struct { // Data user settings Data UserSettings `json:"data"` Jsonapi JsonApi `json:"jsonapi"` Links Links `json:"links"` } ApplicationvndApiJSON400 *N400 ApplicationvndApiJSON401 *N401 ApplicationvndApiJSON403 *N403 ApplicationvndApiJSON404 *N404 ApplicationvndApiJSON500 *N500 } // Status returns HTTPResponse.Status func (r GetUserSettingsResponse) Status() string { if r.HTTPResponse != nil { return r.HTTPResponse.Status } return http.StatusText(0) } // StatusCode returns HTTPResponse.StatusCode func (r GetUserSettingsResponse) StatusCode() int { if r.HTTPResponse != nil { return r.HTTPResponse.StatusCode } return 0 } // UpdateUserWithBodyWithResponse request with arbitrary body returning *UpdateUserResponse func (c *ClientWithResponses) UpdateUserWithBodyWithResponse(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error) { rsp, err := c.UpdateUserWithBody(ctx, groupId, id, params, contentType, body, reqEditors...) if err != nil { return nil, err } return ParseUpdateUserResponse(rsp) } func (c *ClientWithResponses) UpdateUserWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error) { rsp, err := c.UpdateUserWithApplicationVndAPIPlusJSONBody(ctx, groupId, id, params, body, reqEditors...) if err != nil { return nil, err } return ParseUpdateUserResponse(rsp) } // GetUserWithResponse request returning *GetUserResponse func (c *ClientWithResponses) GetUserWithResponse(ctx context.Context, orgId openapi_types.UUID, id openapi_types.UUID, params *GetUserParams, reqEditors ...RequestEditorFn) (*GetUserResponse, error) { rsp, err := c.GetUser(ctx, orgId, id, params, reqEditors...) if err != nil { return nil, err } return ParseGetUserResponse(rsp) } // GetSelfWithResponse request returning *GetSelfResponse func (c *ClientWithResponses) GetSelfWithResponse(ctx context.Context, params *GetSelfParams, reqEditors ...RequestEditorFn) (*GetSelfResponse, error) { rsp, err := c.GetSelf(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseGetSelfResponse(rsp) } // GetUserSettingsWithResponse request returning *GetUserSettingsResponse func (c *ClientWithResponses) GetUserSettingsWithResponse(ctx context.Context, params *GetUserSettingsParams, reqEditors ...RequestEditorFn) (*GetUserSettingsResponse, error) { rsp, err := c.GetUserSettings(ctx, params, reqEditors...) if err != nil { return nil, err } return ParseGetUserSettingsResponse(rsp) } // ParseUpdateUserResponse parses an HTTP response from a UpdateUserWithResponse call func ParseUpdateUserResponse(rsp *http.Response) (*UpdateUserResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &UpdateUserResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest N400 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest N401 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest N403 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest N404 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest N500 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseGetUserResponse parses an HTTP response from a GetUserWithResponse call func ParseGetUserResponse(rsp *http.Response) (*GetUserResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetUserResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest struct { Data User `json:"data"` Jsonapi JsonApi `json:"jsonapi"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest N400 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest N401 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest N403 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest N404 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest N500 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseGetSelfResponse parses an HTTP response from a GetSelfWithResponse call func ParseGetSelfResponse(rsp *http.Response) (*GetSelfResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetSelfResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest struct { Data Principal20240422 `json:"data"` Jsonapi JsonApi `json:"jsonapi"` Links Links `json:"links"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest N400 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest N401 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest N403 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest N404 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest N500 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } // ParseGetUserSettingsResponse parses an HTTP response from a GetUserSettingsWithResponse call func ParseGetUserSettingsResponse(rsp *http.Response) (*GetUserSettingsResponse, error) { bodyBytes, err := io.ReadAll(rsp.Body) defer func() { _ = rsp.Body.Close() }() if err != nil { return nil, err } response := &GetUserSettingsResponse{ Body: bodyBytes, HTTPResponse: rsp, } switch { case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: var dest struct { // Data user settings Data UserSettings `json:"data"` Jsonapi JsonApi `json:"jsonapi"` Links Links `json:"links"` } if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON200 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 400: var dest N400 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON400 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 401: var dest N401 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON401 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 403: var dest N403 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON403 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 404: var dest N404 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON404 = &dest case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 500: var dest N500 if err := json.Unmarshal(bodyBytes, &dest); err != nil { return nil, err } response.ApplicationvndApiJSON500 = &dest } return response, nil } ================================================ FILE: specs/packages.yaml ================================================ --- openapi: 3.0.1 info: title: 'Ecosyste.ms: Packages' description: An open API service providing package, version and dependency metadata of many open source software ecosystems and registries. contact: name: Ecosyste.ms email: support@ecosyste.ms url: https://ecosyste.ms version: 1.1.0 license: name: CC-BY-SA-4.0 url: https://creativecommons.org/licenses/by-sa/4.0/ externalDocs: description: GitHub Repository url: https://github.com/ecosyste-ms/packages servers: - url: https://packages.ecosyste.ms/api/v1 paths: "/packages/lookup": get: summary: lookup a package by repository URL, purl or ecosystem+name operationId: lookupPackage tags: - packages parameters: - name: repository_url in: query description: repository URL required: false schema: type: string - name: purl in: query description: package URL required: false schema: type: string - name: ecosystem in: query description: ecosystem name required: false schema: type: string - name: name in: query description: package name required: false schema: type: string - name: sort in: query description: field to sort results by required: false schema: type: string - name: order in: query description: direction to sort results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/PackageWithRegistry" "/keywords": get: summary: list keywords operationId: getKeywords tags: - keywords parameters: - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Keyword" "/keywords/{keywordName}": get: summary: get a keyword by name operationId: getKeyword tags: - keywords parameters: - in: path name: keywordName schema: type: string required: true description: name of keyword - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/KeywordWithPackages" "/registries": get: summary: list registies operationId: getRegistries tags: - registries parameters: - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Registry" "/registries/{registryName}": get: summary: get a registry by name operationId: getRegistry tags: - registries parameters: - in: path name: registryName schema: type: string required: true description: name of registry - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Registry" "/registries/{registryName}/lookup": get: summary: lookup a package within a registry by repository URL, purl or ecosystem+name operationId: lookupRegistryPackage tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - name: repository_url in: query description: repository URL required: false schema: type: string - name: purl in: query description: package URL required: false schema: type: string - name: ecosystem in: query description: ecosystem name required: false schema: type: string - name: name in: query description: package name required: false schema: type: string - name: sort in: query description: field to sort results by required: false schema: type: string - name: order in: query description: direction to sort results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/PackageWithRegistry" "/registries/{registryName}/maintainers": get: summary: get a list of maintainers from a registry operationId: getRegistryMaintainers tags: - maintainers parameters: - in: path name: registryName schema: type: string required: true description: name of registry - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Maintainer" "/registries/{registryName}/maintainers/{MaintainerLoginOrUUID}": get: summary: get a maintainer by login or UUID operationId: getRegistryMaintainer tags: - maintainers parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: MaintainerLoginOrUUID schema: type: string required: true description: login or uuid of maintainer responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Maintainer" "/registries/{registryName}/maintainers/{MaintainerLoginOrUUID}/packages": get: summary: get packages for a maintainer by login or UUID operationId: getRegistryMaintainerPackages tags: - maintainers parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: MaintainerLoginOrUUID schema: type: string required: true description: login or uuid of maintainer - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Package" "/registries/{registryName}/namespaces": get: summary: get a list of namespaces from a registry operationId: getRegistryNamespaces tags: - namespaces parameters: - in: path name: registryName schema: type: string required: true description: name of registry - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Namespace" "/registries/{registryName}/namespaces/{namespaceName}": get: summary: get a namespace by name operationId: getRegistryNamespace tags: - namespaces parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: namespaceName schema: type: string required: true description: name of namespace responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Namespace" "/registries/{registryName}/namespaces/{namespaceName}/packages": get: summary: get packages for a namespace by login or UUID operationId: getRegistryNamespacePackages tags: - namespaces parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: namespaceName schema: type: string required: true description: lname of namespace - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Package" "/registries/{registryName}/packages": get: summary: get a list of packages from a registry operationId: getRegistryPackages tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: created_before in: query description: filter by created_at before given time required: false schema: type: string format: date-time - name: updated_before in: query description: filter by updated_at before given time required: false schema: type: string format: date-time - name: critical in: query description: filter by critical packages required: false schema: type: boolean - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Package" "/registries/{registryName}/package_names": get: summary: get a list of package names from a registry operationId: getRegistryPackageNames tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: created_before in: query description: filter by created_at before given time required: false schema: type: string format: date-time - name: updated_before in: query description: filter by updated_at before given time required: false schema: type: string format: date-time - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: type: string "/registries/{registryName}/versions": get: summary: get a list of recently published versions from a registry operationId: getRegistryRecentVersions tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: published_after in: query description: filter by published_at after given time required: false schema: type: string format: date-time - name: published_before in: query description: filter by published_at before given time required: false schema: type: string format: date-time - name: created_before in: query description: filter by created_at before given time required: false schema: type: string format: date-time - name: updated_before in: query description: filter by updated_at before given time required: false schema: type: string format: date-time - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/VersionWithPackage" "/registries/{registryName}/packages/{packageName}": get: summary: get a package by name operationId: getRegistryPackage tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: packageName schema: type: string required: true description: name of package responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Package" "/registries/{registryName}/packages/{packageName}/dependent_packages": get: summary: get a list of packages that depend on a package operationId: getRegistryPackageDependentPackages tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: packageName schema: type: string required: true description: name of package - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string - name: latest in: query description: filter by latest version required: false schema: type: boolean - name: kind in: query description: filter by dependency kind required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Package" "/registries/{registryName}/packages/{packageName}/dependent_package_kinds": get: summary: get a list of dependency kinds for a package operationId: getRegistryPackageDependentPackageKinds tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: packageName schema: type: string required: true description: name of package - name: latest in: query description: filter by latest version required: false schema: type: boolean responses: 200: description: OK content: application/json: schema: type: array items: type: string "/registries/{registryName}/packages/{packageName}/related_packages": get: summary: get a list of packages that are related to a package operationId: getRegistryPackageRelatedPackages tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: packageName schema: type: string required: true description: name of package - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Package" "/registries/{registryName}/packages/{packageName}/version_numbers": get: summary: get a list of version numbers for a package from a registry operationId: getRegistryPackageVersionNumbers tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: packageName schema: type: string required: true description: name of package responses: 200: description: OK content: application/json: schema: type: array items: type: string "/registries/{registryName}/packages/{packageName}/versions": get: summary: get a list of versions for a package operationId: getRegistryPackageVersions tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: packageName schema: type: string required: true description: name of package - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: published_after in: query description: filter by published_at after given time required: false schema: type: string format: date-time - name: published_before in: query description: filter by published_at before given time required: false schema: type: string format: date-time - name: created_before in: query description: filter by created_at before given time required: false schema: type: string format: date-time - name: updated_before in: query description: filter by updated_at before given time required: false schema: type: string format: date-time - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Version" "/registries/{registryName}/packages/{packageName}/versions/{versionNumber}": get: summary: get a version of a package operationId: getRegistryPackageVersion tags: - packages parameters: - in: path name: registryName schema: type: string required: true description: name of registry - in: path name: packageName schema: type: string required: true description: name of package - in: path name: versionNumber schema: type: string required: true description: number of version responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/VersionWithDependencies" "/dependencies": get: summary: list dependencies operationId: getDependencies tags: - dependencies parameters: - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: ecosystem in: query description: ecosystem name required: false schema: type: string - name: package_name in: query description: package name required: false schema: type: string - name: package_id in: query description: package id required: false schema: type: string - name: requirements in: query description: requirements required: false schema: type: string - name: kind in: query description: kind required: false schema: type: string - name: optional in: query description: optional required: false schema: type: boolean - name: after in: query description: filter by id after given id required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Dependency" components: schemas: Registry: required: - name - url - ecosystem - default - packages_count - maintainers_count - namespaces_count - keywords_count - downloads - github - metadata - created_at - updated_at - packages_url - maintainers_url - icon_url - purl_type type: object properties: name: type: string url: type: string ecosystem: type: string default: type: boolean packages_count: type: integer format: int64 versions_count: type: integer format: int64 maintainers_count: type: integer format: int64 namespaces_count: type: integer format: int64 keywords_count: type: integer format: int64 downloads: type: integer format: int64 github: type: string nullable: true metadata: type: object nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time packages_url: type: string maintainers_url: type: string icon_url: type: string purl_type: type: string Package: required: - id - name - ecosystem - description - homepage - licenses - normalized_licenses - repository_url - keywords_array - namespace - versions_count - first_release_published_at - latest_release_published_at - latest_release_number - last_synced_at - created_at - updated_at - registry_url - documentation_url - install_command - metadata - repo_metadata - repo_metadata_updated_at - dependent_packages_count - downloads - downloads_period - dependent_repos_count - rankings - purl - advisories - versions_url - dependent_packages_url - related_packages_url - docker_usage_url - docker_dependents_count - docker_downloads_count - maintainers - usage_url - dependent_repositories_url - status - funding_links - critical type: object properties: id: type: integer name: type: string ecosystem: type: string description: type: string nullable: true homepage: type: string nullable: true licenses: type: string nullable: true normalized_licenses: type: array items: type: string repository_url: type: string nullable: true keywords_array: type: array items: type: string namespace: type: string nullable: true versions_count: type: integer first_release_published_at: type: string format: date-time nullable: true latest_release_published_at: type: string format: date-time nullable: true latest_release_number: type: string nullable: true last_synced_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time registry_url: type: string nullable: true documentation_url: type: string nullable: true install_command: type: string nullable: true metadata: type: object nullable: true repo_metadata: type: object nullable: true repo_metadata_updated_at: type: string format: date-time nullable: true dependent_packages_count: type: integer downloads: type: integer downloads_period: type: string nullable: true dependent_repos_count: type: integer rankings: type: object purl: type: string advisories: type: array items: "$ref": "#/components/schemas/Advisory" versions_url: type: string version_numbers_url: type: string dependent_packages_url: type: string related_packages_url: type: string docker_usage_url: type: string docker_dependents_count: type: integer docker_downloads_count: type: integer usage_url: type: string dependent_repositories_url: type: string status: type: string nullable: true funding_links: type: array items: type: string maintainers: type: array items: "$ref": "#/components/schemas/Maintainer" critical: type: boolean PackageWithRegistry: allOf: - "$ref": "#/components/schemas/Package" - type: object properties: registry: "$ref": "#/components/schemas/Registry" required: - registry Version: required: - id - number - published_at - licenses - integrity - status - download_url - registry_url - documentation_url - install_command - metadata - created_at - updated_at - purl - version_url - related_tag - latest type: object properties: id: type: integer number: type: string published_at: type: string nullable: true licenses: type: string nullable: true integrity: type: string nullable: true status: type: string nullable: true download_url: type: string nullable: true registry_url: type: string nullable: true documentation_url: type: string nullable: true install_command: type: string nullable: true metadata: type: object nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time purl: type: string version_url: type: string related_tag: type: object VersionWithDependencies: required: - number - published_at - licenses - integrity - status - download_url - registry_url - documentation_url - install_command - metadata - created_at - updated_at - purl - version_url - related_tag - latest - dependencies type: object properties: id: type: integer number: type: string published_at: type: string nullable: true licenses: type: string nullable: true integrity: type: string nullable: true status: type: string nullable: true download_url: type: string nullable: true registry_url: type: string nullable: true documentation_url: type: string nullable: true install_command: type: string nullable: true metadata: type: object nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time purl: type: string version_url: type: string related_tag: type: object latest: type: boolean dependencies: type: array items: "$ref": "#/components/schemas/Dependency" VersionWithPackage: required: - id - number - published_at - licenses - integrity - status - download_url - registry_url - documentation_url - install_command - metadata - created_at - updated_at - purl - version_url - related_tag - latest - package_url type: object properties: id: type: integer number: type: string published_at: type: string nullable: true licenses: type: string nullable: true integrity: type: string nullable: true status: type: string nullable: true download_url: type: string nullable: true registry_url: type: string nullable: true documentation_url: type: string nullable: true install_command: type: string nullable: true metadata: type: object nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time purl: type: string latest: type: boolean version_url: type: string package_url: type: string Dependency: required: - id - ecosystem - package_name - requirements - kind - optional type: object properties: id: type: integer ecosystem: type: string package_name: type: string requirements: type: string nullable: true kind: type: string nullable: true optional: type: boolean nullable: true Maintainer: required: - uuid - login - name - email - url - created_at - updated_at - packages_count - packages_url - total_downloads - html_url - role type: object properties: uuid: type: string login: type: string nullable: true name: type: string nullable: true email: type: string nullable: true url: type: string nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time packages_count: type: integer packages_url: type: string total_downloads: type: integer html_url: type: string nullable: true role: type: string nullable: true Namespace: required: - uuid - name - packages_count - packages_url type: object properties: name: type: string packages_count: type: integer packages_url: type: string Advisory: required: - uuid - url - title - description - origin - severity - published_at - withdrawn_at - classification - cvss_score - cvss_vector - references - source_kind - identifiers - packages - created_at - updated_at type: object properties: uuid: type: string url: type: string nullable: true title: type: string nullable: true description: type: string nullable: true origin: type: string nullable: true severity: type: string nullable: true published_at: type: string nullable: true withdrawn_at: type: string nullable: true classification: type: string nullable: true cvss_score: type: number nullable: true cvss_vector: type: string nullable: true references: type: array items: type: string nullable: true source_kind: type: string nullable: true identifiers: type: array items: type: string nullable: true packages: type: array items: type: object created_at: type: string updated_at: type: string Keyword: required: - name - packages_count - packages_url type: object properties: name: type: string packages_count: type: integer packages_url: type: string KeywordWithPackages: required: - name - packages_count - packages_url - related_keywords - packages type: object properties: name: type: string packages_count: type: integer packages_url: type: string related_keywords: type: array items: "$ref": "#/components/schemas/Keyword" packages: type: array items: "$ref": "#/components/schemas/Package" ================================================ FILE: specs/repos.yaml ================================================ --- openapi: 3.0.1 info: title: 'Ecosyste.ms: Repos' description: An open API service providing repository metadata for many open source software ecosystems. contact: name: Ecosyste.ms email: support@ecosyste.ms url: https://ecosyste.ms version: 1.0.0 license: name: CC-BY-SA-4.0 url: https://creativecommons.org/licenses/by-sa/4.0/ externalDocs: description: GitHub Repository url: https://github.com/ecosyste-ms/repos servers: - url: https://repos.ecosyste.ms/api/v1 paths: "/topics": get: summary: Get topics operationId: topics parameters: - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Topic" "/topics/{topic}": get: summary: Get topic operationId: topic parameters: - name: topic in: path description: The topic to get required: true schema: type: string - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: fork in: query description: filter by fork required: false schema: type: boolean - name: archived in: query description: filter by archived required: false schema: type: boolean - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/TopicWithRepositories" "/repositories/lookup": get: summary: Lookup repository metadata by url or purl operationId: repositoriesLookup parameters: - name: url in: query description: The URL of the repository to lookup required: false schema: type: string - name: purl in: query description: package URL required: false schema: type: string responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Repository" "/usage": get: summary: Get package usage ecosystems operationId: usage responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Ecosystem" "/usage/{ecosystem}": get: summary: Get package usage for an ecosystem operationId: usageEcosystem parameters: - name: ecosystem in: path description: The ecosystem to get usage for required: true schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/PackageUsage" "/usage/{ecosystem}/{package}": get: summary: Get package usage for a package operationId: usagePackage parameters: - name: ecosystem in: path description: The ecosystem to get usage for required: true schema: type: string - name: package in: path description: The package to get usage for required: true schema: type: string responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/PackageUsage" "/usage/{ecosystem}/{package}/dependencies": get: summary: Get dependent repositories for a package operationId: usagePackageDependencies parameters: - name: ecosystem in: path description: The ecosystem to get usage for required: true schema: type: string - name: package in: path description: The package to get usage for required: true schema: type: string responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/DependencyWithRepository" "/hosts": get: summary: list registies operationId: getRegistries parameters: - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Host" "/hosts/{hostName}": get: summary: get a host by name operationId: getHost parameters: - in: path name: hostName schema: type: string required: true description: name of host - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Host" "/hosts/{hostName}/owners": get: summary: get a list of owners from a host operationId: getHostOwners parameters: - in: path name: hostName schema: type: string required: true description: name of host - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Owner" "/hosts/{HostName}/owners/lookup": get: summary: lookup owner by name or email operationId: lookupHostOwner parameters: - in: path name: HostName schema: type: string required: true description: name of host - name: name in: query description: name of owner required: false schema: type: string - name: email in: query description: email of owner required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Owner" "/hosts/{hostName}/owners/{ownerLogin}": get: summary: get a owner by login operationId: getHostOwner parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: ownerLogin schema: type: string required: true description: login of owner responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Owner" "/hosts/{hostName}/owners/{ownerLogin}/repositories": get: summary: get a list of repositories from a owner operationId: getHostOwnerRepositories parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: ownerLogin schema: type: string required: true description: login of owner - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: fork in: query description: filter by fork required: false schema: type: boolean - name: archived in: query description: filter by archived required: false schema: type: boolean - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Repository" "/hosts/{hostName}/repositories": get: summary: get a list of repositories from a host operationId: getHostRepositories parameters: - in: path name: hostName schema: type: string required: true description: name of host - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: fork in: query description: filter by fork required: false schema: type: boolean - name: archived in: query description: filter by archived required: false schema: type: boolean - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Repository" "/hosts/{hostName}/repository_names": get: summary: get a list of repository names from a host operationId: getHostRepositoryNames parameters: - in: path name: hostName schema: type: string required: true description: name of host - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: created_after in: query description: filter by created_at after given time required: false schema: type: string format: date-time - name: updated_after in: query description: filter by updated_at after given time required: false schema: type: string format: date-time - name: fork in: query description: filter by fork required: false schema: type: boolean - name: archived in: query description: filter by archived required: false schema: type: boolean - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: type: string "/hosts/{hostName}/repositories/{repositoryName}": get: summary: get a repository by name operationId: getHostRepository parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: repositoryName schema: type: string required: true description: name of repository responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Repository" "/hosts/{hostName}/repositories/{repositoryName}/manifests": get: summary: get a list of manifests for a repository operationId: getHostRepositoryManifests parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: repositoryName schema: type: string required: true description: name of repository - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Manifest" "/hosts/{hostName}/repositories/{repositoryName}/tags": get: summary: get a list of tags for a repository operationId: getHostRepositoryTags parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: repositoryName schema: type: string required: true description: name of repository - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Tag" "/hosts/{hostName}/repositories/{repositoryName}/tags/{tag}": get: summary: get a tag for a repository operationId: getHostRepositoryTag parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: repositoryName schema: type: string required: true description: name of repository - in: path name: tag schema: type: string required: true description: name of tag responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Tag" "/hosts/{hostName}/repositories/{repositoryName}/tags/{tag}/manifests": get: summary: get dependency manifests for a tag operationId: getHostRepositoryTagManifests parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: repositoryName schema: type: string required: true description: name of repository - in: path name: tag schema: type: string required: true description: name of tag responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Manifest" "/hosts/{hostName}/repositories/{repositoryName}/releases": get: summary: get a list of releases for a repository operationId: getHostRepositoryReleases parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: repositoryName schema: type: string required: true description: name of repository - name: page in: query description: pagination page number required: false schema: type: integer - name: per_page in: query description: Number of records to return required: false schema: type: integer - name: sort in: query description: field to order results by required: false schema: type: string - name: order in: query description: direction to order results by required: false schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: "$ref": "#/components/schemas/Tag" "/hosts/{hostName}/repositories/{repositoryName}/releases/{release}": get: summary: get a release for a repository operationId: getHostRepositoryRelease parameters: - in: path name: hostName schema: type: string required: true description: name of host - in: path name: repositoryName schema: type: string required: true description: name of repository - in: path name: release schema: type: string required: true description: tag_name of release responses: 200: description: OK content: application/json: schema: "$ref": "#/components/schemas/Release" components: schemas: Host: type: object properties: name: type: string url: type: string kind: type: string repositories_count: type: integer owners_count: type: integer icon_url: type: string host_url: type: string repositoris_url: type: string repository_names_url: type: string owners_url: type: string version: type: string created_at: type: string format: date-time updated_at: type: string format: date-time Repository: type: object properties: id: type: integer uuid: type: string full_name: type: string owner: type: string description: type: string archived: type: boolean fork: type: boolean pushed_at: type: string format: date-time size: type: integer stargazers_count: type: integer open_issues_count: type: integer forks_count: type: integer subscribers_count: type: integer default_branch: type: string last_synced_at: type: string format: date-time etag: type: string topics: type: array items: type: string latest_commit_sha: type: string homepage: type: string language: type: string has_issues: type: boolean has_wiki: type: boolean has_pages: type: boolean mirror_url: type: string source_name: type: string license: type: string status: type: string scm: type: string pull_requests_enabled: type: boolean icon_url: type: string metadata: type: object created_at: type: string format: date-time updated_at: type: string format: date-time dependencies_parsed_at: type: string format: date-time dependency_job_id: type: string html_url: type: string previous_names: type: array items: type: string tags_count: type: integer template: type: boolean template_full_name: type: string latest_tag_name: type: string latest_tag_published_at: type: string format: date-time repository_url: type: string tags_url: type: string releases_url: type: string manifests_url: type: string owner_url: type: string download_url: type: string commit_stats: type: object host: type: object "$ref": "#/components/schemas/Host" Manifest: type: object properties: ecosystem: type: string filepath: type: string sha: type: string kind: type: string created_at: type: string format: date-time updated_at: type: string format: date-time repository_link: type: string dependencies: type: array items: "$ref": "#/components/schemas/Dependency" Dependency: type: object properties: id: type: integer package_name: type: string ecosystem: type: string requirements: type: string kind: type: string direct: type: boolean optional: type: boolean DependencyWithRepository: type: object properties: id: type: integer package_name: type: string ecosystem: type: string requirements: type: string kind: type: string direct: type: boolean optional: type: boolean repository: type: object "$ref": "#/components/schemas/Repository" manifest: type: object "$ref": "#/components/schemas/Manifest" Tag: type: object properties: name: type: string sha: type: string kind: type: string published_at: type: string format: date-time download_url: type: string html_url: type: string dependencies_parsed_at: type: string format: date-time dependency_job_id: type: string tag_url: type: string manifests_url: type: string Ecosystem: type: object properties: name: type: string packages_count: type: integer ecosystem_url: type: string PackageUsage: type: object properties: ecosystem: type: string name: type: string dependents_count: type: integer package_usage_url: type: string dependencies_url: type: string Owner: type: object properties: name: type: string uuid: type: string kind: type: string email: type: string login: type: string company: type: string location: type: string description: type: string twitter: type: string website: type: string metadata: type: object icon_url: type: string created_at: type: string format: date-time updated_at: type: string format: date-time repositories_count: type: integer last_synced_at: type: string format: date-time owner_url: type: string repositories_url: type: string html_url: type: string funding_links: type: array items: type: string total_stars: type: integer followers: type: integer following: type: integer Topic: type: object properties: name: type: string repositories_count: type: integer topic_url: type: string TopicWithRepositories: type: object properties: name: type: string repositories_count: type: integer topic_url: type: string related_topics: type: array items: "$ref": "#/components/schemas/Topic" repositories: type: array items: "$ref": "#/components/schemas/Repository" Release: type: object properties: name: type: string uuid: type: string tag_name: type: string target_commitish: type: string body: type: string draft: type: boolean prerelease: type: boolean published_at: type: string format: date-time created_at: type: string format: date-time author: type: string assets: type: array items: type: object last_synced_at: type: string format: date-time tag_url: type: string html_url: type: string ================================================ FILE: specs/snyk-experimental.json ================================================ {"components":{"examples":{"CloudListIssuesResponse":{"summary":"An example of a list issue response for a Cloud issue.","value":{"data":[{"attributes":{"classes":[{"id":"data","source":"snyk-cloud","type":"rule-category"},{"id":"CIS-AWS_v1.3.0_2.1.2","source":"CIS-AWS_v1.3.0","type":"compliance"},{"id":"CIS-AWS_v1.4.0_2.1.2","source":"CIS-AWS_v1.4.0","type":"compliance"},{"id":"HIPAA_§164.306(a)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_§164.312(a)(2)(iv)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_v2013_164.312(e)(2)(ii)","source":"HIPAA_v2013","type":"compliance"}],"coordinates":[{"remedies":[{"description":"1. Go to the AWS console\n2. Navigate to the S3 service page\n3. ...","type":"manual"},{"description":"1. Find the corresponding AWS::S3::Bucket resource\n2. ...","type":"cloudformation"},{"description":"1. Find the corresponding aws_s3_bucket resource\n2. ...","type":"terraform"},{"description":"Buckets should not ...","type":"rule_result_message"}],"representations":[{"cloud_resource":{"environment":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b6","name":"Staging","native_id":"721018433921","type":"aws"},"resource":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b7","input_type":"cloud_scan","location":"us-east-1","name":"policy-test-remediation","native_id":"arn:aws:s3:::policy-test-remediation","platform":"aws","resource_type":"aws_s3_bucket","tags":{"Stage":"Prod"},"type":"cloud"}}}]}],"created_at":"2022-09-27T20:09:05Z","description":"To protect data in transit, an S3 bucket policy should deny all HTTP requests to its objects and allow only HTTPS requests. HTTPS uses Transport Layer Security (TLS) to encrypt data, which preserves integrity and prevents tampering.","effective_severity_level":"medium","ignored":false,"key":"b50f2832-a901-565e-9e06-e4e59e8582b6","problems":[{"id":"SNYK-CC-00181","source":"snyk-cloud","type":"rule"}],"resolution":{"details":"rule_passed","resolved_at":"2022-09-28T20:09:05Z","type":"fixed"},"status":"resolved","title":"S3 bucket policies should only allow requests that use HTTPS","tool":"snyk://cloud","type":"cloud","updated_at":"2022-09-28T20:09:05Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"organization":{"data":{"id":"81e93f62-135f-48bc-84d0-47f16822313f","type":"organization"}},"scan_item":{"data":{"id":"24c8e771-ab3b-4e85-ac4f-f73950ba4acf","type":"environment"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"CodeListIssuesResponse20240123":{"summary":"An example of a list issue response for a Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1","status":"resolved","title":"Insecure hash function used","type":"code","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"IaCListIssuesResponse20240123":{"summary":"An example of a list issue response for an Infrastructure as Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"ff35a5c4d1cb4a1fd29c38b70f8ab89d1efea9d75aabf3a202d94f4776714b6191e2747cded23ba6cd7a47017a505a5d2c0823b69106ee2be0c11a18aa44b8a4","status":"resolved","title":"Container is running with writable root filesystem","type":"cloud","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"OpenSourceListIssuesResponse20240123":{"summary":"An example of a list issue response for an Open Source issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"medium","ignored":false,"key":"npm:hoek:20180212:hoek:2.16.3","status":"resolved","title":"Hoek - Prototype Pollution","type":"package_vulnerability","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}}},"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"}},"InternalGlooNormalizedPathHeader":{"description":"An internal header used by Snyk's API-Gateway for analytics.\n","schema":{"type":"string"},"x-snyk-internal":true},"InternalGlooOrgIdHeader":{"description":"An internal header used by Snyk's API-Gateway for analytics.\n","schema":{"format":"uuid","type":"string"},"x-snyk-internal":true},"Location":{"schema":{"type":"string"}},"LocationHeader":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"url","type":"string"}},"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"}},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}},"VersionRequestedResponseHeader":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"$ref":"#/components/schemas/QueryVersion"}},"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"}},"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"}}},"parameters":{"ApiVersion":{"description":"The requested version of the endpoint to process the request","example":"2024-05-13~experimental","in":"query","name":"version","required":true,"schema":{"default":"2024-05-13~experimental","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"}},"AppId":{"description":"App ID","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"BotId":{"description":"Bot ID","in":"path","name":"bot_id","required":true,"schema":{"format":"uuid","type":"string"}},"Cascade":{"description":"indicates whether to delete the child org memberships of the group membership.","in":"query","name":"cascade","schema":{"type":"boolean"}},"ChannelId":{"description":"Slack Channel ID","in":"path","name":"channel_id","required":true,"schema":{"format":"uri","type":"string"}},"ChannelLimit":{"description":"Number of results to return per page","example":100,"in":"query","name":"limit","schema":{"default":1000,"format":"int32","maximum":1000,"minimum":10,"multipleOf":10,"type":"integer"}},"ClientId":{"description":"Client ID","in":"path","name":"client_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"CollectionId":{"description":"Unique identifier for a collection","in":"path","name":"collection_id","required":true,"schema":{"format":"uuid","type":"string"}},"ConnectionId":{"description":"Connection ID","in":"path","name":"connection_id","required":true,"schema":{"format":"uuid","type":"string"}},"ConnectionTypeFilter":{"description":"Filter the response by Users that match the provided connection type","in":"query","name":"connection_type","schema":{"type":"string"}},"ContentSource":{"description":"The source of educational resources","in":"query","name":"content_source","schema":{"enum":["source-preview","cache"],"type":"string"}},"CreatedAfter":{"description":"A filter to select issues created after this date.","in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},"CreatedBefore":{"description":"A filter to select issues created before this date.","in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},"CredentialId":{"description":"Credential ID","in":"path","name":"credential_id","required":true,"schema":{"format":"uuid","type":"string"}},"Cursor":{"description":"The ID for the next page of results.","in":"query","name":"cursor","schema":{"type":"string"}},"CustomBaseImageId":{"description":"Unique identifier for custom base image","in":"path","name":"custombaseimage_id","required":true,"schema":{"format":"uuid","type":"string"}},"DeploymentId":{"description":"Deployment ID","in":"path","name":"deployment_id","required":true,"schema":{"format":"uuid","type":"string"}},"EffectiveSeverityLevel":{"description":"One or more effective severity levels to filter issues.","explode":false,"in":"query","name":"effective_severity_level","schema":{"items":{"enum":["info","low","medium","high","critical"],"type":"string"},"type":"array"},"style":"form"},"EmailFilter":{"description":"Filter the response by Users that match the provided email","in":"query","name":"email","schema":{"type":"string"}},"EndingBefore":{"description":"Return the page of results immediately before this cursor","example":"v1.eyJpZCI6IjExMDAifQo=","in":"query","name":"ending_before","schema":{"type":"string"}},"EnvironmentId":{"description":"Unique identifier for an environment","example":"052781a7-17f6-494d-0000-25c8b509abcd","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"}},"EnvironmentIdQuery":{"description":"Filter resources by environment ID (multi-value, comma-separated)","example":"052781a7-17f6-494d-0000-25c8b509abcd","explode":false,"in":"query","name":"environment_id","schema":{"format":"uuid","type":"string"},"style":"form"},"Events":{"description":"Filter logs by event types, cannot be used in conjunction with exclude_events parameter.","in":"query","name":"events","schema":{"items":{"type":"string"},"type":"array"}},"Exclude":{"description":"An array of features to be excluded from the generated SBOM.","in":"query","name":"exclude","schema":{"items":{"enum":["licenses"],"type":"string"},"type":"array"}},"ExcludeEvents":{"description":"Exclude event types from results, cannot be used in conjunctions with events parameter.","in":"query","name":"exclude_events","schema":{"items":{"type":"string"},"type":"array"}},"Format":{"description":"The desired SBOM format of the response.","in":"query","name":"format","schema":{"enum":["cyclonedx1.5+json","cyclonedx1.5+xml","cyclonedx1.4+json","cyclonedx1.4+xml","spdx2.3+json"],"example":"cyclonedx1.5+json","type":"string"}},"Format20230320":{"description":"The desired SBOM format of the response.","in":"query","name":"format","schema":{"enum":["cyclonedx1.4+json","cyclonedx1.4+xml","spdx2.3+json"],"example":"cyclonedx1.4+json","type":"string"}},"Format20231219":{"description":"The desired SBOM format of the response.","in":"query","name":"format","schema":{"enum":["cyclonedx1.5+json","cyclonedx1.5+xml","cyclonedx1.4+json","cyclonedx1.4+xml","spdx2.3+json"],"example":"cyclonedx1.5+json","type":"string"}},"From":{"description":"The start date (inclusive) of the audit logs search. If not specified, the start of yesterday is used. Dates should be formatted as RFC3339, e.g. 2024-01-02T16:30:00Z.\n","in":"query","name":"from","schema":{"format":"date-time","type":"string"}},"GroupId":{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},"GroupRegistrationId":{"description":"Unique group registration identifier","in":"path","name":"group_registration_id","required":true,"schema":{"format":"uuid","type":"string"}},"HashedBrokerToken":{"description":"Broker token in sha256 hash to retrieve the associated orgs for","in":"path","name":"hashed_broker_token","required":true,"schema":{"type":"string"}},"Id":{"description":"Filter resources by resource UUID (multi-value, comma-separated)","example":"4a662442-7445-55c3-adcc-cbbbdd99999","explode":false,"in":"query","name":"id","schema":{"type":"string"},"style":"form"},"IdInQuery":{"description":"Filter environments by environment ID (multi-value, comma-separated)","example":"052781a7-17f6-494d-0000-25c8b509abcd","in":"query","name":"id","schema":{"format":"uuid","type":"string"}},"IgnoreId":{"description":"Ignore ID","in":"path","name":"ignore_id","required":true,"schema":{"example":"463c1ee5-31bc-428c-b451-b79a3270db08","format":"uuid","type":"string"}},"Ignored":{"description":"Whether an issue is ignored or not.","in":"query","name":"ignored","schema":{"type":"boolean"},"style":"form"},"ImageId20231102":{"description":"Image ID","in":"path","name":"image_id","required":true,"schema":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"}},"ImageIds":{"description":"A comma-separated list of Image IDs","example":["sha256:b26f21f90920dba8401e30b89ad803587f81cce9bd1f92750f963556da2f930f","sha256:28984a62eb713aa5fff922ba06e8689f20e4b2f07de30f3d753b868389c0904f"],"explode":false,"in":"query","name":"image_ids","schema":{"items":{"format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"},"maxItems":100,"type":"array"},"style":"form"},"IncludeGroupMembershipCount":{"description":"indicates whether the count of group memberships is included","in":"query","name":"include_group_membership_count","schema":{"type":"boolean"}},"IncludeInRecommendations":{"description":"Whether this image should be recommended as a base image upgrade","in":"query","name":"include_in_recommendations","schema":{"type":"boolean"}},"InstallId":{"description":"Install ID","in":"path","name":"install_id","required":true,"schema":{"format":"uuid","type":"string"}},"IntegrationId":{"description":"Integration ID","in":"path","name":"integration_id","required":true,"schema":{"format":"uuid","type":"string"}},"IssueKey":{"description":"Describes the unique issue that the ignore rule applies to.","in":"query","name":"issue_key","schema":{"example":"4c0d41cc-4e9d-5a72-8b63-590c476bdd0f","type":"string"}},"IssueSeverity":{"description":"Severity of issues to match","in":"query","name":"severity","schema":{"$ref":"#/components/schemas/IssueSeverity"}},"IssueType":{"description":"Issue type(s) to match, comma-separated","explode":false,"in":"query","name":"type","schema":{"items":{"$ref":"#/components/schemas/IssueType"},"type":"array"},"style":"form"},"JobId":{"description":"Job ID","in":"path","name":"job_id","required":true,"schema":{"format":"uuid","type":"string"}},"Kind":{"description":"Filter resources by kind (multi-value, comma-separated): cloud","example":"cloud","explode":false,"in":"query","name":"kind","schema":{"$ref":"#/components/schemas/ResourceKind"},"style":"form"},"KindInQuery":{"description":"Filter environments by kind (multi-value, comma-separated): aws","example":"aws","in":"query","name":"kind","schema":{"$ref":"#/components/schemas/EnvironmentKind"}},"Limit":{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":10,"multipleOf":10,"type":"integer"}},"Location":{"description":"Filter resources by location (multi-value, comma-separated) (AWS region)","example":"us-west-2","explode":false,"in":"query","name":"location","schema":{"type":"string"},"style":"form"},"MajorVersionPolicy":{"description":"Whether to allow major version upgrades","example":true,"in":"query","name":"allow_major_version","required":true,"schema":{"type":"boolean"}},"MembershipId":{"description":"The ID of the Group Membership","in":"path","name":"membership_id","required":true,"schema":{"format":"uuid","type":"string"}},"MembershipId20240604":{"description":"Unique identifier of the tenant membership.","in":"path","name":"membership_id","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"MoveId":{"description":"Unique identifier for move","in":"path","name":"move_id","required":true,"schema":{"format":"uuid","type":"string"}},"Name":{"description":"Filter resources by name (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"name","schema":{"type":"string"},"style":"form"},"NameFilter":{"description":"Filter the response by Users that match the provided name","in":"query","name":"name","schema":{"type":"string"}},"NameInQuery":{"description":"Filter environments by name (multi-value, comma-separated)","example":"Demo AWS Environment","in":"query","name":"name","schema":{"$ref":"#/components/schemas/EnvironmentName"}},"Names":{"description":"The container registry names","example":["gcr.io/snyk/redis:5"],"explode":false,"in":"query","name":"names","schema":{"items":{"$ref":"#/components/schemas/ImageName"},"maxItems":1,"type":"array"},"style":"form"},"NativeId":{"description":"Filter resources by native ID (multi-value, comma-separated) (AWS ARN)","example":"arn:aws:s3:::example-bucket","explode":false,"in":"query","name":"native_id","schema":{"type":"string"},"style":"form"},"NativeIdInQuery":{"description":"Filter environments by native ID (multi-value, comma-separated)","example":"123456789012","in":"query","name":"native_id","schema":{"type":"string"}},"OrgId":{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgIdFilter":{"description":"The IDs of the org to filter by","explode":false,"in":"query","name":"org_id","schema":{"items":{"format":"uuid","type":"string"},"type":"array"},"style":"form"},"OrgMembershipId":{"description":"The id of the org membership","in":"path","name":"membership_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgName":{"description":"The Name of the org","in":"query","name":"org_name","schema":{"description":"Organization name","example":"Org name","type":"string"}},"OrgRegistrationId":{"description":"Unique org registration identifier","in":"path","name":"org_registration_id","required":true,"schema":{"format":"uuid","type":"string"}},"PackageName":{"description":"The name of the package. Note namespace is a separate property.","example":"logging","in":"query","name":"name","required":true,"schema":{"$ref":"#/components/schemas/Name"}},"PackageNamespace":{"description":"Some name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization","example":"org.example","in":"query","name":"namespace","schema":{"$ref":"#/components/schemas/Namespace"}},"PackageType":{"description":"The package \"type\" or package \"protocol\" such as maven, npm, nuget, gem, pypi, etc.","example":"maven","in":"query","name":"type","required":true,"schema":{"description":"The package \"type\" or package \"protocol\" such as maven, npm, nuget, gem, pypi, etc.","example":"maven","type":"string"}},"PackageUrl":{"description":"A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required.","example":"pkg%3Amaven%2Fcom.fasterxml.woodstox%2Fwoodstox-core%405.0.0","in":"path","name":"purl","required":true,"schema":{"type":"string"}},"PackageVersion":{"description":"The current version of the package","example":"1.2.3","in":"query","name":"current_version","required":true,"schema":{"$ref":"#/components/schemas/Version"}},"PathGroupId":{"description":"Unique identifier for group","in":"path","name":"group_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"PathIssueId20240123":{"description":"Issue ID","in":"path","name":"issue_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},"PathOrgId":{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"Platform":{"description":"The image Operating System and processor architecture","example":"linux/amd64","in":"query","name":"platform","schema":{"$ref":"#/components/schemas/Platform"}},"ProjectId":{"description":"The ID of the container project that the custom base image is based off of.","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},"ProjectRegistrationId":{"description":"Unique project registration identifier","in":"path","name":"project_registration_id","required":true,"schema":{"format":"uuid","type":"string"}},"QueryNameFilter":{"description":"Only return organizations whose name contains this value. Case insensitive.","in":"query","name":"name","schema":{"type":"string"}},"QuerySlugFilter":{"description":"Only return organizations whose slug exactly matches this value. Case sensitive.","in":"query","name":"slug","schema":{"type":"string"}},"Removed":{"description":"Filter resources by whether they have been removed or not.","example":true,"explode":false,"in":"query","name":"removed","schema":{"type":"boolean"},"style":"form"},"Repository":{"description":"The image repository","in":"query","name":"repository","schema":{"type":"string"}},"ResourceId":{"description":"The id of the catalog resource","in":"path","name":"resource_id","required":true,"schema":{"format":"uuid","type":"string"}},"ResourceType":{"description":"Filter resources by resource type (multi-value, comma-separated)","example":"aws_s3_bucket","explode":false,"in":"query","name":"resource_type","schema":{"type":"string"},"style":"form"},"RoleFilter":{"description":"Filter the response for results only with the specified role.","in":"query","name":"role_name","schema":{"type":"string"}},"RoleName":{"description":"The Name of the role","in":"query","name":"role_name","schema":{"description":"Role name","example":"Role name","type":"string"}},"RuleBundleId":{"description":"Rule Bundle ID","example":"63cc647d-9955-4668-942b-ee0621baca7e","in":"path","name":"rule_bundle_id","required":true,"schema":{"format":"uuid","type":"string"}},"ScanId":{"description":"Scan ID","example":"56465b1d-8764-458c-1234-0987abcd6543","in":"path","name":"scan_id","required":true,"schema":{"format":"uuid","type":"string"}},"ScanItemId":{"description":"A scan item id to filter issues through their scan item relationship.","in":"query","name":"scan_item.id","schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbee","format":"uuid","type":"string"},"style":"form"},"ScanItemIds":{"description":"One or more scan item ids to filter issues through their scan item relationship.","explode":false,"in":"query","name":"scan_item.id","schema":{"items":{"example":"4a18d42f-0706-4ad0-b127-24078731fbee","format":"uuid","type":"string"},"type":"array"},"style":"form"},"ScanItemType":{"description":"A scan item types to filter issues through their scan item relationship.","in":"query","name":"scan_item.type","schema":{"$ref":"#/components/schemas/ScanItemType"},"style":"form"},"ScanItemTypes":{"description":"One or more scan item types to filter issues through their scan item relationship.","explode":false,"in":"query","name":"scan_item.type","required":true,"schema":{"items":{"$ref":"#/components/schemas/ScanItemType"},"type":"array"},"style":"form"},"ScanJobId":{"description":"Scan Job ID","in":"path","name":"scanjob_id","required":true,"schema":{"format":"uuid","type":"string"}},"Size":{"description":"Number of results to return per page.","example":10,"in":"query","name":"size","schema":{"default":100,"format":"int32","maximum":100,"minimum":1,"multipleOf":1,"type":"integer"}},"SortBy":{"description":"Which column to sort by.","in":"query","name":"sort_by","schema":{"enum":["username","user_display_name","email","login_method","role_name"],"type":"string"}},"SortDirection":{"description":"Which direction to sort","in":"query","name":"sort_direction","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}},"SortOrder":{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},"SsoId":{"description":"The ID of the SSO","in":"path","name":"sso_id","required":true,"schema":{"format":"uuid","type":"string"}},"StartingAfter":{"description":"Return the page of results immediately after this cursor","example":"v1.eyJpZCI6IjEwMDAifQo=","in":"query","name":"starting_after","schema":{"type":"string"}},"Status":{"description":"An issue's status","explode":false,"in":"query","name":"status","schema":{"items":{"enum":["open","resolved"],"type":"string"},"type":"array"},"style":"form"},"StatusInQuery":{"description":"Filter environments by latest scan status (multi-value, comma-separated)","example":"error","in":"query","name":"status","schema":{"enum":["queued","in_progress","success","error","null"],"type":"string"}},"Tag":{"description":"The image tag","in":"query","name":"tag","schema":{"type":"string"}},"TargetId":{"description":"Unique identifier for a target","in":"path","name":"target_id","required":true,"schema":{"format":"uuid","type":"string"}},"TaskId":{"description":"Task identifier","in":"path","name":"task_id","required":true,"schema":{"type":"string"}},"TenantId":{"description":"Tenant ID","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},"TenantId20240411":{"description":"Unique identifier for tenant","in":"path","name":"tenant_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"TenantId20240509":{"description":"Unique identifier for tenant","in":"path","name":"tenant_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"TenantId20240604":{"description":"Unique identifier of the tenant.","in":"path","name":"tenant_id","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"TenantId20240609":{"description":"Unique identifier for tenant","in":"path","name":"tenant_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"TestId":{"description":"Test ID","in":"path","name":"test_id","required":true,"schema":{"format":"uuid","type":"string"}},"To":{"description":"The end date (exclusive) of the audit logs search. Dates should be formatted as RFC3339, e.g. 2024-01-02T16:30:00Z.\n","in":"query","name":"to","schema":{"format":"date-time","type":"string"}},"Type":{"description":"An issue type to filter issues.","in":"query","name":"type","schema":{"$ref":"#/components/schemas/TypeDef"},"style":"form"},"UpdatedAfter":{"description":"A filter to select issues updated after this date.","in":"query","name":"updated_after","schema":{"format":"date-time","type":"string"}},"UpdatedBefore":{"description":"A filter to select issues updated before this date.","in":"query","name":"updated_before","schema":{"format":"date-time","type":"string"}},"UserId":{"description":"The ID of the User","in":"query","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}},"UserId20220131":{"description":"The ID of the User","in":"path","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}},"UserId20230130":{"description":"The ID of the User","in":"path","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}},"UserId20230303":{"description":"The ID of the User","in":"path","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}},"UserIdFilter":{"description":"Filter the response by Users that match the provided user ID","in":"query","name":"user_id","schema":{"type":"string"}},"UsernameFilter":{"description":"Filter the response by Users that match the provided username","in":"query","name":"username","schema":{"type":"string"}},"Version":{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"$ref":"#/components/schemas/QueryVersion"}},"VulnerabilityId":{"description":"Snyk id of the vulnerability the ignore rule applies to","in":"query","name":"vulnerability_id","schema":{"example":"npm:qs:20140806-1","type":"string"}}},"responses":{"204":{"description":"The operation completed successfully with no content","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":{"$ref":"#/components/schemas/ErrorDocument"}}},"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"},"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":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Unauthorized: the request requires an authentication token.","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"}}},"403":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Forbidden: the request requires an authentication token with more or different permissions.","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":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Not Found: The resource being operated on could not be found.","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":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","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"}}},"422":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Unprocessable Entity: The requested operation failed processing, but request syntax and content are correct.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","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"}}},"GetIssue20020240123":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Issue"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"]}}},"description":"Returns an instance of an issue","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"uri","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"}}},"ListIssues200":{"content":{"application/vnd.api+json":{"examples":{"Cloud":{"$ref":"#/components/examples/CloudListIssuesResponse"},"Code":{"$ref":"#/components/examples/CodeListIssuesResponse20240123"},"IaC":{"$ref":"#/components/examples/IaCListIssuesResponse20240123"},"OpenSource":{"$ref":"#/components/examples/OpenSourceListIssuesResponse20240123"}},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Issue"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"]}}},"description":"Returns a collection 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"}}}},"schemas":{"AccessRequest":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AccessRequestAttributes"},"id":{"description":"The Snyk ID of the access request.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"AccessRequestAttributes":{"additionalProperties":false,"properties":{"status":{"enum":["pending","expired"],"type":"string"}},"required":["status"],"type":"object"},"AccessTokenTtlSeconds":{"description":"The access token time to live for your app, in seconds. It only affects the newly generated access tokens, existing access token will continue to have their previous time to live as expiration.","example":3600,"maximum":86400,"minimum":3600,"type":"number"},"AcrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["acr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"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"},"AllAppRiskAttributes":{"allOf":[{"$ref":"#/components/schemas/CheckmarxAttributes"},{"$ref":"#/components/schemas/SonarqubeAttributes"}]},"ApiMonitorFlow":{"additionalProperties":false,"properties":{"name":{"description":"The api monitor flow is stateful test flow","enum":["api_monitor"],"example":"api_monitor","type":"string"}},"required":["name"],"type":"object"},"ApiTestFlow":{"additionalProperties":false,"properties":{"name":{"description":"The api test flow is stateless test flow","enum":["api_test"],"example":"api_test","type":"string"}},"required":["name"],"type":"object"},"AppAuthorizationAttributes":{"description":"Attributes for an App Authorization.","properties":{"snyk_auth_valid":{"description":"An indicator of whether the Snyk app authorization is currently valid. If an authorization is not valid, the user must re-authorize the app for the tenant.","type":"boolean"},"type":{"$ref":"#/components/schemas/RegistrationType"}},"required":["type","snyk_auth_valid"],"type":"object"},"AppAuthorizationData":{"description":"An object representing a Cloud Events app and its authorization status for a given tenant.","properties":{"attributes":{"$ref":"#/components/schemas/AppAuthorizationAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"AppBot":{"additionalProperties":false,"properties":{"attributes":{"type":"object"},"id":{"format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicApp"}},"type":"object"}},"required":["app"],"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","relationships"],"type":"object"},"AppData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributes"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppData20220311":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributes20220311"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppDataWithSecret":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributesWithSecret"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppDataWithSecret20220311":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributesWithSecret20220311"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallData":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"description":"The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"installed_at":{"$ref":"#/components/schemas/InstalledAt"}},"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicAppData"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallDataWithSecret":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"description":"The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"client_secret":{"$ref":"#/components/schemas/ClientSecret20240523"},"installed_at":{"$ref":"#/components/schemas/InstalledAt"}},"required":["client_id","client_secret"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicAppData"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallWithClient":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"format":"uuid","type":"string"},"client_secret":{"type":"string"}},"required":["client_id","client_secret"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/Uuid"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes","relationships"],"type":"object"},"AppInstance":{"additionalProperties":false,"properties":{"default_org_context":{"description":"ID of the default org for the service account.","format":"uuid","type":"string"},"name":{"description":"The name of the service account.","example":"user","type":"string"}},"required":["name"],"type":"object"},"AppName":{"description":"New name of the app to display to users during authorization flow.","example":"My App","minLength":1,"type":"string"},"AppPatchRequest":{"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"}},"type":"object"},"type":{"enum":["app"],"type":"string"}},"type":"object"}},"required":["data"],"type":"object"},"AppPatchRequest20220311":{"additionalProperties":false,"minProperties":1,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"}},"type":"object"},"AppPostRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"context":{"description":"Allow installing the app to at org/group level or user level. Defaults to tenant.","enum":["tenant","user"],"type":"string"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","redirect_uris","scopes","context"],"type":"object"},"type":{"enum":["app"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"AppPostRequest20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"context":{"$ref":"#/components/schemas/Context"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","redirect_uris","scopes"],"type":"object"},"AppPostResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"},"AppPostResponse20220311":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"},"AppResourceAttributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId"},"context":{"description":"Allow installing the app to at org/group level or user level. Defaults to tenant.","enum":["tenant","user"],"type":"string"},"grant_type":{"$ref":"#/components/schemas/GrantType"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","scopes","access_token_ttl_seconds","is_public","is_confidential","context","grant_type"],"type":"object"},"AppResourceAttributes20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"description":"The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"context":{"$ref":"#/components/schemas/Context"},"grant_type":{"$ref":"#/components/schemas/GrantType20220311"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential20220311"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUrisNoMin"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","context","grant_type"],"type":"object"},"AppResourceAttributesWithSecret":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId"},"client_secret":{"$ref":"#/components/schemas/ClientSecret"},"context":{"description":"Allow installing the app to at org/group level or user level. Defaults to tenant.","enum":["tenant","user"],"type":"string"},"grant_type":{"$ref":"#/components/schemas/GrantType"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","client_secret","context","grant_type"],"type":"object"},"AppResourceAttributesWithSecret20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"description":"The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"client_secret":{"$ref":"#/components/schemas/ClientSecret"},"context":{"$ref":"#/components/schemas/Context"},"grant_type":{"$ref":"#/components/schemas/GrantType20220311"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential20220311"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","client_secret","context","grant_type"],"type":"object"},"AppRiskAttributes":{"properties":{"required":{"oneOf":[{"$ref":"#/components/schemas/CheckmarxAttributes"},{"$ref":"#/components/schemas/SonarqubeAttributes"},{"$ref":"#/components/schemas/AllAppRiskAttributes"}],"type":"object"},"type":{"enum":["apprisk"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"ArtifactoryAttributes":{"properties":{"required":{"properties":{"artifactory_url":{"format":"uuid","type":"string"}},"required":["artifactory_url"],"type":"object"},"type":{"enum":["artifactory"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"ArtifactoryCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["artifactory-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"Attributes":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/PackageUrl"},"name":{"$ref":"#/components/schemas/Name"},"namespace":{"$ref":"#/components/schemas/Namespace"},"published_date":{"$ref":"#/components/schemas/PublishedDate"},"type":{"description":"The package \"type\" or package \"protocol\" such as maven, npm, nuget, gem, pypi, etc.","example":"maven","type":"string"},"version":{"$ref":"#/components/schemas/Version"}},"required":["id","name","version","type"],"type":"object"},"AuditLogSearch":{"properties":{"items":{"items":{"properties":{"content":{"type":"object"},"created":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"org.create","type":"string"},"group_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"},"org_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"},"project_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"}},"required":["created","event"],"type":"object"},"type":"array"},"type":{"type":"string"}},"type":"object"},"AutoCompletionsResponseAttributes":{"example":[{"begin_offset":-1,"docstring":"Matches on soqli sanitizers (Language support: Apex).\\n\\n","score":"0.030303030303030325","suggestion_text":"PRED:SoqliSanitizer"}],"items":{"$ref":"#/components/schemas/CodeSuggestion"},"type":"array"},"AutoDependencyUpgradeSettings":{"additionalProperties":false,"description":"Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Project's integration.","properties":{"ignored_dependencies":{"description":"Dependencies which should NOT be included in an automatic upgrade operation.","example":["typescript"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically raise pull requests to update out-of-date dependencies.","example":true,"type":"boolean"},"is_inherited":{"description":"Apply the auto dependency integration settings of the Organization to this project.","example":true,"type":"boolean"},"is_major_upgrade_enabled":{"description":"Include major version in dependency upgrade recommendation.","example":true,"type":"boolean"},"limit":{"description":"Limit of dependency upgrade PRs which can be opened simultaneously. When the limit is reached, no new upgrade PRs are created. If specified, must be between 1 and 10.","example":10,"maximum":10,"minimum":1,"type":"number"},"minimum_age":{"description":"Minimum dependency maturity period in days. If specified, must be between 1 and 365.","example":365,"type":"number"}},"type":"object"},"AutoDependencyUpgradeSettings20240531":{"additionalProperties":false,"description":"Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Organization's integration.","properties":{"ignored_dependencies":{"description":"Dependencies which should NOT be included in an automatic upgrade operation.","example":["typescript"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically raise pull requests to update out-of-date dependencies.","example":true,"type":"boolean"},"is_major_upgrade_enabled":{"description":"Include major version in dependency upgrade recommendation.","example":true,"type":"boolean"},"limit":{"description":"Limit of dependency upgrade PRs which can be opened simultaneously. When the limit is reached, no new upgrade PRs are created. If specified, must be between 1 and 10.","example":10,"maximum":10,"minimum":1,"type":"number"},"minimum_age":{"description":"Minimum dependency maturity period in days. If specified, must be between 1 and 365.","example":365,"type":"number"}},"type":"object"},"AutoRemediationPRsSettings":{"additionalProperties":false,"description":"Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration.","properties":{"is_backlog_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities.","example":true,"type":"boolean"},"is_fresh_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for new vulnerabilities.","example":true,"type":"boolean"},"is_patch_remediation_enabled":{"description":"Include vulnerability patches in automatic pull requests.","example":true,"type":"boolean"}},"type":"object"},"AutoRemediationPRsSettings20240531":{"additionalProperties":false,"description":"Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.","properties":{"is_backlog_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities.","example":true,"type":"boolean"},"is_fresh_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for new vulnerabilities.","example":true,"type":"boolean"},"is_patch_remediation_enabled":{"description":"Include vulnerability patches in automatic pull requests.","example":true,"type":"boolean"}},"type":"object"},"AwsOptions":{"additionalProperties":false,"description":"Options for creating an AWS environment","example":{"role_arn":"arn:aws:iam::12345678910:role/SnykCloud1234"},"properties":{"role_arn":{"description":"AWS IAM role ARN for Snyk","example":"arn:aws:iam::12345678910:role/SnykCloud1234","type":"string"}},"required":["role_arn"],"type":"object"},"AzureOptions":{"additionalProperties":false,"description":"Options for creating an Azure environment","example":{"application_id":"1234d000-8dd4-11ed-a1eb-5678ac120002","subscription_id":"6884d000-8dd4-11ed-a1eb-0242ac120002","tenant_id":"51627f08-8dd4-11ed-a1eb-0242ac120002"},"properties":{"application_id":{"description":"ID of the Azure app registration with permissions to scan","example":"1234d000-8dd4-11ed-a1eb-5678ac120002","type":"string"},"subscription_id":{"description":"ID of the Azure subscription to be scanned","example":"6884d000-8dd4-11ed-a1eb-0242ac120002","type":"string"},"tenant_id":{"description":"Azure Tenant (directory) ID","example":"51627f08-8dd4-11ed-a1eb-0242ac120002","type":"string"}},"required":["tenant_id","subscription_id"],"type":"object"},"AzureReposAttributes":{"properties":{"required":{"properties":{"azure_repos_org":{"example":"\u003cusername\u003e:\u003cpassword\u003e@\u003cyourdomain.artifactory.com\u003e/artifactory","type":"string"},"azure_repos_token":{"format":"uuid","type":"string"},"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"}},"required":["azure_repos_org","azure_repos_token","broker_client_url"],"type":"object"},"type":{"enum":["azure-repos"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"BitbucketServer":{"properties":{"bitbucket":{"example":"bitbucket.yourdomain.com","type":"string"},"bitbucket_password":{"format":"uuid","type":"string"},"bitbucket_username":{"example":"\u003cusername\u003e","type":"string"},"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"}},"required":["bitbucket","bitbucket_password","bitbucket_username","broker_client_url"],"type":"object"},"BitbucketServerAttributes":{"properties":{"required":{"oneOf":[{"$ref":"#/components/schemas/BitbucketServer"},{"$ref":"#/components/schemas/BitbucketServerBearerAuth"}]},"type":{"enum":["bitbucket-server"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"BitbucketServerBearerAuth":{"properties":{"bitbucket":{"example":"bitbucket.yourdomain.com","type":"string"},"bitbucket_pat":{"format":"uuid","type":"string"},"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"}},"required":["bitbucket","bitbucket_pat","broker_client_url"],"type":"object"},"BrokerAttributes":{"additionalProperties":false,"example":{"hashed_broker_token":"0123456789012345678901234567890123456789012345678901234567890123","integration_type":"jira","orgs":["00000000-0000-0000-0000-000000000000","11111111-1111-1111-1111-111111111111"]},"properties":{"hashed_broker_token":{"type":"string"},"integration_type":{"type":"string"},"orgs":{"items":{"type":"string"},"type":"array"}},"required":["hashed_broker_token","orgs","integration_type"],"type":"object"},"BrokerConnectionResponseResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CommonConnectionResponseAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_connection"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BrokerDeploymentAttributes":{"additionalProperties":false,"properties":{"broker_app_installed_in_org_id":{"description":"Org Id in which the Broker App is installed","format":"uuid","type":"string"},"install_id":{"description":"Associated Install ID","format":"uuid","readOnly":true,"type":"string"},"metadata":{"description":"Metadata information such user/org id or metrics","type":"object"}},"required":["broker_app_installed_in_org_id"],"type":"object"},"BrokerDeploymentResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/BrokerDeploymentAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_deployment"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BrokerDeploymentUpdateAttributes":{"additionalProperties":false,"properties":{"broker_app_installed_in_org_id":{"description":"Org Id in which the Broker App is installed","format":"uuid","type":"string"},"install_id":{"description":"Associated Install ID","format":"uuid","type":"string"},"metadata":{"description":"Metadata information such user/org id or metrics","type":"object"}},"required":["broker_app_installed_in_org_id","install_id"],"type":"object"},"BrokerDeploymentUpdateResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/BrokerDeploymentUpdateAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_deployment"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BulkPackageUrlsRequestBody":{"properties":{"data":{"properties":{"attributes":{"properties":{"purls":{"description":"An array of Package URLs (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required.","items":{"type":"string"},"type":"array"}},"required":["purls"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"},"CVSSSource":{"additionalProperties":false,"properties":{"level":{"example":"medium","minLength":1,"type":"string"},"modification_time":{"description":"The time this CVSS data was last updated","format":"date-time","type":"string"},"score":{"example":4.2,"format":"float","type":"number"},"source":{"example":"snyk","minLength":1,"type":"string"},"vector":{"example":"CVSS:4.0/AV:N/AC:H/AT:N/PR:L/UI:A/VC:N/VI:N/VA:N/SC:H/SI:L/SA:L/E:A","minLength":1,"type":"string"},"version":{"example":"4.0","minLength":1,"type":"string"}},"required":["level","source","score","vector","version","modification_time"],"type":"object"},"CheckmarxAttributes":{"properties":{"checkmarx":{"example":"checkmarx.customer.com","type":"string"},"checkmarx_password":{"format":"uuid","type":"string"},"checkmarx_username":{"example":"\u003cusername\u003e","type":"string"}},"required":["checkmarx","checkmarx_password","checkmarx_username"],"type":"object"},"Class":{"additionalProperties":false,"example":{"id":"CWE-190","source":"CWE","type":"weakness"},"properties":{"id":{"maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CWE","maxLength":64,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/ClassTypeDef"},"url":{"description":"An optional URL for this class.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","type","source"],"type":"object"},"ClassTypeDef":{"enum":["rule-category","compliance","weakness"],"example":"compliance","type":"string"},"CliTestFlow":{"additionalProperties":false,"properties":{"name":{"description":"The flow which the scan is triggered for.","enum":["cli_test"],"example":"cli_test","type":"string"}},"required":["name"],"type":"object"},"ClientId":{"description":"The oauth2 client id for the app.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"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\u003c]S_v1","minLength":1,"type":"string"},"ClientSecret20240523":{"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. Only provided for installations of non-interactive Snyk Apps.","example":"snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht\u003c]S_v1","minLength":1,"type":"string"},"CloudResource":{"properties":{"environment":{"properties":{"id":{"description":"Internal ID for an environment.","format":"uuid","type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this environment. For example, a cloud account id.","maxLength":2048,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"resource":{"properties":{"iac_mappings_count":{"description":"Amount of IaC resources this resource maps to.","format":"int64","minimum":0,"type":"integer"},"id":{"description":"Internal ID for a resource.","format":"uuid","type":"string"},"input_type":{"enum":["cloud_scan","arm","k8s","tf","tf_hcl","tf_plan","tf_state","cfn"],"type":"string"},"location":{"maxLength":256,"minLength":1,"type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this resource. For example, a cloud resource id.","maxLength":2048,"minLength":1,"type":"string"},"platform":{"maxLength":256,"minLength":1,"type":"string"},"resource_type":{"maxLength":256,"minLength":1,"type":"string"},"tags":{"additionalProperties":{"maxLength":256,"type":"string"},"type":"object"},"type":{"enum":["cloud","iac"],"type":"string"}},"required":["input_type"],"type":"object"}},"required":["environment"],"type":"object"},"CloudTrailConfig":{"description":"A registration config specific to AWS CloudTrail.","example":{"account_id":"123456789012","channel_arn":"arn:partition:service:region:account-id:resource-id"},"properties":{"account_id":{"type":"string"},"channel_arn":{"example":"arn:partition:service:region:account-id:resource-id","type":"string"}},"type":"object"},"CodeEnablement":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"autofix_enabled":{"type":"boolean"},"sast_enabled":{"type":"boolean"}},"required":["sast_enabled"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"CodeIssue":{"description":"An issue discovered by SAST code analysis","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/IssueSummaryAttributesSnakeCase"},{"properties":{"fingerprint":{"example":"43e940cd.45cfe696.f0420b1d.0de66e91...","nullable":true,"type":"string"},"fingerprint_version":{"example":"1","nullable":true,"type":"string"},"primary_file_path":{"example":"routes/index.js","type":"string"},"primary_region":{"description":"SARIF code region object","example":{"end_column":345,"end_line":345,"start_column":345,"start_line":345},"properties":{"end_column":{"example":345,"nullable":true,"type":"number"},"end_line":{"example":345,"nullable":true,"type":"number"},"start_column":{"example":345,"nullable":true,"type":"number"},"start_line":{"example":345,"nullable":true,"type":"number"}},"type":"object"},"priority_score":{"example":856,"type":"number"},"priority_score_factors":{"description":"Descriptions of factors affecting priority score","example":["Found in a file appearing in multiple code flows"],"items":{"type":"string"},"type":"array"}},"type":"object"}]},"id":{"description":"Code public issue ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"code-issue","type":"string"}},"required":["type","id","attributes"],"type":"object"},"CodeIssue20210813":{"description":"An issue discovered by SAST code analysis","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/IssueSummaryAttributes"},{"properties":{"fingerprint":{"example":"43e940cd.45cfe696.f0420b1d.0de66e91...","nullable":true,"type":"string"},"fingerprintVersion":{"example":"1","nullable":true,"type":"string"},"primaryFilePath":{"example":"routes/index.js","type":"string"},"primaryRegion":{"description":"SARIF code region object","example":{"endColumn":345,"endLine":345,"startColumn":345,"startLine":345},"type":"object"},"priorityScore":{"example":856,"type":"number"},"priorityScoreFactors":{"description":"Descriptions of factors affecting priority score","example":["Found in a file appearing in multiple code flows"],"items":{"type":"string"},"type":"array"}},"type":"object"}]},"id":{"description":"Code public issue ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"code-issue","type":"string"}},"required":["type","id","attributes"],"type":"object"},"CodeMatch":{"example":{"file_name":"file.py","location":[{"col_begin":6,"col_end":17,"line_begin":1,"line_end":1}],"source_code":"pw = \"sensitive\""},"properties":{"file_name":{"type":"string"},"location":{"items":{"$ref":"#/components/schemas/MatchLocation"},"type":"array"},"source_code":{"type":"string"}},"required":["file_name","source_code","location"],"type":"object"},"CodeSecurityPolicy":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CodeSecurityPolicyAttributes"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"relationships":{"properties":{"orgs":{"additionalProperties":false,"description":"An optional set of organizations explicitly associated with this policy. Only one of explicit associations\nor project_attributes may be set.\n","properties":{"self":{"type":"string"}},"required":["self"],"type":"object"}},"type":"object"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"CodeSecurityPolicyAttributes":{"additionalProperties":false,"properties":{"configuration":{"description":"A list of Code policy rules.\n","items":{"oneOf":[{"$ref":"#/components/schemas/CodeSecurityPolicyAttributesCwe"},{"$ref":"#/components/schemas/CodeSecurityPolicyAttributesRuleId"}]},"type":"array"},"default":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"orgs":{"items":{"format":"uuid","type":"string"},"type":"array"},"policy_type":{"enum":["sast"],"type":"string"},"project_attributes":{"additionalProperties":false,"properties":{"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"}},"required":["business_criticality","lifecycle","environment"],"type":"object"}},"required":["name","default","policy_type","configuration"],"type":"object"},"CodeSecurityPolicyAttributesCwe":{"additionalProperties":false,"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/PolicyActionSeverityOverride"},{"$ref":"#/components/schemas/PolicyActionIgnore20231127"}]},"type":"array"},"conditions":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["cwe"],"type":"string"},"operator":{"enum":["includes","not-includes"],"type":"string"},"value":{"items":{"type":"string"},"type":"array"}},"required":["field","operator","value"],"type":"object"},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"CodeSecurityPolicyAttributesRuleId":{"additionalProperties":false,"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/PolicyActionSeverityOverrideLowMediumHigh"},{"$ref":"#/components/schemas/PolicyActionIgnore20231127"}]},"type":"array"},"conditions":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["rule-id"],"type":"string"},"operator":{"enum":["includes","not-includes"],"type":"string"},"value":{"items":{"type":"string"},"type":"array"}},"required":["field","operator","value"],"type":"object"},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"CodeSecurityPolicyAttributesUpdate":{"additionalProperties":false,"properties":{"configuration":{"description":"A list of security policy rules.\n","items":{"oneOf":[{"$ref":"#/components/schemas/CodeSecurityPolicyAttributesCwe"},{"$ref":"#/components/schemas/CodeSecurityPolicyAttributesRuleId"}]},"type":"array"},"default":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"CodeSecurityPolicyUpdate":{"properties":{"attributes":{"$ref":"#/components/schemas/CodeSecurityPolicyAttributesUpdate"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"CodeSuggestion":{"example":{"begin_offset":-1,"docstring":"Matches on soqli sanitizers (Language support: Apex).\\n\\n","score":"0.030303030303030325","suggestion_text":"PRED:SoqliSanitizer"},"properties":{"begin_offset":{"format":"int64","type":"integer"},"docstring":{"type":"string"},"score":{"type":"string"},"suggestion_text":{"type":"string"}},"required":["suggestion_text","begin_offset","score","docstring"],"type":"object"},"CollectionAttributes":{"additionalProperties":false,"properties":{"is_generated":{"type":"boolean"},"name":{"description":"User-defined name of the collection","type":"string"}},"required":["name"],"type":"object"},"CollectionMeta":{"additionalProperties":false,"properties":{"issues_critical_count":{"description":"The sum of critical severity issues of the collection's projects","example":10,"type":"number"},"issues_high_count":{"description":"The sum of high severity issues of the collection's projects","example":10,"type":"number"},"issues_low_count":{"description":"The sum of low severity issues of the collection's projects","example":10,"type":"number"},"issues_medium_count":{"description":"The sum of medium severity issues of the collection's projects","example":10,"type":"number"},"projects_count":{"description":"The amount of projects belonging to this collection","example":7,"type":"number"}},"required":["projects_count","issues_critical_count","issues_high_count","issues_medium_count","issues_low_count"],"type":"object"},"CollectionRelationships":{"additionalProperties":false,"properties":{"created_by_user":{"properties":{"data":{"properties":{"id":{"description":"ID of the user that created the collection. Null for auto-collections.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","nullable":true,"type":"string"},"type":{"enum":["user"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"org":{"properties":{"data":{"properties":{"id":{"description":"ID of the org that this collection belongs to","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"enum":["org"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["org","created_by_user"],"type":"object"},"CollectionResponse":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"id":{"format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/CollectionMeta"},"relationships":{"$ref":"#/components/schemas/CollectionRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","meta","attributes","relationships"],"type":"object"},"CommonConnectionAttributes":{"allOf":[{"$ref":"#/components/schemas/ConnectionAttributes"},{"$ref":"#/components/schemas/ConfigurationAttributes"}]},"CommonConnectionResponseAttributes":{"allOf":[{"$ref":"#/components/schemas/ConnectionAttributes"},{"$ref":"#/components/schemas/ConfigurationResponseAttributes"}]},"CommonIssueModelVThree":{"properties":{"attributes":{"properties":{"coordinates":{"items":{"$ref":"#/components/schemas/Coordinate"},"type":"array"},"created_at":{"example":"2022-06-16T13:51:13Z","format":"date-time","type":"string"},"description":{"description":"A description of the issue in Markdown format","example":"## Overview\\n\\n\\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.","type":"string"},"effective_severity_level":{"description":"The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies.","enum":["info","low","medium","high","critical"],"type":"string"},"problems":{"items":{"$ref":"#/components/schemas/Problem3"},"type":"array"},"severities":{"description":"An array of dictionaries containing all known data related to the vulnerability","items":{"$ref":"#/components/schemas/Severity3"},"type":"array"},"slots":{"$ref":"#/components/schemas/Slots"},"title":{"description":"A human-readable title for this issue.","example":"XML External Entity (XXE) Injection","type":"string"},"type":{"description":"The issue type","example":"package_vulnerability","type":"string"},"updated_at":{"description":"When the vulnerability information was last modified.","example":"2022-06-16T14:00:24.315507Z","format":"date-time","type":"string"}},"type":"object"},"id":{"description":"The Snyk ID of the vulnerability.","example":"SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754","type":"string"},"type":{"description":"The type of the REST resource. Always ‘issue’.","example":"issue","type":"string"}},"type":"object"},"Component":{"additionalProperties":false,"description":"A component identifies a subset of the given repository (a file, a bunch of files, the entire repo, or perhaps a fragment of a file) that may contain findings attached to it.\nE.g. server/package.json for SCA or a java repository for SAST\n","properties":{"created_at":{"description":"Point in time in which this component was created","example":"2017-07-21T17:32:28Z","format":"date-time","type":"string"},"findings_url":{"description":"Optional URL containing the findings for this component","example":"https://example.com","format":"uri","type":"string"},"id":{"description":"ID of this component as provided by the scanner","example":"e.g. package.json, 123e4567-e89b-12d3-a456-426655440000...","type":"string"},"name":{"description":"Human readable name of this component as provided by the scanner","example":"e.g. package.json, java repository...","type":"string"},"type":{"description":"Identifies the type of this component as provided by the scanner among the ones supported by Snyk","example":"e.g. pip, govendor, nuget...","type":"string"}},"required":["id","name","type","created_at"],"type":"object"},"ConfigurationAttributes":{"properties":{"configuration":{"discriminator":{"mapping":{"acr":"./acr.yaml#/schemas/AcrAttributes","apprisk":"./apprisk.yaml#/schemas/AppRiskAttributes","artifactory":"./artifactory.yaml#/schemas/ArtifactoryAttributes","artifactory-cr":"./artifactoryCr.yaml#/schemas/ArtifactoryCr","azure-repos":"./azureRepos.yaml#/schemas/AzureReposAttributes","bitbucket-server":"./bitbucketServer.yaml#/schemas/BitbucketServerAttributes","digitalocean-cr":"./digitaloceanCr.yaml#/schemas/DigitalOceanCrAttributes","docker-hub":"./dockerHub.yaml#/schemas/DockerHubAttributes","ecr":"./ecr.yaml#/schemas/EcrAttributes","gcr":"./gcr.yaml#/schemas/GcrAttributes","github":"./github.yaml#/schemas/GitHubAttributes","github-cloud-app":"./githubServerApp.yaml#/schemas/GitHubCloudAppAttributes","github-cr":"./githubCr.yaml#/schemas/GithubCrAttributes","github-enterprise":"./githubEnterprise.yaml#/schemas/GitHubEnterpriseAttributes","github-server-app":"./githubServerApp.yaml#/schemas/GitHubServerAppAttributes","gitlab":"./gitlab.yaml#/schemas/GitLabAttributes","gitlab-cr":"./gitlabCr.yaml#/schemas/GitlabCrAttributes","google-artifact-cr":"./googleArtifactCr.yaml#/schemas/GoogleArtifactCrAttributes","harbor-cr":"./harborCr.yaml#/schemas/HarborCrAttributes","jira":"./jira.yaml#/schemas/JiraAttributes","nexus":"./nexus.yaml#/schemas/NexusAttributes","nexus-cr":"./nexusCr.yaml#/schemas/NexusCrAttributes","quay-cr":"./quayCr.yaml#/schemas/QuayCrAttributes","workload":"./workload.yaml#/schemas/WorkloadAttributes"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppRiskAttributes"},{"$ref":"#/components/schemas/ArtifactoryAttributes"},{"$ref":"#/components/schemas/AzureReposAttributes"},{"$ref":"#/components/schemas/BitbucketServerAttributes"},{"$ref":"#/components/schemas/GitHubAttributes"},{"$ref":"#/components/schemas/GitHubEnterpriseAttributes"},{"$ref":"#/components/schemas/GitHubServerAppAttributes"},{"$ref":"#/components/schemas/GitHubCloudAppAttributes"},{"$ref":"#/components/schemas/GitLabAttributes"},{"$ref":"#/components/schemas/JiraAttributes"},{"$ref":"#/components/schemas/NexusAttributes"},{"$ref":"#/components/schemas/AcrAttributes"},{"$ref":"#/components/schemas/ArtifactoryCrAttributes"},{"$ref":"#/components/schemas/DigitalOceanCrAttributes"},{"$ref":"#/components/schemas/DockerHubAttributes"},{"$ref":"#/components/schemas/EcrAttributes"},{"$ref":"#/components/schemas/GcrAttributes"},{"$ref":"#/components/schemas/GithubCrAttributes"},{"$ref":"#/components/schemas/GitlabCrAttributes"},{"$ref":"#/components/schemas/GoogleArtifactCrAttributes"},{"$ref":"#/components/schemas/HarborCrAttributes"},{"$ref":"#/components/schemas/NexusCrAttributes"},{"$ref":"#/components/schemas/QuayCrAttributes"},{"$ref":"#/components/schemas/WorkloadAttributes"}]}},"required":["configuration"],"type":"object"},"ConfigurationResponseAttributes":{"allOf":[{"$ref":"#/components/schemas/GenericConfigurationAttributes"}]},"ConnectionAttributes":{"properties":{"deployment_id":{"description":"Associated Deployment ID","format":"uuid","type":"string"},"identifier":{"description":"Broker identifier","format":"uuid","type":"string"},"name":{"description":"Associated name","type":"string"},"secrets":{"properties":{"primary":{"$ref":"#/components/schemas/SecretAttributes"},"secondary":{"$ref":"#/components/schemas/SecretAttributes"}},"required":["primary","secondary"],"type":"object"}},"required":["deployment_id","name"],"type":"object"},"ConnectionRelationship":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"description":"Associated item id","type":"string"},"type":{"description":"Associated item type","type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"},"ConnectionRelationships":{"additionalProperties":false,"properties":{"broker_connections":{"items":{"$ref":"#/components/schemas/ConnectionRelationship"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["broker_connections"],"type":"object"},"ContainerBuildArgs":{"additionalProperties":false,"properties":{"platform":{"type":"string"}},"required":["platform"],"type":"object"},"Context":{"description":"Allow installing the app to a org/group or to a user, default tenant.","enum":["tenant","user"],"type":"string"},"Coordinate":{"properties":{"remedies":{"items":{"$ref":"#/components/schemas/Remedy3"},"type":"array"},"representations":{"description":"The affected versions of this vulnerability.","items":{"anyOf":[{"$ref":"#/components/schemas/ResourcePathRepresentation"},{"$ref":"#/components/schemas/PackageRepresentation"}]},"type":"array"}},"required":["representations"],"type":"object"},"CreateBrokerConnectionIntegration":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/IntegrationResource"}},"required":["data"],"type":"object"},"CreateBrokerConnectionRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/CommonConnectionAttributes"},"type":{"enum":["broker_connection"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"CreateBrokerDeploymentRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BrokerDeploymentAttributes"}]},"type":{"enum":["broker_deployment"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"CreateCollectionRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/name"}},"required":["name"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CreateDeploymentCredentialRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/DeploymentCredentialsAttributes"},"type":{"enum":["deployment_credential"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"CreateGroupMembershipRequestBody":{"properties":{"data":{"additionalProperties":false,"properties":{"relationships":{"additionalProperties":false,"properties":{"group":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"8aab168e-fb3b-47c0-9d87-442715788b31","format":"uuid","type":"string"},"type":{"description":"Always \"group\"","enum":["group"],"example":"group","type":"string"}},"type":"object"}},"type":"object"},"role":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Always \"group_role\"","enum":["group_role"],"example":"group_role","type":"string"}},"type":"object"}},"type":"object"},"user":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"677d5f47-a8bf-4090-ba52-680903e7c8b5","format":"uuid","type":"string"},"type":{"description":"Always \"user\"","enum":["user"],"example":"user","type":"string"}},"type":"object"}},"type":"object"}},"required":["role","user","group"],"type":"object"},"type":{"description":"type of membership according to its entity","enum":["group_membership"],"example":"group_membership","type":"string"}},"type":"object"}},"type":"object"},"CreateIndexResponseAttributes":{"example":{"error":"AC_OK","error_message":"","indexing_status":"OK","readiness":"READY"},"properties":{"error":{"type":"string"},"error_message":{"type":"string"},"indexing_status":{"enum":["OK","FAILED","IN_PROGRESS"],"type":"string"},"readiness":{"enum":["ABSENT","READY"],"type":"string"}},"required":["readiness","indexing_status","error"],"type":"object"},"CreateOrgMembershipRequestBody":{"properties":{"data":{"additionalProperties":false,"properties":{"relationships":{"additionalProperties":false,"properties":{"org":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"8aab168e-fb3b-47c0-9d87-442715788b31","format":"uuid","type":"string"},"type":{"description":"Always \"org\"","enum":["org"],"example":"org","type":"string"}},"type":"object"}},"type":"object"},"role":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Always \"org_role\"","enum":["org_role"],"example":"org_role","type":"string"}},"type":"object"}},"type":"object"},"user":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"677d5f47-a8bf-4090-ba52-680903e7c8b5","format":"uuid","type":"string"},"type":{"description":"Always \"user\"","enum":["user"],"example":"user","type":"string"}},"type":"object"}},"type":"object"}},"required":["role","user","org"],"type":"object"},"type":{"description":"type of membership according to its entity","enum":["org_membership"],"example":"org_membership","type":"string"}},"type":"object"}},"type":"object"},"CreatePermissionsAttributes":{"example":{"platform":"aws","type":"cf"},"properties":{"options":{"anyOf":[{"description":"Options for generating an Azure environment permissions script","example":{"subscription_id":"6884d000-8dd4-11ed-a1eb-0242ac120002","tenant_id":"51627f08-8dd4-11ed-a1eb-0242ac120002"},"properties":{"subscription_id":{"description":"ID of the Azure subscription to be scanned","example":"6884d000-8dd4-11ed-a1eb-0242ac120002","type":"string"},"tenant_id":{"description":"Azure Tenant (directory) ID","example":"51627f08-8dd4-11ed-a1eb-0242ac120002","type":"string"}},"required":["tenant_id","subscription_id"],"type":"object"}]},"platform":{"$ref":"#/components/schemas/PlatformType"},"type":{"$ref":"#/components/schemas/PermissionType"}},"required":["type","platform"],"type":"object"},"CreatePolicyRulePayload":{"properties":{"attributes":{"$ref":"#/components/schemas/PolicyRuleAttributes"},"type":{"enum":["policy_rule"],"type":"string"}},"required":["type","attributes"],"type":"object"},"CreateRepoIndexAttributes":{"additionalProperties":false,"example":{"integration_type":"github","project_name":"snyk-fixture/goof","target_id":"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"},"properties":{"integration_type":{"type":"string"},"project_name":{"type":"string"},"target_id":{"format":"uuid","type":"string"}},"required":["project_name","integration_type","target_id"],"type":"object"},"CreateSnippetIndexAttributes":{"additionalProperties":false,"example":{"content":"const pw = 1234","language_name":"javascript"},"properties":{"content":{"type":"string"},"language_name":{"type":"string"}},"required":["language_name","content"],"type":"object"},"CustomBaseImageAttributes":{"additionalProperties":false,"properties":{"include_in_recommendations":{"description":"Whether this image should be recommended as a base image upgrade. \nIf set to true, this image could be shown as a base image upgrade to other projects.\nIf set to false this image will never be recommended as an upgrade.\n","example":true,"type":"boolean"},"project_id":{"description":"The ID of the container project that the custom base image is based off of.\nThe attributes of this custom base image are taken from the latest snapshot at the time of creation.\nThis means that no changes should be made to the original project after the creation of the custom base image,\nas new snapshots created from any changes will NOT be picked up.\n","example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"},"versioning_schema":{"$ref":"#/components/schemas/VersioningSchema"}},"required":["project_id","include_in_recommendations"],"type":"object"},"CustomBaseImageCollectionResponse":{"additionalProperties":false,"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageSnapshot"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi"],"type":"object"},"CustomBaseImagePatchRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"include_in_recommendations":{"example":true,"type":"boolean"},"versioning_schema":{"$ref":"#/components/schemas/VersioningSchema"}},"type":"object"},"id":{"description":"The ID of the custom base image that should be updated. (Same one used in the URI)","format":"uuid","type":"string"},"type":{"description":"This should always be \"custom_base_image\"","example":"custom_base_image","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CustomBaseImagePostRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageAttributes"},"type":{"description":"This should always be \"custom_base_image\"","example":"custom_base_image","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CustomBaseImageResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageAttributes"},"id":{"example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"},"type":{"example":"custom_base_image","type":"string"}},"required":["id","type","attributes"],"type":"object"},"CustomBaseImageResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CustomBaseImageResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi"],"type":"object"},"CustomBaseImageSnapshot":{"properties":{"group_id":{"format":"uuid","type":"string"},"include_in_recommendations":{"type":"boolean"},"org_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"repository":{"type":"string"},"tag":{"type":"string"}},"type":"object"},"CycloneDxComponent":{"properties":{"bom-ref":{"example":"common-util@3.0.0","type":"string","xml":{"attribute":true}},"name":{"example":"acme-lib","type":"string"},"purl":{"example":"pkg:golang/golang.org/x/text@v0.3.7","type":"string"},"type":{"example":"library","type":"string","xml":{"attribute":true}},"version":{"example":"1.0.0","type":"string"}},"type":"object","xml":{"name":"component"}},"CycloneDxDependency":{"properties":{"dependsOn":{"example":["web-framework@1.0.0","persistence@3.1.0"],"items":{"type":"string"},"type":"array","xml":{"name":"dependency"}},"ref":{"example":"common-util@3.0.0","type":"string","xml":{"attribute":true}}},"type":"object","xml":{"name":"dependency"}},"CycloneDxDocument":{"properties":{"bomFormat":{"enum":["CycloneDX"],"example":"CycloneDX","type":"string"},"components":{"description":"A list of included software components","items":{"$ref":"#/components/schemas/CycloneDxComponent"},"type":"array"},"dependencies":{"items":{"$ref":"#/components/schemas/CycloneDxDependency"},"type":"array"},"metadata":{"$ref":"#/components/schemas/CycloneDxMetadata"},"specVersion":{"example":"1.4","type":"string"},"version":{"example":1,"type":"integer"}},"required":["bomFormat","specVersion","version","metadata","dependencies"],"type":"object"},"CycloneDxMetadata":{"properties":{"component":{"$ref":"#/components/schemas/CycloneDxComponent"},"properties":{"items":{"$ref":"#/components/schemas/CycloneDxProperty"},"type":"array","xml":{"wrapped":true}},"timestamp":{"example":"2021-02-09T20:40:32Z","type":"string"},"tools":{"items":{"$ref":"#/components/schemas/CycloneDxTool"},"type":"array","xml":{"wrapped":true}}},"type":"object"},"CycloneDxProperty":{"properties":{"name":{"example":"snyk:org_id","type":"string","xml":{"attribute":true}},"value":{"example":"f1bb66d1-a94e-4574-aea1-9697d794e04d","type":"string"}},"type":"object","xml":{"name":"property"}},"CycloneDxTool":{"properties":{"name":{"example":"Snyk Open Source","type":"string"},"vendor":{"example":"Snyk","type":"string"}},"type":"object","xml":{"name":"tool"}},"CycloneDxXmlDocument":{"properties":{"components":{"description":"A list of included software components","items":{"$ref":"#/components/schemas/CycloneDxComponent"},"type":"array","xml":{"wrapped":true}},"dependencies":{"items":{"$ref":"#/components/schemas/CycloneDxDependency"},"type":"array","xml":{"wrapped":true}},"metadata":{"$ref":"#/components/schemas/CycloneDxMetadata"}},"required":["metadata","components","dependencies"],"type":"object","xml":{"name":"bom"}},"DeleteProjectsFromCollectionRequest":{"additionalProperties":false,"properties":{"data":{"description":"IDs of items to remove from a collection","items":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"type":{"description":"Type of the item id","enum":["project"],"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["data"],"type":"object"},"DepGraphAttributes":{"example":{"component_details":{"snyk.io":{"artifact":"AWSSDKCPP-S3","author":"Amazon Web Services","file_paths":["aws-sdk-cpp-1.3.50/aws-cpp-sdk-s3/include/aws/s3/S3Client.h","aws-sdk-cpp-1.3.50/aws-cpp-sdk-s3/include/aws/s3/S3Endpoint.h"],"id":"67aa3b08f493e26d7464ab0a00000000","path":"aws-sdk-cpp-1.3.50/aws-cpp-sdk-s3/include/aws/s3","score":1,"url":"https://example.org/v3-flatcontainer/awssdkcpp-s3/1.3.20060301.58/awssdkcpp-s3.1.3.20060301.58.nupkg","version":"1.3.20060301.58"}},"dep_graph_data":{"graph":{"nodes":[{"deps":[{"node_id":"https://example.org|cpio@2.12"}],"node_id":"root-node","pkg_id":"root-node@0.0.0"}],"root_node_id":"root-node"},"pkg_manager":{"name":"cpp"},"pkgs":[{"id":"root-node@0.0.0","info":{"name":"root-node","version":"0.0.0"}}],"schema_version":"1.2.0"},"in_progress":false,"start_time":1653904564709},"properties":{"component_details":{"additionalProperties":{"properties":{"artifact":{"type":"string"},"author":{"type":"string"},"file_paths":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"path":{"type":"string"},"score":{"type":"number"},"url":{"type":"string"},"version":{"type":"string"}},"required":["artifact","version","author","path","id","url","score","file_paths"],"type":"object"},"type":"object"},"dep_graph_data":{"properties":{"graph":{"properties":{"nodes":{"items":{"properties":{"deps":{"items":{"properties":{"node_id":{"type":"string"}},"required":["node_id"],"type":"object"},"type":"array"},"node_id":{"type":"string"},"pkg_id":{"type":"string"}},"required":["node_id","pkg_id","deps"],"type":"object"},"type":"array"},"root_node_id":{"type":"string"}},"required":["root_node_id","nodes"],"type":"object"},"pkg_manager":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"pkgs":{"items":{"properties":{"id":{"type":"string"},"info":{"properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"type":"object"}},"required":["id","info"],"type":"object"},"type":"array"},"schema_version":{"type":"string"}},"required":["schema_version","pkg_manager","pkgs","graph"],"type":"object"},"in_progress":{"type":"boolean"},"start_time":{"type":"number"}},"required":["in_progress"],"type":"object"},"DepGraphResponse":{"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/DepGraphAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"properties":{"self":{"type":"string"}},"type":"object"}},"type":"object"},"Dependency":{"properties":{"package_name":{"description":"The package name the issue was found in","maxLength":2048,"minLength":1,"type":"string"},"package_version":{"description":"The package version the issue was found in","maxLength":2048,"minLength":1,"type":"string"}},"required":["package_name","package_version"],"type":"object"},"DeployedRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"DeploymentCredentialAttributes":{"additionalProperties":false,"properties":{"comment":{"description":"Optional comment information","type":"string"},"deployment_id":{"description":"Associated Deployment ID","format":"uuid","readOnly":true,"type":"string"},"environment_variable_name":{"type":"string"},"type":{"description":"Associated connection type","type":"string"}},"required":["deployment_id","environment_variable_name","type"],"type":"object"},"DeploymentCredentialResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/DeploymentCredentialAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"relationships":{"$ref":"#/components/schemas/ConnectionRelationships"},"type":{"enum":["deployment_credential"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"DeploymentCredentialsAttributes":{"items":{"$ref":"#/components/schemas/DeploymentCredentialAttributes"},"maxItems":10,"type":"array"},"DigitalOceanCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","cr_agent_url","cr_base","cr_token"],"type":"object"},"type":{"enum":["digitalocean-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"DockerHubAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["docker-hub"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"EcrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_external_id":{"type":"string"},"cr_region":{"type":"string"},"cr_role_arn":{"type":"string"}},"required":["broker_client_url","cr_agent_url","cr_base","cr_role_arn","cr_region","cr_external_id"],"type":"object"},"type":{"enum":["ecr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"EducationResource":{"properties":{"attributes":{"properties":{"author":{"type":"string"},"date_published":{"format":"date","type":"string"},"description":{"type":"string"},"education_content_category":{"enum":["security education","product training"],"type":"string"},"image":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"url":{"type":"string"}},"required":["name","description","url","slug","image","education_content_category","tags"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["lesson","learning_path"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"Environment":{"properties":{"id":{"description":"Internal ID for an environment.","format":"uuid","type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this environment. For example, a cloud account id.","maxLength":2048,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"EnvironmentAttributes":{"description":"Environment attributes","example":{"created_at":"2022-05-06T12:25:15-04:00","kind":"aws","name":"Demo AWS Environment","native_id":"12345678910","options":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"},"properties":{"account_id":"123456789012"},"revision":1,"status":"success","updated_at":"2022-05-06T12:25:15-04:00"},"properties":{"created_at":{"description":"When the environment was created","example":"2022-05-06T12:25:15-04:00","format":"date-time","type":"string"},"deleted_at":{"format":"date-time","nullable":true,"type":"string"},"kind":{"$ref":"#/components/schemas/EnvironmentKind"},"name":{"$ref":"#/components/schemas/EnvironmentName"},"options":{"type":"object"},"properties":{"type":"object"},"revision":{"description":"Increment for each change to an environment","example":1,"type":"integer"},"updated_at":{"description":"When the environment was last updated","example":"2022-05-07T12:25:15-04:00","format":"date-time","nullable":true,"type":"string"}},"required":["kind","name","created_at"],"type":"object"},"EnvironmentCreateAttributes":{"example":{"kind":"aws","options":{"role_arn":"arn:aws:iam::336447867772:role/SnykCloud1234"}},"properties":{"kind":{"$ref":"#/components/schemas/EnvironmentKind"},"name":{"$ref":"#/components/schemas/EnvironmentName"},"options":{"$ref":"#/components/schemas/EnvironmentOptions"}},"required":["kind","options"],"type":"object"},"EnvironmentKind":{"description":"Environment kind: aws","enum":["aws","google","azure","scm","tfc","cli"],"type":"string"},"EnvironmentName":{"description":"Environment name","example":"Demo AWS Environment","type":"string"},"EnvironmentOptions":{"oneOf":[{"$ref":"#/components/schemas/AwsOptions"},{"$ref":"#/components/schemas/GoogleOptions"},{"$ref":"#/components/schemas/AzureOptions"}]},"EnvironmentRelationships":{"additionalProperties":true,"description":"Environment relationships","example":{"organization":{"data":{"id":"00000000-0000-0000-0000-000000000000","type":"organization"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"project":{"data":{"id":"11111111-1111-11111-1111-111111111111","type":"project"}}},"type":"object"},"EnvironmentType":{"example":"environment","type":"string"},"EnvironmentTypeDef":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"},"EnvironmentUpdateAttributes":{"description":"Environment update attributes. Only the AWS role ARN can be updated; new ARN must have the same account ID as the old ARN.","example":{"options":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"}},"properties":{"name":{"$ref":"#/components/schemas/EnvironmentName"},"options":{"$ref":"#/components/schemas/EnvironmentOptions"}},"required":["options"],"type":"object"},"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":{"$ref":"#/components/schemas/ErrorLink"},"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"},"ErrorDocument":{"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":{"$ref":"#/components/schemas/Error"},"minItems":1,"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","errors"],"type":"object"},"ErrorLink":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"EventBridgeConfigRequest":{"description":"A registration config specific to AWS Event Bridge.","properties":{"account_id":{"example":"123456789012","type":"string"},"event_type":{"enum":["audit_logs","issues"],"type":"string"},"region":{"description":"The region where AWS Event Bridge events will be sent.","example":"us-east-1","type":"string"}},"required":["account_id","region","event_type"],"type":"object"},"EventBridgeConfigResponse":{"allOf":[{"$ref":"#/components/schemas/EventBridgeConfigRequest"},{"properties":{"event_source_arn":{"type":"string"},"event_source_name":{"type":"string"}},"required":["event_source_arn","event_source_name"],"type":"object"}]},"ExploitDetails":{"description":"Details about the exploits","properties":{"maturity_levels":{"description":"List of maturity levels","items":{"$ref":"#/components/schemas/MaturityLevel"},"type":"array"},"sources":{"description":"Sources for determining exploit maturity level, e.g., CISA, ExploitDB, Snyk.","items":{"type":"string"},"type":"array"}},"type":"object"},"FilePosition":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"Flow":{"discriminator":{"propertyName":"name"},"oneOf":[{"$ref":"#/components/schemas/MonitorFlow"},{"$ref":"#/components/schemas/CliTestFlow"},{"$ref":"#/components/schemas/IdeTestFlow"},{"$ref":"#/components/schemas/PrCheckFlow"},{"$ref":"#/components/schemas/RecurringTestFlow"},{"$ref":"#/components/schemas/IdeDiffTestFlow"},{"$ref":"#/components/schemas/ApiTestFlow"},{"$ref":"#/components/schemas/ApiMonitorFlow"},{"$ref":"#/components/schemas/SbomMonitorFlow"}]},"GcrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["gcr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GenericConfigurationAttributes":{"properties":{"configuration":{"properties":{"required":{"additionalProperties":{"type":"string"},"type":"object"},"type":{"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"}},"required":["configuration"],"type":"object"},"GetBrokerConnectionIntegrationResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/OrgIntegrationResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerConnectionIntegrationsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgIntegrationResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerConnectionResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerConnectionResponseResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerDeploymentResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerDeploymentResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetDeploymentCredentialResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/DeploymentCredentialResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetProjectSettingsCollection":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectSettingsData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"},"GetProjectsOfCollectionResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectOfCollection"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"},"GetProjectsSetting":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectSetting"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"},"GetRecommendedVersionsRequest":{"properties":{"data":{"properties":{"packages":{"additionalProperties":{"type":"string"},"type":"object"},"policies":{"properties":{"allow_major_upgrades":{"type":"boolean"},"min_age_of_package":{"minimum":0,"type":"number"}},"required":["allow_major_upgrades","min_age_of_package"],"type":"object"},"type":{"enum":["npm","yarn","maven"],"type":"string"}},"required":["type","policies","packages"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data"],"type":"object"},"GitHubAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","github_token"],"type":"object"},"type":{"enum":["github"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitHubCloudAppAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github":{"example":"ghe.yourdomain.com","type":"string"},"github_api":{"example":"api.ghe.yourdomain.com","type":"string"},"github_app_client_id":{"example":"\u003capp-client-id\u003e","type":"string"},"github_app_id":{"example":"\u003capp-id\u003e","type":"string"},"github_app_installation_id":{"example":"\u003capp-installation-id\u003e","type":"string"},"github_app_private_pem_path":{"example":"\u003cpath-to-private-pem-file\u003e","type":"string"}},"required":["broker_client_url","github","github_api","github_app_client_id","github_app_id","github_app_installation_id","github_app_private_pem_path"],"type":"object"},"type":{"enum":["github-cloud-app"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitHubEnterpriseAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github":{"example":"ghe.yourdomain.com","type":"string"},"github_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","github","github_token"],"type":"object"},"type":{"enum":["github-enterprise"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitHubServerAppAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github":{"example":"ghe.yourdomain.com","type":"string"},"github_api":{"example":"api.ghe.yourdomain.com","type":"string"},"github_app_client_id":{"example":"\u003capp-client-id\u003e","type":"string"},"github_app_id":{"example":"\u003capp-id\u003e","type":"string"},"github_app_installation_id":{"example":"\u003capp-installation-id\u003e","type":"string"},"github_app_private_pem_path":{"example":"\u003cpath-to-private-pem-file\u003e","type":"string"}},"required":["broker_client_url","github","github_api","github_app_client_id","github_app_id","github_app_installation_id","github_app_private_pem_path"],"type":"object"},"type":{"enum":["github-server-app"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitLabAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"gitlab":{"example":"gitlab.yourdomain.com","type":"string"},"gitlab_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","gitlab","gitlab_token"],"type":"object"},"type":{"enum":["gitlab"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GithubCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["github-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitlabCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["gitlab-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GoogleArtifactCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["google-artifact-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GoogleOptions":{"additionalProperties":false,"description":"Options for creating a Google environment","example":{"identity_provider":"https://iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/snyk-workload-identity-123/providers/snyk-identity-provider-123","project_id":"demo-project","service_account_email":"snyk-demo@demo-project.iam.gserviceaccount.com"},"properties":{"identity_provider":{"description":"The full resource name of the workload identity provider","example":"https://iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/snyk-workload-identity-123/providers/snyk-identity-provider-123","format":"uri","type":"string"},"project_id":{"description":"Google project ID","example":"demo-project","type":"string"},"service_account_email":{"description":"Google service account email","example":"snyk-demo@demo-project.iam.gserviceaccount.com","format":"email","type":"string"}},"required":["service_account_email","identity_provider"],"type":"object"},"GrantType":{"description":"An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token. The grant type represents the way your app will get the access token.","enum":["authorization_code","client_credentials"],"type":"string"},"GrantType20220311":{"description":"An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token.","enum":["authorization_code","client_credentials"],"type":"string"},"Group":{"additionalProperties":true,"properties":{"attributes":{"$ref":"#/components/schemas/GroupAttributes"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"group","type":"string"}},"required":["type","id","attributes"],"type":"object"},"GroupAttributes":{"additionalProperties":true,"properties":{"name":{"description":"The name of the group.","example":"My Group","type":"string"}},"required":["name"],"type":"object"},"GroupIacSettingsRequest":{"description":"The Infrastructure as Code settings for a group.","properties":{"attributes":{"properties":{"custom_rules":{"additionalProperties":false,"description":"The Infrastructure as Code custom rules settings for a group.","minProperties":1,"properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"}},"type":"object"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"required":["type","attributes"],"type":"object"},"GroupIacSettingsResponse":{"description":"The Infrastructure as Code settings for a group.","properties":{"attributes":{"properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for a group.","properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"},"id":{"description":"ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"type":"object"},"GroupId":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"GroupMembership":{"additionalProperties":false,"properties":{"attributes":{"properties":{"created_at":{"description":"The date that the group membership was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time"}},"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/GroupMembershipRelationships"},"type":{"description":"Content type.","example":"group_membership","type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"},"GroupMembershipAttributes":{"additionalProperties":false,"properties":{"created_at":{"description":"The time when this group membership was created","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"GroupMembershipGroupData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the group","example":"Example group","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"group","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipMeta":{"additionalProperties":false,"properties":{"group_membership_count":{"type":"number"}},"type":"object"},"GroupMembershipOrgMembership":{"additionalProperties":false,"properties":{"attributes":{"properties":{"created_at":{"description":"The date that the org membership was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time"}},"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"org_membership_count":{"description":"Org memberships for this user within this group.","type":"number"},"relationships":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipRelationships"},"type":{"description":"Content type.","example":"org_membership","type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"},"GroupMembershipOrgMembershipOrgData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the prg","example":"Example org","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipOrgMembershipRelationships":{"additionalProperties":false,"properties":{"org":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipOrgData"},"role":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipRoleData"},"user":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipUserData"}},"required":["role","org","user"],"type":"object"},"GroupMembershipOrgMembershipRoleData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the role","example":"Admin role","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org_role","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipOrgMembershipUserData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"email":{"description":"The eamil of the user","example":"user@test.com","type":"string"},"name":{"description":"The name of the user","example":"User2","type":"string"},"username":{"description":"The username of the user","example":"User name 2","type":"string"}},"required":["name","username","email"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"user","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipRelationships":{"additionalProperties":false,"properties":{"group":{"$ref":"#/components/schemas/GroupMembershipGroupData"},"role":{"$ref":"#/components/schemas/GroupMembershipRoleData"},"user":{"$ref":"#/components/schemas/GroupMembershipUserData"}},"required":["role","group","user"],"type":"object"},"GroupMembershipResponseData":{"additionalProperties":false,"items":{"properties":{"attributes":{"$ref":"#/components/schemas/GroupMembershipAttributes"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/GroupMembershipMeta"},"relationships":{"$ref":"#/components/schemas/GroupMembershipRelationships"},"type":{"description":"Content type","example":"group_membership","type":"string"}},"type":"object"},"type":"array"},"GroupMembershipRoleData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the role","example":"Admin role","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"group_role","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipUserData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"email":{"description":"The email of the user","example":"user@test.com","type":"string"},"login_method":{"description":"The login method of the user","type":"string"},"name":{"description":"The name of the user","example":"User2","type":"string"},"username":{"description":"The username of the user","example":"User name 2","type":"string"}},"required":["name","username","email"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"user","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupRegistrationAttributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"},{"$ref":"#/components/schemas/EventBridgeConfigResponse"},{"$ref":"#/components/schemas/SecurityCommandCenterConfigResponse"}]},"created":{"description":"A timestamp indicating the date the registration was created.","type":"string"},"disabled":{"description":"A flag indicating whether the registration is disabled.","type":"boolean"},"disabled_reason":{"description":"A reason for the registration being disabled, if applicable.","type":"string"},"group_id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"last_disabled":{"description":"A timestamp of the last time the registration was disabled.","type":"string"},"name":{"description":"A name for users to more easily identify this registration.","type":"string"},"type":{"$ref":"#/components/schemas/GroupRegistrationType"}},"required":["group_id","name","type","config","disabled","disabled_reason","last_disabled","created"],"type":"object"},"GroupRegistrationData":{"description":"A group-level registration.","properties":{"attributes":{"$ref":"#/components/schemas/GroupRegistrationAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"GroupRegistrationType":{"description":"The type of Cloud Events integration represented by a registration.","enum":["aws-cloudtrail","aws-securityhub","aws-eventbridge","google-securitycommandcenter"],"type":"string"},"GroupRelationships":{"properties":{"tenant":{"properties":{"data":{"properties":{"id":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"GroupResponse":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"example":{"name":"My Group"},"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"id":{"$ref":"#/components/schemas/GroupId"},"relationships":{"$ref":"#/components/schemas/GroupRelationships"},"type":{"$ref":"#/components/schemas/GroupType"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi","links"],"type":"object"},"GroupType":{"description":"The type of the resource for group operations","enum":["group"],"type":"string"},"HarborCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["harbor-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"Id":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"IdeDiffTestFlow":{"additionalProperties":false,"properties":{"name":{"description":"The flow which the scan is triggered for.","enum":["ide_diff_test"],"example":"ide_diff_test","type":"string"}},"required":["name"],"type":"object"},"IdeTestFlow":{"additionalProperties":false,"properties":{"name":{"description":"The flow which the scan is triggered for.","enum":["ide_test"],"example":"ide_test","type":"string"}},"required":["name"],"type":"object"},"Ignore":{"additionalProperties":false,"description":"ignore resource object","properties":{"attributes":{"$ref":"#/components/schemas/IgnoreAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"links":{"properties":{"self":{"description":"A URL for the location of the resource","example":"https://example.com/resource/4","format":"uri","type":"string"}},"type":"object"},"relationships":{"$ref":"#/components/schemas/IgnoreRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","attributes","relationships"],"type":"object"},"IgnoreAttributes":{"additionalProperties":false,"example":{"created":"2021-06-01T00:00:00Z","disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","ignore_path":"*","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","updated":"2021-06-01T00:00:00Z","vulnerability_id":"npm:qs:20140806-1"},"properties":{"created":{"description":"The time that the ignore was created.","example":"2021-06-01T00:00:00Z","format":"date-time","type":"string"},"disregard_if_fixable":{"description":"Only ignore the issue if no upgrade or patch is available.","example":false,"type":"boolean"},"expires":{"description":"The time that the issue will no longer be ignored.","example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"ignore_path":{"description":"The path to ignore (default is * which represents all paths).","example":"*","type":"string"},"issue_key":{"description":"Describes the unique issue that the ignore rule applies to.","example":"a7f5e5d9-ded4-4046-9169-5f27d04ac95c","maxLength":2048,"type":"string"},"reason":{"description":"The reason that the issue was ignored.","example":"Not vulnerable via this path","type":"string"},"reason_type":{"description":"The classification of the ignore.","enum":["not-vulnerable","wont-fix","temporary-ignore"],"example":"not-vulnerable","type":"string"},"updated":{"description":"The time that the ignore was last updated.","example":"2021-06-01T00:00:00Z","format":"date-time","type":"string"},"vulnerability_id":{"description":"The Snyk id of the vulnerability the ignore rule applies to","example":"npm:qs:20140806-1","type":"string"}},"required":["vulnerability_id","ignore_path","reason_type","reason","disregard_if_fixable","created","updated"],"type":"object"},"IgnoreCreateAttributes20231220":{"additionalProperties":false,"example":{"disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","ignore_path":"*","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","vulnerability_id":"npm:qs:20140806-1"},"properties":{"disregard_if_fixable":{"description":"Only ignore the issue if no upgrade or patch is available.","example":false,"type":"boolean"},"expires":{"description":"The time that the issue will no longer be ignored.","example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"ignore_path":{"description":"The path to ignore (default is * which represents all paths).","example":"*","type":"string"},"issue_key":{"description":"Describes the unique issue the ignore rule applies to.","example":"a7f5e5d9-ded4-4046-9169-5f27d04ac95c","maxLength":2048,"type":"string"},"reason":{"description":"The reason that the issue was ignored.","example":"Not vulnerable via this path","minLength":1,"type":"string"},"reason_type":{"description":"The classification of the ignore.","enum":["not-vulnerable","wont-fix","temporary-ignore"],"example":"not-vulnerable","type":"string"},"vulnerability_id":{"description":"The Snyk id of the vulnerability the ignore rule applies to","example":"npm:qs:20140806-1","type":"string"}},"required":["vulnerability_id","ignore_path","reason_type","reason","disregard_if_fixable"],"type":"object"},"IgnoreCreateBody":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/IgnoreCreateAttributes20231220"},"relationships":{"$ref":"#/components/schemas/IgnoreCreateRelationships"},"type":{"$ref":"#/components/schemas/IgnoreType"}},"required":["type","attributes","relationships"],"type":"object"}},"required":["data"],"type":"object"},"IgnoreCreateRelationships":{"additionalProperties":false,"example":{"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"properties":{"scan_item":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/ScanItemType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["scan_item"],"type":"object"},"IgnoreRelationships":{"additionalProperties":false,"example":{"ignored_by":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b7e","type":"user"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"properties":{"ignored_by":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/UserType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"organization":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/OrganizationType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"scan_item":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/ScanItemType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["organization","scan_item","ignored_by"],"type":"object"},"IgnoreType":{"enum":["ignore"],"example":"ignore","type":"string"},"IgnoreUpdateAttributes20231220":{"additionalProperties":false,"example":{"disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","ignore_path":"*","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","vulnerability_id":"npm:qs:20140806-1"},"properties":{"disregard_if_fixable":{"description":"Only ignore the issue if no upgrade or patch is available.","example":false,"type":"boolean"},"expires":{"description":"The time that the issue will no longer be ignored.","example":"2021-07-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"ignore_path":{"description":"The path to ignore (default is * which represents all paths).","example":"*","type":"string"},"issue_key":{"description":"Describes the unique issue the ignore rule applies to.","example":"a7f5e5d9-ded4-4046-9169-5f27d04ac95c","maxLength":2048,"type":"string"},"reason":{"description":"The reason that the issue was ignored.","example":"Not vulnerable via this path","minLength":1,"type":"string"},"reason_type":{"description":"The classification of the ignore.","enum":["not-vulnerable","wont-fix","temporary-ignore"],"example":"not-vulnerable","type":"string"},"vulnerability_id":{"description":"The Snyk id of the vulnerability the ignore rule applies to","example":"npm:qs:20140806-1","type":"string"}},"required":["vulnerability_id","ignore_path","reason_type","reason","disregard_if_fixable"],"type":"object"},"IgnoreUpdateBody20231220":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/IgnoreUpdateAttributes20231220"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/IgnoreType"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"Image":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ImageAttributes"},"id":{"$ref":"#/components/schemas/ImageDigest"},"relationships":{"properties":{"image_target_refs":{"properties":{"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}},"type":"object"},"type":{"enum":["container_image"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"ImageAttributes":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/ImageDigest"},"minItems":1,"type":"array"},"names":{"items":{"$ref":"#/components/schemas/ImageName"},"type":"array"},"platform":{"$ref":"#/components/schemas/Platform"}},"required":["platform","layers"],"type":"object"},"ImageDigest":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"},"ImageName":{"example":"gcr.io/snyk/redis:5","pattern":"^((?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?\\/)?[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?(?:(?:\\/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?)(?::([\\w][\\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][A-Fa-f0-9]{32,}))?$","type":"string"},"ImageTargetRef":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ImageTargetRefAttributes"},"id":{"example":"3cd4af4c-fb15-45c4-9acd-8e8fcc6690af","format":"uuid","type":"string"},"type":{"enum":["image_target_reference"],"type":"string"}},"type":"object"},"ImageTargetRefAttributes":{"properties":{"platform":{"$ref":"#/components/schemas/Platform"},"target_id":{"format":"uuid","type":"string"},"target_reference":{"type":"string"}},"type":"object"},"InheritFromParent":{"description":"Which parent to inherit settings from.","enum":["group"],"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"},"IntegrationResource":{"additionalProperties":false,"properties":{"integration_id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"IsActive":{"description":"Current status of the project settings.","example":true,"type":"boolean"},"IsConfidential":{"description":"A boolean to indicate if an app is confidential or not as per the OAuth2 RFC. Confidential apps can securely store secrets. Examples of non-confidential apps are full web-based or CLIs.","example":true,"type":"boolean"},"IsConfidential20220311":{"description":"A boolean to indicate if an app is confidential or not as per the OAuth2 RFC.","example":true,"type":"boolean"},"IsEnabled":{"description":"Whether the custom rules feature is enabled or not.","example":true,"type":"boolean"},"IsPublic":{"description":"A boolean to indicate if an app is publicly available or not.","example":false,"type":"boolean"},"Issue":{"additionalProperties":false,"description":"A Snyk Issue.","properties":{"attributes":{"$ref":"#/components/schemas/IssueAttributes"},"id":{"example":"73832c6c-19ff-4a92-850c-2e1ff2800c16","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/IssueRelationships"},"type":{"enum":["issue"],"example":"issue","type":"string"}},"required":["id","type","attributes","relationships"],"type":"object"},"IssueAttributes":{"additionalProperties":false,"description":"issue attributes","properties":{"classes":{"description":"A list of details for weakness data, policy, etc that are the class of this issue's source.","items":{"$ref":"#/components/schemas/Class"},"maxItems":50,"minItems":1,"type":"array"},"coordinates":{"description":"Where the issue originated, specific to issue type. Details on what\ncode, package, etc introduced the issue. An issue may be caused by\nmore than one coordinate.\n","items":{"properties":{"is_fixable_manually":{"type":"boolean"},"is_fixable_snyk":{"type":"boolean"},"is_fixable_upstream":{"type":"boolean"},"is_patchable":{"type":"boolean"},"is_pinnable":{"type":"boolean"},"is_upgradeable":{"type":"boolean"},"reachability":{"enum":["function","package","no-info","not-applicable"],"type":"string"},"remedies":{"items":{"additionalProperties":false,"properties":{"correlation_id":{"description":"An optional identifier for correlating remedies between coordinates or across issues. They are scoped\nto a single Project and test run. Remedies with the same correlation_id must have the same contents.\n","maxLength":256,"minLength":1,"type":"string"},"description":{"description":"A markdown-formatted optional description of this remedy. Links are not permitted.","maxLength":4096,"minLength":1,"type":"string"},"meta":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.","type":"object"},"schema_version":{"description":"A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n","maxLength":256,"minLength":1,"type":"string"}},"required":["data","schema_version"],"type":"object"},"type":{"enum":["indeterminate","manual","automated","rule_result_message","terraform","cloudformation","cli","kubernetes","arm"],"type":"string"}},"required":["type"],"type":"object"},"maxItems":5,"minItems":1,"type":"array"},"representations":{"description":"A list of precise locations that surface an issue. A coordinate may have multiple representations.\n","items":{"oneOf":[{"description":"An object that contains an opaque identifying string.","properties":{"resourcePath":{"maxLength":2024,"minLength":1,"type":"string"}},"required":["resourcePath"],"type":"object"},{"description":"An object that contains a list of opaque identifying strings.","properties":{"dependency":{"properties":{"package_name":{"description":"The package name the issue was found in","maxLength":2048,"minLength":1,"type":"string"},"package_version":{"description":"The package version the issue was found in","maxLength":2048,"minLength":1,"type":"string"}},"required":["package_name","package_version"],"type":"object"}},"required":["dependency"],"type":"object"},{"description":"A resource location to some service, like a cloud resource.","properties":{"cloud_resource":{"properties":{"environment":{"properties":{"id":{"description":"Internal ID for an environment.","format":"uuid","type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this environment. For example, a cloud account id.","maxLength":2048,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"resource":{"properties":{"iac_mappings_count":{"description":"Amount of IaC resources this resource maps to.","format":"int64","minimum":0,"type":"integer"},"id":{"description":"Internal ID for a resource.","format":"uuid","type":"string"},"input_type":{"enum":["cloud_scan","arm","k8s","tf","tf_hcl","tf_plan","tf_state","cfn"],"type":"string"},"location":{"maxLength":256,"minLength":1,"type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this resource. For example, a cloud resource id.","maxLength":2048,"minLength":1,"type":"string"},"platform":{"maxLength":256,"minLength":1,"type":"string"},"resource_type":{"maxLength":256,"minLength":1,"type":"string"},"tags":{"additionalProperties":{"maxLength":256,"type":"string"},"type":"object"},"type":{"enum":["cloud","iac"],"type":"string"}},"required":["input_type"],"type":"object"}},"required":["environment"],"type":"object"}},"required":["cloud_resource"],"type":"object"},{"description":"A location within a file.","properties":{"sourceLocation":{"properties":{"file":{"description":"A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n","maximum":2048,"minimum":1,"type":"string"},"region":{"properties":{"end":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"start":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"}},"required":["start","end"],"type":"object"}},"required":["file"],"type":"object"}},"required":["sourceLocation"],"type":"object"}]},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"minItems":1,"type":"array"},"created_at":{"description":"The creation time of this issue.","format":"date-time","type":"string"},"description":{"description":"A markdown-formatted optional description of this issue. Links are not permitted.","example":"Affected versions of this package are vulnerable to Prototype Pollution.\nThe utilities function allow modification of the `Object` prototype.\nIf an attacker can control part of the structure passed to this function,\nthey could add or modify an existing property.\n","maxLength":4096,"minLength":1,"type":"string"},"effective_severity_level":{"description":"The computed effective severity of this issue. This is either the highest level from all included severities,\nor an overridden value set via group level policy.\n","enum":["info","low","medium","high","critical"],"type":"string"},"exploit_details":{"additionalProperties":false,"properties":{"maturity_levels":{"items":{"additionalProperties":false,"properties":{"format":{"example":"CVSS_v4","minLength":1,"type":"string"},"level":{"example":"attacked","minLength":1,"type":"string"}},"required":["format","level"],"type":"object"},"type":"array"},"sources":{"example":["CISA"],"items":{"type":"string"},"type":"array"}},"required":["sources","maturity_levels"],"type":"object"},"ignored":{"description":"A flag indicating if the issue is being ignored. Derived from the issue's ignore, which provides more details.","type":"boolean"},"key":{"description":"An opaque key used for uniquely identifying this issue across test runs, within a project.","example":"24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1","maxLength":2048,"type":"string"},"problems":{"description":"A list of details for vulnerability data, policy, etc that are the source of this issue.","items":{"$ref":"#/components/schemas/Problem"},"minItems":1,"type":"array"},"resolution":{"$ref":"#/components/schemas/Resolution"},"risk":{"$ref":"#/components/schemas/Risk"},"severities":{"items":{"$ref":"#/components/schemas/CVSSSource"},"type":"array"},"status":{"description":"The issue's status. Derived from the issue's resolution, which provides more details.","enum":["open","resolved"],"type":"string"},"title":{"description":"A human-readable title for this issue.","example":"Insecure hash function used","maxLength":2048,"minLength":1,"type":"string"},"tool":{"description":"An opaque identifier for corelating across test runs.","example":"snyk://npm-deps","maxLength":1024,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/TypeDef"},"updated_at":{"description":"The time when this issue was last modified.","format":"date-time","type":"string"}},"required":["key","title","type","effective_severity_level","created_at","updated_at","status","ignored"],"type":"object"},"IssueRelationships":{"additionalProperties":false,"description":"issue relationships","example":{"ignore":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5d","type":"ignore"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}},"test_executions":{"data":[{"id":"0086e1bc-7c27-4f2e-9a99-5fe793ba4bef","type":"test-workflow-execution"}]}},"properties":{"ignore":{"description":"An optional reference to an ignore rule that marks this issue as ignored.","properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"string"},"type":{"$ref":"#/components/schemas/IgnoreType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"organization":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/OrganizationType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"scan_item":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/ScanItemType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"test_executions":{"description":"The \"test execution\" that identified this Issues. This ID represents\na grouping of issues, that were identified by some analysis run, to produce\nIssues.\n","properties":{"data":{"description":"List of metadata associated with the test executions that identified this issue","items":{"properties":{"id":{"example":"3344947d-a5c3-4e20-928b-385a5d8792a3","type":"string"},"type":{"$ref":"#/components/schemas/TestExecutionType"}},"required":["type","id"],"type":"object"},"maxItems":25,"type":"array"}},"required":["data"],"type":"object"}},"required":["organization","scan_item"],"type":"object"},"IssueSeverity":{"description":"Severity of an issue","enum":["low","medium","high","critical"],"type":"string"},"IssueSummary":{"description":"Summary description of an issue.","properties":{"attributes":{"$ref":"#/components/schemas/IssueSummaryAttributes"},"id":{"description":"The Issue ID","example":"2bcd80a9-e343-4601-9393-f820d51ab713","format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/Links"},"type":{"description":"Content type","example":"issue-summary","type":"string"}},"required":["type","id","attributes","links"],"type":"object"},"IssueSummaryAttributes":{"properties":{"cwe":{"description":"List of CWEs of the issue","example":["CWE-1"],"items":{"type":"string"},"type":"array"},"ignored":{"description":"Whether the issue has been ignored","example":false,"type":"boolean"},"issueType":{"$ref":"#/components/schemas/IssueType"},"severity":{"$ref":"#/components/schemas/IssueSeverity"},"title":{"description":"The name of the issue","example":"Example Issue","type":"string"}},"required":["issueType","title","severity","ignored","cwe"],"type":"object"},"IssueSummaryAttributesSnakeCase":{"properties":{"cwe":{"description":"List of CWEs of the issue","example":["CWE-1"],"items":{"type":"string"},"type":"array"},"ignored":{"description":"Whether the issue has been ignored","example":false,"type":"boolean"},"issue_type":{"$ref":"#/components/schemas/IssueType"},"severity":{"$ref":"#/components/schemas/IssueSeverity"},"title":{"description":"The name of the issue","example":"Example Issue","type":"string"}},"required":["issue_type","title","severity","ignored","cwe"],"type":"object"},"IssueSummarySnakeCase":{"description":"Summary description of an issue.","properties":{"attributes":{"$ref":"#/components/schemas/IssueSummaryAttributesSnakeCase"},"id":{"description":"The Issue ID","example":"2bcd80a9-e343-4601-9393-f820d51ab713","format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/Links"},"type":{"description":"Content type","example":"issue-summary","type":"string"}},"required":["type","id","attributes","links"],"type":"object"},"IssueType":{"description":"Issue type. Implies the existence of a resource /issues/detail/{issue-type}/{id}.\n","enum":["code"],"type":"string"},"IssuesMeta":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta"}},"type":"object"},"IssuesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModelVThree"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"$ref":"#/components/schemas/IssuesMeta"}},"type":"object"},"IssuesWithPurlsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModelVThree"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}},"type":"object"}},"type":"object"},"Jira":{"properties":{"jira_hostname":{"example":"jira.yourdomain.com","type":"string"},"jira_password":{"format":"uuid","type":"string"},"jira_username":{"example":"\u003cjira-username\u003e","type":"string"}},"required":["jira_hostname","jira_password","jira_username"],"type":"object"},"JiraAttributes":{"properties":{"required":{"oneOf":[{"$ref":"#/components/schemas/Jira"},{"$ref":"#/components/schemas/JiraBearerAuth"}]},"type":{"enum":["jira"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"JiraBearerAuth":{"properties":{"jira_hostname":{"example":"jira.yourdomain.com","type":"string"},"jira_pat":{"format":"uuid","type":"string"}},"required":["jira_hostname","jira_pat"],"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"},"LatestDependencyTotal":{"additionalProperties":false,"properties":{"total":{"type":"number"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"LatestIssueCounts":{"additionalProperties":false,"properties":{"critical":{"type":"number"},"high":{"type":"number"},"low":{"type":"number"},"medium":{"type":"number"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"LegacyFlowProperties":{"additionalProperties":false,"properties":{"import_id":{"example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"imported_target_id":{"example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"target_reference":{"example":"main","type":"string"},"workspace_url":{"example":"https://example.com","format":"uri","type":"string"}},"required":["imported_target_id","import_id"],"type":"object"},"LicenseAttributes":{"additionalProperties":false,"properties":{"configuration":{"additionalProperties":{"additionalProperties":false,"properties":{"instructions":{"type":"string"},"severity":{"enum":["none","low","medium","high"],"type":"string"}},"required":["severity"],"type":"object"},"description":"A map of license names to their severity and optional instructions.\n","type":"object"},"default":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"orgs":{"items":{"format":"uuid","type":"string"},"type":"array"},"policy_type":{"enum":["license"],"type":"string"},"project_attributes":{"additionalProperties":false,"properties":{"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"}},"required":["business_criticality","lifecycle","environment"],"type":"object"}},"required":["name","default","policy_type","configuration"],"type":"object"},"LicenseAttributesUpdate":{"additionalProperties":false,"properties":{"configuration":{"additionalProperties":{"additionalProperties":false,"description":"A map of license names to their severity and optional instructions.\n","properties":{"instructions":{"type":"string"},"severity":{"enum":["none","low","medium","high"],"type":"string"}},"required":["severity"],"type":"object"},"type":"object"},"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"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":{"$ref":"#/components/schemas/Meta"}},"required":["href"],"type":"object"}]},"Links":{"additionalProperties":false,"properties":{"first":{"$ref":"#/components/schemas/LinkProperty"},"last":{"$ref":"#/components/schemas/LinkProperty"},"next":{"$ref":"#/components/schemas/LinkProperty"},"prev":{"$ref":"#/components/schemas/LinkProperty"},"related":{"$ref":"#/components/schemas/LinkProperty"},"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"ListBrokerConnectionsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/BrokerConnectionResponseResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"ListBrokerDeploymentsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/BrokerDeploymentResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"ListDeploymentCredentialsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/DeploymentCredentialResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"LoadedPackageRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"ManualRemediationPRsSettings":{"additionalProperties":false,"description":"Manually raise pull requests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration.","properties":{"is_patch_remediation_enabled":{"description":"Include vulnerability patches in manual pull requests.","example":true,"type":"boolean"}},"type":"object"},"ManualRemediationPRsSettings20240531":{"additionalProperties":false,"description":"Manually raise pull requests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.","properties":{"is_patch_remediation_enabled":{"description":"Include vulnerability patches in manual pull requests.","example":true,"type":"boolean"}},"type":"object"},"MatchLocation":{"example":{"col_begin":6,"col_end":17,"line_begin":1,"line_end":1},"properties":{"col_begin":{"type":"integer"},"col_end":{"type":"integer"},"line_begin":{"type":"integer"},"line_end":{"type":"integer"}},"required":["line_begin","line_end","col_begin","col_end"],"type":"object"},"MatchesResponseAttributes":{"example":[{"file_name":"file.py","location":[{"col_begin":6,"col_end":17,"line_begin":1,"line_end":1}],"source_code":"pw = \"sensitive\""}],"items":{"$ref":"#/components/schemas/CodeMatch"},"type":"array"},"MaturityLevel":{"description":"Details about the maturity level","properties":{"format":{"description":"The standard by which the “maturity” value is shown.","example":"CVSSv4","type":"string"},"level":{"description":"Exploit maturity of the vulnerability. For CVSSv3: Proof of Concept, Functional, High. For CVSSv4: Unreported, Proof of Concept, Attacked.","example":"Attacked","type":"string"},"type":{"description":"Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.","example":"primary","type":"string"}},"type":"object"},"MemberRoleRelationship":{"additionalProperties":false,"nullable":true,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgRoleAttributes"},"id":{"description":"The Snyk ID of the organization role.","example":"f60ff965-6889-4db2-8c86-0285d62f35ab","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"MembershipPatchRequestBody":{"properties":{"attributes":{"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"role":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Always \"group_role\"","example":"Always \"group_role\"","type":"string"}},"type":"object"}},"type":"object"}},"required":["role"],"type":"object"},"type":{"description":"type of membership according to its entity","example":"group_membership","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"},"MonitorFlow":{"additionalProperties":false,"properties":{"legacy_properties":{"$ref":"#/components/schemas/LegacyFlowProperties"},"name":{"description":"The flow which the scan is triggered for.","enum":["monitor"],"example":"monitor","type":"string"}},"required":["name"],"type":"object"},"MoveAttributes":{"additionalProperties":false,"properties":{"created":{"description":"The time at which the move was initiated","format":"date-time","type":"string"},"errors":{"description":"A description of why the move failed. null if the move has not failed","nullable":true,"type":"string"},"from_group_id":{"$ref":"#/components/schemas/NonNullableId"},"modified":{"description":"The time at which the move record was last updated","format":"date-time","type":"string"},"org_id":{"$ref":"#/components/schemas/NonNullableId"},"status":{"description":"status of the move operation","enum":["pending","progressing","succeeded","failed"],"type":"string"},"to_group_id":{"$ref":"#/components/schemas/NonNullableId"},"user_id":{"$ref":"#/components/schemas/NonNullableId"}},"required":["org_id","from_group_id","to_group_id","user_id","status","errors","created","modified"],"type":"object"},"MoveOrgRequestData":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"parent_group_id":{"$ref":"#/components/schemas/NonNullableId"}},"required":["parent_group_id"],"type":"object"},"type":{"$ref":"#/components/schemas/MoveType"}},"required":["type","attributes"],"type":"object"},"MoveRelationships":{"description":"The relationships for the move resource","type":"object"},"MoveType":{"description":"The type of the resource for move operations","enum":["org_move"],"type":"string"},"Name":{"description":"The name of the package. Note namespace is a separate property.","example":"logging","type":"string"},"Namespace":{"description":"Some name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization","example":"org.example","nullable":true,"type":"string"},"NexusAttributes":{"properties":{"required":{"properties":{"base_nexus_url":{"format":"uuid","type":"string"}},"required":["base_nexus_url"],"type":"object"},"type":{"enum":["nexus"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"NexusCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["nexus-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"NonNullableId":{"format":"uuid","type":"string"},"NugetBuildArgs":{"additionalProperties":false,"properties":{"target_framework":{"type":"string"}},"required":["target_framework"],"type":"object"},"NullableId":{"format":"uuid","nullable":true,"type":"string"},"OSConditionRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"OciRegistryTag":{"description":"The tag for an OCI artifact inside an OCI registry.","example":"latest","type":"string"},"OciRegistryUrl":{"description":"The URL to an OCI registry.","example":"https://registry-1.docker.io/account/bundle","type":"string"},"Org":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"group_id":{"description":"The ID of a Group.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"is_personal":{"description":"Whether this organization belongs to an individual, rather than a Group.","example":true,"type":"boolean"},"name":{"description":"Friendly name of the organization.","example":"My Org","type":"string"},"slug":{"description":"Unique URL sanitized name of the organization for accessing it in Snyk.","example":"my-org","type":"string"}},"required":["name","slug","is_personal"],"type":"object"},"id":{"description":"The Snyk ID corresponding to this org","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"org","type":"string"}},"required":["type","id"],"type":"object"},"Org20230529":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes20230529"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"OrgAttributes":{"additionalProperties":false,"properties":{"access_requests_enabled":{"description":"Whether the organization permits access requests from users who are not members of the organization.","example":false,"type":"boolean"},"created_at":{"description":"The time the organization was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"group_id":{"description":"The Snyk ID of the group to which the organization belongs.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"is_personal":{"description":"Whether the organization is independent (that is, not part of a group).","example":true,"type":"boolean"},"name":{"description":"The display name of the organization.","example":"My Org","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the organization.","example":"my-org","type":"string"},"updated_at":{"description":"The time the organization was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","is_personal"],"type":"object"},"OrgAttributes20230529":{"additionalProperties":false,"properties":{"created_at":{"description":"The time the organization was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"group_id":{"description":"The Snyk ID of the group to which the organization belongs.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"is_personal":{"description":"Whether the organization is independent (that is, not part of a group).","example":true,"type":"boolean"},"name":{"description":"The display name of the organization.","example":"My Org","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the organization.","example":"my-org","type":"string"},"updated_at":{"description":"The time the organization was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","is_personal"],"type":"object"},"OrgIacSettingsRequest":{"description":"The Infrastructure as Code settings for an org.","properties":{"attributes":{"properties":{"custom_rules":{"additionalProperties":false,"description":"The Infrastructure as Code custom rules settings for an org.","minProperties":1,"properties":{"inherit_from_parent":{"$ref":"#/components/schemas/InheritFromParent"},"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"}},"type":"object"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"required":["type","attributes"],"type":"object"},"OrgIacSettingsResponse":{"description":"The Infrastructure as Code settings for an org.","properties":{"attributes":{"properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for an org.","properties":{"inherit_from_parent":{"$ref":"#/components/schemas/InheritFromParent"},"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"},"parents":{"description":"Contains all parents the org can inherit settings from.","properties":{"group":{"description":"The Infrastructure as Code settings at the group level.","properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for a group.","properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"}},"type":"object"},"id":{"description":"ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"type":"object"},"OrgIntegrationResource":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"integration_type":{"type":"string"},"org_id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"OrgInvitation":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitation20230828":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes20230428"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitation20240621":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes20230828"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitationAttributes":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role assigned to the invitee on acceptance.","example":"Developer","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationAttributes20230428":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationAttributes20230828":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationPostAttributes":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid"}},"required":["email","role"],"type":"object"},"OrgInvitationPostData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationPostAttributes"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","attributes"],"type":"object"},"OrgInvitationPostData20230428":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationPostAttributes"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","attributes"],"type":"object"},"OrgMembership":{"additionalProperties":false,"properties":{"attributes":{"properties":{"created_at":{"description":"The date that the org membership was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time"}},"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgMembershipRelationships"},"type":{"description":"Content type.","example":"org_membership","type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"},"OrgMembershipAttributes":{"additionalProperties":false,"properties":{"created_at":{"description":"The time when this Org membership was created","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"OrgMembershipOrgData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the organization","example":"Example org","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"OrgMembershipRelationships":{"additionalProperties":false,"properties":{"org":{"$ref":"#/components/schemas/OrgMembershipOrgData"},"role":{"$ref":"#/components/schemas/OrgMembershipRoleData"},"user":{"$ref":"#/components/schemas/OrgMembershipUserData"}},"required":["role","org","user"],"type":"object"},"OrgMembershipResponseData":{"additionalProperties":false,"items":{"properties":{"attributes":{"$ref":"#/components/schemas/OrgMembershipAttributes"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgMembershipRelationships"},"type":{"description":"Content type","example":"org_memberships","type":"string"}},"type":"object"},"type":"array"},"OrgMembershipRoleData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the role","example":"Admin role","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org_role","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"OrgMembershipUserData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"email":{"description":"The email of the user","example":"user@test.com","type":"string"},"login_method":{"description":"The login method of the user","type":"string"},"name":{"description":"The name of the user","example":"User2","type":"string"},"username":{"description":"The username of the user","example":"User name 2","type":"string"}},"required":["name","username","email"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"user","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"OrgRegistrationAttributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"},{"$ref":"#/components/schemas/EventBridgeConfigResponse"}]},"created":{"description":"A timestamp indicating the date the registration was created.","type":"string"},"disabled":{"description":"A flag indicating whether the registration is disabled.","type":"boolean"},"disabled_reason":{"description":"A reason for the registration being disabled, if applicable.","type":"string"},"last_disabled":{"description":"A timestamp of the last time the registration was disabled.","type":"string"},"name":{"description":"A name for users to more easily identify this registration.","type":"string"},"org_id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/RegistrationType"}},"required":["org_id","name","type","config","disabled","disabled_reason","last_disabled","created"],"type":"object"},"OrgRegistrationData":{"description":"An org-level registration.","properties":{"attributes":{"$ref":"#/components/schemas/OrgRegistrationAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"OrgRelationships":{"additionalProperties":false,"properties":{"member_role":{"$ref":"#/components/schemas/MemberRoleRelationship"}},"type":"object"},"OrgRoleAttributes":{"properties":{"name":{"description":"The display name of the organization role.","example":"Collaborator","type":"string"}},"type":"object"},"OrgUpdateAttributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the organization.","example":"My Org","maxLength":60,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"OrgWithRelationships":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"OrgWithRelationships20230529":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes20230529"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"OrganizationType":{"enum":["organization"],"example":"organization","type":"string"},"Package":{"properties":{"name":{"description":"The package’s name","example":"spring-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"org.springframework","type":"string"},"type":{"description":"The package type or protocol","example":"maven","type":"string"},"url":{"description":"The purl of the package","example":"pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0","type":"string"},"version":{"description":"The version of the package","example":"1.0.0","type":"string"}},"required":["name","type","url","version"],"type":"object"},"PackageAttributes":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/PackageUrl"},"name":{"$ref":"#/components/schemas/Name"},"namespace":{"$ref":"#/components/schemas/Namespace"},"published_date":{"$ref":"#/components/schemas/PublishedDate"},"type":{"description":"The package \"type\" or package \"protocol\" such as maven, npm, nuget, gem, pypi, etc.","example":"maven","type":"string"},"version":{"$ref":"#/components/schemas/Version"}},"required":["id","name","version","type"],"type":"object"},"PackageMeta":{"properties":{"name":{"description":"The package’s name","example":"spring-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"org.springframework","type":"string"},"type":{"description":"The package type or protocol","example":"maven","type":"string"},"url":{"description":"The purl of the package","example":"pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0","type":"string"},"version":{"description":"The version of the package","example":"1.0.0","type":"string"}},"type":"object"},"PackageName":{"description":"The name of the package. Note namespace is a separate property.","example":"logging","type":"string"},"PackageNamespace":{"description":"Some name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization","example":"org.example","type":"string"},"PackagePublishedDate":{"description":"The date the package was published in YYYY-MM-DDTHH:mm:ssZ format. For example midnight on the 1st July 2021 would be written 2021-07-01T00:00:00Z.","example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"PackageRepresentation":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta"}},"type":"object"},"PackageType":{"description":"The package \"type\" or package \"protocol\" such as maven, npm, nuget, gem, pypi, etc.","example":"maven","type":"string"},"PackageUrl":{"description":"A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required.","example":"pkg:maven/com.fasterxml.jackson.core/jackson-core@2.12.3","format":"uri","type":"string"},"PackageVersion":{"description":"The version of the package","example":"1.2.3","type":"string"},"PaginatedLinks":{"additionalProperties":false,"example":{"first":"https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K","last":"https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K","next":"https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"},"properties":{"first":{"$ref":"#/components/schemas/LinkProperty"},"last":{"$ref":"#/components/schemas/LinkProperty"},"next":{"$ref":"#/components/schemas/LinkProperty"},"prev":{"$ref":"#/components/schemas/LinkProperty"},"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"PatchProjectRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"test_frequency":{"description":"Test frequency of a project. Also controls when automated PRs may be created.","enum":["daily","weekly","never"],"example":"daily","type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"properties":{"owner":{"properties":{"data":{"properties":{"id":{"description":"The public ID of the user that owns the project","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","nullable":true,"type":"string"},"type":{"enum":["user"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"type":"object"},"type":{"description":"The Resource type.","enum":["project"],"type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"}},"required":["data"],"type":"object"},"PermissionType":{"enum":["cf","tf","bash"],"type":"string"},"PermissionsAttributes":{"properties":{"data":{"type":"string"},"type":{"$ref":"#/components/schemas/PermissionType"}},"required":["data","type"],"type":"object"},"Platform":{"enum":["aix/ppc64","android/386","android/amd64","android/arm","android/arm/v5","android/arm/v6","android/arm/v7","android/arm64","android/arm64/v8","darwin/amd64","darwin/arm","darwin/arm/v5","darwin/arm/v6","darwin/arm/v7","darwin/arm64","darwin/arm64/v8","dragonfly/amd64","freebsd/386","freebsd/amd64","freebsd/arm","freebsd/arm/v5","freebsd/arm/v6","freebsd/arm/v7","illumos/amd64","ios/arm64","ios/arm64/v8","js/wasm","linux/386","linux/amd64","linux/arm","linux/arm/v5","linux/arm/v6","linux/arm/v7","linux/arm64","linux/arm64/v8","linux/loong64","linux/mips","linux/mipsle","linux/mips64","linux/mips64le","linux/ppc64","linux/ppc64le","linux/riscv64","linux/s390x","linux/x86_64","netbsd/386","netbsd/amd64","netbsd/arm","netbsd/arm/v5","netbsd/arm/v6","netbsd/arm/v7","openbsd/386","openbsd/amd64","openbsd/arm","openbsd/arm/v5","openbsd/arm/v6","openbsd/arm/v7","openbsd/arm64","openbsd/arm64/v8","plan9/386","plan9/amd64","plan9/arm","plan9/arm/v5","plan9/arm/v6","plan9/arm/v7","solaris/amd64","windows/386","windows/amd64","windows/arm","windows/arm/v5","windows/arm/v6","windows/arm/v7","windows/arm64","windows/arm64/v8"],"example":"linux/amd64","type":"string"},"PlatformType":{"enum":["aws","azure","google"],"type":"string"},"Policy":{"properties":{"attributes":{"$ref":"#/components/schemas/LicenseAttributes"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"orgs":{"additionalProperties":false,"description":"An optional set of organizations explicitly associated with this policy. Only one of explicit associations\nor project_attributes may be set.\n","properties":{"self":{"type":"string"}},"required":["self"],"type":"object"}},"type":"object"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"PolicyActionIgnore":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"expires":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"},"ignore_type":{"enum":["wont-fix","not-vulnerable","temporary-ignore"],"type":"string"},"reason":{"type":"string"}},"required":["ignore_type"],"type":"object"},"type":{"enum":["ignore"],"type":"string"}},"required":["type","data"],"type":"object"},"PolicyActionIgnore20231127":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"ignore_type":{"enum":["wont-fix","not-vulnerable","temporary-ignore"],"type":"string"},"reason":{"type":"string"}},"required":["ignore_type"],"type":"object"},"type":{"enum":["ignore"],"type":"string"}},"required":["type","data"],"type":"object"},"PolicyActionIgnoreResponse":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"expires":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"},"ignore_type":{"enum":["wont-fix","not-vulnerable","temporary-ignore"],"type":"string"},"ignored_by":{"properties":{"email":{"nullable":true,"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"reason":{"type":"string"}},"required":["ignore_type"],"type":"object"},"type":{"enum":["ignore"],"type":"string"}},"required":["type","data"],"type":"object"},"PolicyActionSeverityOverride":{"oneOf":[{"$ref":"#/components/schemas/PolicyActionSeverityOverrideLowMediumHigh"},{"$ref":"#/components/schemas/PolicyActionSeverityOverrideCritical"}]},"PolicyActionSeverityOverrideCritical":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"severity":{"enum":["critical"],"type":"string"}},"required":["severity"],"type":"object"},"type":{"enum":["severity-override"],"type":"string"}},"required":["type","data"],"type":"object"},"PolicyActionSeverityOverrideLowMediumHigh":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"severity":{"enum":["low","medium","high"],"type":"string"}},"required":["severity"],"type":"object"},"type":{"enum":["severity-override"],"type":"string"}},"required":["type","data"],"type":"object"},"PolicyCondition":{"additionalProperties":false,"properties":{"field":{"enum":["issue-id","snyk/asset/finding/v1"],"type":"string"},"operator":{"enum":["includes"],"type":"string"},"value":{"items":{"type":"string"},"type":"array"}},"required":["field","operator","value"],"type":"object"},"PolicyRule":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PolicyRuleAttributes"},"id":{"description":"A unique identifier for this particular occurrence of the policy rule.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy_rule"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"PolicyRuleAttributes":{"additionalProperties":false,"properties":{"actions":{"items":{"$ref":"#/components/schemas/PolicyActionIgnore"},"type":"array"},"conditions":{"items":{"$ref":"#/components/schemas/PolicyCondition"},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"PolicyRuleResponse":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PolicyRuleResponseAttributes"},"id":{"description":"A unique identifier for this particular occurrence of the policy rule.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy_rule"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"PolicyRuleResponseAttributes":{"additionalProperties":false,"properties":{"actions":{"items":{"$ref":"#/components/schemas/PolicyActionIgnoreResponse"},"type":"array"},"conditions":{"items":{"$ref":"#/components/schemas/PolicyCondition"},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"PolicyUpdate":{"properties":{"attributes":{"$ref":"#/components/schemas/LicenseAttributesUpdate"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"PostDiffScanRequest":{"additionalProperties":false,"properties":{"attributes":{"properties":{"base_workspace_id":{"description":"ID of the base workspace to be scanned. This workspace models the base or initial revision of the diff","example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"flow":{"$ref":"#/components/schemas/Flow"},"head_workspace_id":{"description":"ID of the base workspace to be scanned. This workspace models the head or latest revision of the diff","example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"scan_options":{"$ref":"#/components/schemas/ScanOptions"}},"required":["base_workspace_id","head_workspace_id","flow"],"type":"object"},"id":{"example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"type":{"enum":["scan"],"example":"scan","type":"string"}},"required":["type","attributes"],"type":"object"},"PostGitTestRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"continuous_monitor":{"description":"The test will result in a continuous monitor by Snyk","type":"boolean"},"options":{"$ref":"#/components/schemas/TestOptionsGitUrl"}},"required":["options"],"type":"object"},"type":{"enum":["test"],"example":"test","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"PostScanRequest":{"additionalProperties":false,"properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/PostWorkspaceScanRequest"},{"$ref":"#/components/schemas/PostDiffScanRequest"}]}},"required":["data"],"type":"object"},"PostWorkspaceScanRequest":{"additionalProperties":false,"properties":{"attributes":{"properties":{"flow":{"$ref":"#/components/schemas/Flow"},"scan_options":{"$ref":"#/components/schemas/ScanOptions"},"workspace_id":{"description":"ID of the workspace to be scanned. We are migrating from URL to the ID.","example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"workspace_url":{"description":"Deprecated: Send the workspace ID instead of the workspace URL. The URI of the workspace to be scanned as returned by the workspace service.","example":"https://example.com","format":"uri","type":"string"}},"required":["workspace_id","flow"],"type":"object"},"id":{"example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"type":{"enum":["workspace"],"example":"workspace","type":"string"}},"required":["type","attributes"],"type":"object"},"PrCheckFlow":{"additionalProperties":false,"properties":{"name":{"description":"The flow which the scan is triggered for.","enum":["pr_check"],"example":"pr_check","type":"string"}},"required":["name"],"type":"object"},"Principal20220914":{"additionalProperties":false,"properties":{"attributes":{"anyOf":[{"$ref":"#/components/schemas/UserAttrs"},{"$ref":"#/components/schemas/ServiceAccount20230828"},{"$ref":"#/components/schemas/AppInstance"}]},"id":{"description":"The Snyk ID corresponding to this user, service account or app","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type.","enum":["user","service_account","app_instance"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"Principal20240422":{"additionalProperties":false,"properties":{"attributes":{"anyOf":[{"$ref":"#/components/schemas/User20240422"},{"$ref":"#/components/schemas/ServiceAccount20240422"},{"$ref":"#/components/schemas/AppInstance"}]},"id":{"description":"The Snyk ID corresponding to this user, service account or app","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type.","enum":["user","service_account","app_instance"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"Problem":{"additionalProperties":false,"example":{"id":"SNYK-DEBIAN8-CURL-358558","source":"snyk","type":"rule"},"properties":{"disclosed_at":{"description":"When this problem was disclosed to the public.","format":"date-time","type":"string"},"discovered_at":{"description":"When this problem was first discovered.","format":"date-time","type":"string"},"id":{"maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CVE","maxLength":64,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/ProblemTypeDef"},"updated_at":{"description":"When this problem was last updated.","format":"date-time","type":"string"},"url":{"description":"An optional URL for this problem.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","type","source"],"type":"object"},"Problem3":{"properties":{"disclosed_at":{"description":"When this problem was disclosed to the public.","format":"date-time","type":"string"},"discovered_at":{"description":"When this problem was first discovered.","format":"date-time","type":"string"},"id":{"example":"CWE-61","maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CVE","maxLength":64,"minLength":1,"type":"string"},"updated_at":{"description":"When this problem was last updated.","format":"date-time","type":"string"},"url":{"description":"An optional URL for this problem.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","source"],"type":"object"},"ProblemTypeDef":{"enum":["rule","vulnerability"],"type":"string"},"ProjectAttributes":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings20240531"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectAttributes20220812":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectAttributes20230215":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectAttributes20230911":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectAttributes20231106":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectMeta":{"additionalProperties":false,"properties":{"imported":{"description":"The time the project was imported","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"issues_critical_count":{"description":"The sum of critical severity issues of the project","example":10,"type":"number"},"issues_high_count":{"description":"The sum of high severity issues of the project","example":10,"type":"number"},"issues_low_count":{"description":"The sum of low severity issues of the project","example":10,"type":"number"},"issues_medium_count":{"description":"The sum of medium severity issues of the project","example":10,"type":"number"},"last_tested_at":{"description":"The time the project was last tested","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"}},"required":["imported","last_tested_at","issues_critical_count","issues_high_count","issues_medium_count","issues_low_count"],"type":"object"},"ProjectOfCollection":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/ProjectMeta"},"relationships":{"additionalProperties":false,"properties":{"target":{"properties":{"data":{"properties":{"id":{"description":"ID of the target that owns the project","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"enum":["target"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["target"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","meta","relationships"],"type":"object"},"ProjectRegistrationAttributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"}]},"disabled":{"type":"boolean"},"name":{"description":"A name for users to more easily identify this registration.","type":"string"},"org_id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"org_registration_id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"project_id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/RegistrationType"}},"required":["org_id","org_registration_id","project_id","name","type","config","disabled"],"type":"object"},"ProjectRegistrationData":{"description":"A project-level registration.","properties":{"attributes":{"$ref":"#/components/schemas/ProjectRegistrationAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"ProjectRelationships":{"additionalProperties":false,"properties":{"importer":{"$ref":"#/components/schemas/Relationship"},"organization":{"$ref":"#/components/schemas/Relationship"},"owner":{"$ref":"#/components/schemas/Relationship"},"target":{"oneOf":[{"$ref":"#/components/schemas/Relationship"},{"$ref":"#/components/schemas/ProjectRelationshipsTarget20230215"}]}},"required":["target","organization"],"type":"object"},"ProjectRelationships20220812":{"additionalProperties":false,"properties":{"importer":{"$ref":"#/components/schemas/Relationship"},"organization":{"$ref":"#/components/schemas/Relationship"},"owner":{"$ref":"#/components/schemas/Relationship"},"target":{"oneOf":[{"$ref":"#/components/schemas/Relationship"},{"$ref":"#/components/schemas/ProjectRelationshipsTarget20220812"}]}},"required":["target","organization"],"type":"object"},"ProjectRelationshipsTarget":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectRelationshipsTarget20220812":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectRelationshipsTarget20230215":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectRelationshipsTarget20230911":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectRelationshipsTarget20231106":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectSetting":{"properties":{"attributes":{"properties":{"severity_threshold":{"description":"Minimum Snyk issue severity to send a notification for, messages will not be sent for any issue below this value","enum":["low","medium","high","critical"],"type":"string"},"target_channel":{"$ref":"#/components/schemas/TargetChannel"}},"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"example":"slack","type":"string"}},"required":["type","id","attributes"],"type":"object"},"ProjectSettings":{"additionalProperties":false,"properties":{"auto_dependency_upgrade":{"$ref":"#/components/schemas/AutoDependencyUpgradeSettings"},"auto_remediation_prs":{"$ref":"#/components/schemas/AutoRemediationPRsSettings"},"manual_remediation_prs":{"$ref":"#/components/schemas/ManualRemediationPRsSettings"},"pull_request_assignment":{"$ref":"#/components/schemas/PullRequestAssignmentSettings"},"pull_requests":{"$ref":"#/components/schemas/PullRequestsSettings"},"recurring_tests":{"$ref":"#/components/schemas/RecurringTestsSettings"}},"required":["recurring_tests","pull_requests"],"type":"object"},"ProjectSettings20240531":{"additionalProperties":false,"properties":{"auto_dependency_upgrade":{"$ref":"#/components/schemas/AutoDependencyUpgradeSettings20240531"},"auto_remediation_prs":{"$ref":"#/components/schemas/AutoRemediationPRsSettings20240531"},"manual_remediation_prs":{"$ref":"#/components/schemas/ManualRemediationPRsSettings20240531"},"pull_request_assignment":{"$ref":"#/components/schemas/PullRequestAssignmentSettings20240531"},"pull_requests":{"$ref":"#/components/schemas/PullRequestsSettings"},"recurring_tests":{"$ref":"#/components/schemas/RecurringTestsSettings"}},"required":["recurring_tests","pull_requests"],"type":"object"},"ProjectSettingsData":{"properties":{"attributes":{"additionalProperties":false,"properties":{"is_active":{"$ref":"#/components/schemas/IsActive"},"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"},"target_channel_name":{"$ref":"#/components/schemas/TargetChannelName"},"target_project_name":{"description":"The target file name for the project.","example":"snyk/goof:package.json","type":"string"}},"required":["target_channel_id","target_channel_name","severity_threshold","target_project_name","is_active"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"example":"slack","type":"string"}},"type":"object"},"ProjectSettingsPatchRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"is_active":{"$ref":"#/components/schemas/IsActive"},"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"}},"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"enum":["slack"],"type":"string"}},"required":["type","attributes","id"],"type":"object"}},"type":"object"},"PublicApp":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PublicAppAttributes"},"id":{"format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/Links"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"},"PublicAppAttributes":{"properties":{"client_id":{"$ref":"#/components/schemas/ClientId"},"context":{"$ref":"#/components/schemas/Context"},"name":{"$ref":"#/components/schemas/AppName"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","client_id"],"type":"object"},"PublicAppData":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"client_id":{"format":"uuid","type":"string"},"context":{"description":"Allow installing the app to a org/group or to a user, default tenant.","enum":["tenant","user"],"type":"string"},"name":{"description":"New name of the app to display to users during authorization flow.","example":"My App","minLength":1,"type":"string"},"scopes":{"description":"The scopes this app is allowed to request during authorization.","items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"}},"required":["name","client_id"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"},"PublicFacingRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"PublicTarget":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"created_at":{"description":"The creation date of the target","example":"2022-09-01T00:00:00Z","format":"date-time","type":"string"},"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source.\n","example":"snyk-fixtures/goof","type":"string"},"is_private":{"description":"If the target is private, or publicly accessible","example":false,"type":"boolean"},"url":{"description":"The URL for the resource.","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"required":["display_name","url","is_private"],"type":"object"},"id":{"description":"The id of this target","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"integration":{"additionalProperties":false,"description":"The configured integration which this target relates to","properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"integration_type":{"description":"The human readable name for this type of integration","example":"gitlab","type":"string"}},"required":["integration_type"],"type":"object"},"id":{"example":"7667dae6-602c-45d9-baa9-79e1a640f199","format":"uuid","nullable":true,"type":"string"},"type":{"description":"Content type.","example":"integration","type":"string"}},"required":["id","type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"organization":{"additionalProperties":false,"description":"The organization which owns this target","properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"e661d4ef-5ad5-4cef-ad16-5157cefa83f5","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"organization","type":"string"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["organization","integration"],"type":"object"},"type":{"description":"Content type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"PublishedDate":{"description":"The date the package release was published in YYYY-MM-DDTHH:mm:ssZ format. For example midnight on the 1st July 2021 would be written 2021-07-01T00:00:00Z.","example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"PullRequestAssignmentSettings":{"additionalProperties":false,"description":"Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Project's integration.","properties":{"assignees":{"description":"Manually specify users to assign (and all will be assigned).","example":["my-github-username"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically assign pull requests created by Snyk.","example":true,"type":"boolean"},"type":{"description":"Automatically assign the last user to change the manifest file (\"auto\"), or manually specify a list of users (\"manual\").","enum":["auto","manual"],"example":"auto","type":"string"}},"type":"object"},"PullRequestAssignmentSettings20240531":{"additionalProperties":false,"description":"Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Organization's integration.","properties":{"assignees":{"description":"Manually specify users to assign (and all will be assigned).","example":["my-github-username"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically assign pull requests created by Snyk.","example":true,"type":"boolean"},"type":{"description":"Automatically assign the last user to change the manifest file (\"auto\"), or manually specify a list of users (\"manual\").","enum":["auto","manual"],"example":"auto","type":"string"}},"type":"object"},"PullRequestTemplateAttributes":{"additionalProperties":false,"minProperties":1,"properties":{"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.","properties":{"fail_only_for_issues_with_fix":{"description":"Only fail when the issues found have a fix available.","example":true,"type":"boolean"},"policy":{"description":"Fail if the project has any issues (\"all\"), or fail if a PR is introducing a new dependency with issues (\"only_new\"). If this value is unset, the setting is inherited from the org default.","enum":["all","only_new"],"example":"all","type":"string"},"severity_threshold":{"description":"Only fail for issues greater than or equal to the specified severity. If this value is unset, the setting is inherited from the org default.","enum":["low","medium","high","critical"],"example":"high","type":"string"}},"type":"object"},"PullRequsetTemplateId":{"example":"https://api.snyk.io/rest/groups/7626925e-4b0f-11ee-be56-0242ac120002/pull_request_template","format":"uri","type":"string"},"QuayCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["quay-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"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"},"ReachabilityDef":{"enum":["function","package","no-info","not-applicable"],"type":"string"},"RecommendedVersionAttributes":{"properties":{"identifier":{"description":"Original package name as identifier. It can be a scoped or unscoped package name.","example":"com.amazonaws:aws-java-sdk-core","type":"string"},"initial_version":{"description":"Initial version of this package","example":"1.0.0","type":"string"},"is_private_upgrade":{"description":"Package is distributed via a private registry. Value is false for open source packages.","example":false,"type":"boolean"},"release":{"$ref":"#/components/schemas/Attributes"},"versions_diff":{"description":"The version difference between the current version and the recommended version","example":4,"type":"number"}},"required":["release","identifier","initial_version","is_private_upgrade","versions_diff"],"type":"object"},"RecurringTestFlow":{"additionalProperties":false,"properties":{"name":{"description":"The flow which the scan is triggered for.","enum":["recurring_test"],"example":"recurring_test","type":"string"}},"required":["name"],"type":"object"},"RecurringTestsSettings":{"additionalProperties":false,"description":"Settings which describe how recurring tests are run for a project.","properties":{"frequency":{"description":"Test frequency of a project. Also controls when automated PRs may be created.","enum":["daily","weekly","never"],"example":"daily","type":"string"}},"type":"object"},"RedirectUris":{"description":"List of allowed redirect URIs to call back after authentication.","example":["https://example.com/callback"],"items":{"format":"uri","type":"string"},"minItems":1,"type":"array"},"RedirectUrisNoMin":{"description":"List of allowed redirect URIs to call back after authentication.","example":["https://example.com/callback"],"items":{"format":"uri","type":"string"},"type":"array"},"Region":{"properties":{"end":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"start":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"}},"required":["start","end"],"type":"object"},"RegistrationType":{"description":"The type of Cloud Events integration represented by a registration.","enum":["aws-cloudtrail","aws-securityhub","aws-eventbridge","google-securitycommandcenter"],"type":"string"},"RelatedLink":{"additionalProperties":false,"example":{"related":"https://example.com/api/other_resource"},"properties":{"related":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"Relationship":{"example":{"data":{"id":"4a72d1db-b465-4764-99e1-ecedad03b06a","type":"resource"},"links":{"related":{"href":"https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"}}},"properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"4a72d1db-b465-4764-99e1-ecedad03b06a","format":"uuid","type":"string"},"type":{"description":"Type of the related resource","example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","links"],"type":"object"},"Remedy":{"additionalProperties":false,"properties":{"correlation_id":{"description":"An optional identifier for correlating remedies between coordinates or across issues. They are scoped\nto a single Project and test run. Remedies with the same correlation_id must have the same contents.\n","maxLength":256,"minLength":1,"type":"string"},"description":{"description":"A markdown-formatted optional description of this remedy. Links are not permitted.","maxLength":4096,"minLength":1,"type":"string"},"meta":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.","type":"object"},"schema_version":{"description":"A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n","maxLength":256,"minLength":1,"type":"string"}},"required":["data","schema_version"],"type":"object"},"type":{"enum":["indeterminate","manual","automated","rule_result_message","terraform","cloudformation","cli","kubernetes","arm"],"type":"string"}},"required":["type"],"type":"object"},"Remedy3":{"properties":{"description":{"description":"A markdown-formatted optional description of this remedy.","example":"Upgrade the package version to 5.4.0,6.4.0 to fix this vulnerability","type":"string"},"details":{"properties":{"upgrade_package":{"description":"A minimum version to upgrade to in order to remedy the issue.","example":"5.4.0,6.4.0","type":"string"}},"type":"object"},"type":{"description":"The type of the remedy. Always ‘indeterminate’.","example":"indeterminate","type":"string"}},"type":"object"},"RemedyMetadata":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.","type":"object"},"schema_version":{"description":"A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n","maxLength":256,"minLength":1,"type":"string"}},"required":["data","schema_version"],"type":"object"},"RepoQueryAttributes":{"additionalProperties":false,"example":{"query":"s","target_id":"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"},"properties":{"query":{"type":"string"},"target_id":{"format":"uuid","type":"string"}},"required":["target_id","query"],"type":"object"},"Resolution":{"additionalProperties":false,"description":"An optional field recording when and via what means an issue was resolved, if it was resolved.\nResolved issues are retained for XX days.\n","properties":{"details":{"description":"Optional details about the resolution. Used by Snyk Cloud so far.","type":"string"},"resolved_at":{"description":"The time when this issue was resolved.","format":"date-time","type":"string"},"type":{"$ref":"#/components/schemas/ResolutionTypeDef"}},"required":["type","resolved_at"],"type":"object"},"ResolutionTypeDef":{"enum":["disappeared","fixed"],"type":"string"},"Resource":{"properties":{"iac_mappings_count":{"description":"Amount of IaC resources this resource maps to.","format":"int64","minimum":0,"type":"integer"},"id":{"description":"Internal ID for a resource.","format":"uuid","type":"string"},"input_type":{"enum":["cloud_scan","arm","k8s","tf","tf_hcl","tf_plan","tf_state","cfn"],"type":"string"},"location":{"maxLength":256,"minLength":1,"type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this resource. For example, a cloud resource id.","maxLength":2048,"minLength":1,"type":"string"},"platform":{"maxLength":256,"minLength":1,"type":"string"},"resource_type":{"maxLength":256,"minLength":1,"type":"string"},"tags":{"additionalProperties":{"maxLength":256,"type":"string"},"type":"object"},"type":{"enum":["cloud","iac"],"type":"string"}},"required":["input_type"],"type":"object"},"ResourceAttributes":{"example":{"created_at":"2022-08-10T17:19:33.14749Z","hash":"3333342563a86c675333de5848c9220a7bb35c039e7b9c0688c10f72b4666666","kind":"runtime","location":"us-west-2","name":"example-bucket","namespace":"us-west-2","native_id":"arn:aws:s3:::example-bucket","options":"json here","origin":"aws-account","platform":"aws","resource_id":"example-bucket","resource_type":"aws_s3_bucket","revision":1,"state":{"acl":"private","arn":"arn:aws:s3:::example-bucket","bucket":"example-bucket"},"tags":{"stage":"prod"},"updated_at":"2022-08-10T17:19:33.14749Z"},"properties":{"created_at":{"description":"When the resource was first recorded","example":"2022-08-10T17:19:33.14749Z","format":"date-time","type":"string"},"deleted_at":{"format":"date-time","nullable":true,"type":"string"},"hash":{"description":"Computed hash value for the resource based on its attributes","example":"3333342563a86c675333de5848c9220a7bb35c039e7b9c0688c10f72b4666666","type":"string"},"is_managed":{"nullable":true,"type":"boolean"},"kind":{"$ref":"#/components/schemas/ResourceKind"},"location":{"description":"Physical location (AWS region)","example":"us-west-2","type":"string"},"name":{"description":"Human friendly resource name","example":"example-bucket","type":"string"},"namespace":{"description":"Resource namespace (AWS region)","example":"us-west-2","type":"string"},"native_id":{"description":"ID of the physical resource from the cloud provider (AWS ARN, if available)","example":"arn:aws:s3:::example-bucket","type":"string"},"platform":{"description":"Resource platform: aws","example":"aws","type":"string"},"relationships":{"additionalProperties":true,"type":"object"},"removed_at":{"format":"date-time","nullable":true,"type":"string"},"resource_id":{"description":"Unique ID for the resource","example":"4a662442-7445-55c3-adcc-cbbbdd99999","type":"string"},"resource_type":{"description":"Terraform resource type","example":"aws_s3_bucket","type":"string"},"revision":{"description":"Increment for each change to a resource","example":2,"type":"integer"},"schema_version":{"nullable":true,"type":"string"},"source_location":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"state":{"additionalProperties":true,"description":"Terraform state attributes","type":"object"},"tags":{"additionalProperties":true,"description":"Resource tags from the cloud provider","example":{"stage":"prod"},"type":"object"},"updated_at":{"description":"When the resource was last updated","example":"2022-08-10T17:19:33.14749Z","format":"date-time","nullable":true,"type":"string"}},"required":["created_at","updated_at","revision","kind","hash","platform","resource_type","resource_id"],"type":"object"},"ResourceKind":{"description":"Kind of resource: cloud","example":"cloud - cloud - iac","type":"string"},"ResourcePath":{"example":",5.4.0),[6.0.0.pr1,6.4.0)","maxLength":2024,"minLength":1,"type":"string"},"ResourcePathRepresentation":{"description":"An object that contains an opaque identifying string.","properties":{"resource_path":{"$ref":"#/components/schemas/ResourcePath"}},"required":["resource_path"],"type":"object"},"ResourceReference":{"additionalProperties":false,"properties":{"id":{"example":"4a72d1db-b465-4764-99e1-ecedad03b06a","format":"uuid","type":"string"},"type":{"description":"Type of the related resource","example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"ResourceRelationships":{"additionalProperties":true,"description":"Resource relationships","example":{"environment":{"data":{"id":"11000000-0000-0000-0000-000000000000","type":"environment"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"organization":{"data":{"id":"10000000-0000-0000-0000-000000000000","type":"organization"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"scan":{"data":{"id":"12000000-0000-0000-0000-000000000000","type":"scan"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}}},"type":"object"},"Risk":{"additionalProperties":false,"description":"Risk prioritization information for an issue","example":{"factors":[{"name":"deployed","updated_at":"2023-09-07T13:36:37Z","value":true}],"score":{"model":"v4","value":700}},"properties":{"factors":{"description":"Risk factors identified for an issue","items":{"$ref":"#/components/schemas/RiskFactor"},"type":"array"},"score":{"$ref":"#/components/schemas/RiskScore"}},"required":["factors"],"type":"object"},"RiskFactor":{"discriminator":{"mapping":{"deployed":"#/components/schemas/DeployedRiskFactor","loaded_package":"#/components/schemas/LoadedPackageRiskFactor","os_condition":"#/components/schemas/OSConditionRiskFactor","public_facing":"#/components/schemas/PublicFacingRiskFactor"},"propertyName":"name"},"oneOf":[{"$ref":"#/components/schemas/DeployedRiskFactor"},{"$ref":"#/components/schemas/OSConditionRiskFactor"},{"$ref":"#/components/schemas/PublicFacingRiskFactor"},{"$ref":"#/components/schemas/LoadedPackageRiskFactor"}]},"RiskFactorLinks":{"properties":{"evidence":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"RiskScore":{"description":"Risk prioritization score based on an analysis model","example":{"model":"v1","value":700},"properties":{"model":{"description":"Risk scoring model used to calculate the score value","type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"description":"Risk score value, which may be used for overall prioritization","maximum":1000,"minimum":0,"type":"integer"}},"required":["value","model"],"type":"object"},"Role":{"properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"type":{"description":"The type of the resource","enum":["tenant_role"],"type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"},"RuleBundle":{"description":"Custom rule","properties":{"attributes":{"properties":{"checksum":{"type":"string"},"name":{"type":"string"}},"type":"object"},"id":{"description":"Custom rule bundle ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"SSOConnection":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SSOConnectionAttributes"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"sso_connection","type":"string"}},"required":["type","id","attributes"],"type":"object"},"SSOConnectionAttributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the sso connection.","example":"My SSO","type":"string"}},"required":["name"],"type":"object"},"SastEnablement":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"autofix_enabled":{"type":"boolean"},"sast_enabled":{"type":"boolean"}},"required":["sast_enabled"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"SbomDocument":{"additionalProperties":true,"type":"object"},"SbomMonitorFlow":{"additionalProperties":false,"properties":{"name":{"description":"The flow which the scan is triggered for.","enum":["sbom_monitor"],"example":"sbom_monitor","type":"string"}},"required":["name"],"type":"object"},"SbomResource":{"additionalProperties":false,"properties":{"id":{"example":"b68b0b85-d039-4c05-abc0-04eb50ca0fe9","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"SbomResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SbomResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","data"],"type":"object"},"SbomTestCreateAttributes":{"properties":{"format":{"type":"string"},"sbom":{"additionalProperties":true,"type":"object"}},"required":["sbom"],"type":"object"},"SbomTestResultsAttributes":{"additionalProperties":true,"type":"object"},"ScanAttributes":{"description":"Scan attributes","example":{"created_at":"2022-05-06T12:25:15-04:00","error":"","finished_at":"2022-05-06T12:25:15-04:00","kind":"user_initiated","options":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"},"revision":1,"status":"success","updated_at":"2022-05-06T12:25:15-04:00"},"properties":{"created_at":{"description":"When the scan was created","example":"2022-05-06T12:25:15-04:00","format":"date-time","type":"string"},"deleted_at":{"format":"date-time","nullable":true,"type":"string"},"environment_id":{"description":"Environment ID","example":"052781a7-17f6-494d-0000-25c8b509abcd","format":"uuid","type":"string"},"error":{"description":"Error message if the scan failed","example":"could not start scan","nullable":true,"type":"string"},"finished_at":{"description":"When the scan finished","example":"2022-05-06T12:25:15-04:00","format":"date-time","nullable":true,"type":"string"},"kind":{"description":"Scan kind","enum":["scheduled","user_initiated","event_driven",null],"example":"user_initiated","nullable":true,"type":"string"},"options":{"example":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"},"nullable":true,"type":"object"},"organization_id":{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","format":"uuid","type":"string"},"partial_errors":{"description":"Errors that didn't fail the scan","type":"string"},"revision":{"description":"Increment for each change to a scan","example":1,"type":"number"},"status":{"description":"Scan status","enum":["queued","in_progress","success","error",null],"example":"in_progress","nullable":true,"type":"string"},"updated_at":{"description":"When the scan was last updated","example":"2022-05-06T12:25:15-04:00","format":"date-time","nullable":true,"type":"string"}},"required":["created_at","revision","kind","status","error"],"type":"object"},"ScanCreateAttributes":{"additionalProperties":false,"description":"Scan create attributes","type":"object"},"ScanCreateRelationships":{"description":"Scan create relationships","properties":{"environment":{"properties":{"data":{"example":{"id":"12000000-0000-0000-0000-000000000000","type":"environment"},"properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["type","id"],"type":"object"}},"type":"object"}},"type":"object"},"ScanItemType":{"enum":["project","environment"],"example":"project","type":"string"},"ScanJob":{"additionalProperties":false,"properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/ScanJobBasicAttributes"}]},"id":{"example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"type":{"enum":["scan_job"],"example":"scan_job","type":"string"}},"required":["id","type","attributes"],"type":"object"},"ScanJobBasicAttributes":{"properties":{"created_at":{"description":"Point in time in which this job was created","example":"2017-07-21T17:32:28Z","format":"date-time","type":"string"},"status":{"description":"Defines the completion status of this job. The job is considered finished when: - the status is `done` meaning it successfully completed, although some product lines might have reported errors, or timed out - the status is `failed` meaning it prematurely failed to complete and no product line got a chance to report - the status is `timeout` when the overall job did not manage to complete on time The job is considered in progress when: - the status is either `queued` meaning it hasn't been picked up yet by the orchestrator - the status is `in_progress` meaning it has been picked up by the orchestrator but product lines are still scanning\n","enum":["queued","in_progress","done","timeout","failed","unknown"],"example":"in_progress","type":"string"},"user_id":{"description":"Snyk user id who initiates the scan","example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"}},"required":["created_at","status"],"type":"object"},"ScanJobResults":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"components":{"description":"A list of software components identified during the scan as well as related findings associated to it.\nE.g. if a Git repository contains 2 NPM projects and javascript code server/package.json and client/package.json, assuming we have SCA and SAST enabled the scan might come back with the following components: - SCA scan: server/package.json - SCA scan: client/package.json - SAST scan: all the code in the repository\n","items":{"$ref":"#/components/schemas/Component"},"type":"array"},"created_at":{"description":"Point in time in which this job was created","example":"2017-07-21T17:32:28Z","format":"date-time","type":"string"},"status":{"description":"Defines the completion status of this job. The job is considered finished when: - the status is `done` meaning it successfully completed, although some product lines might have reported errors, or timed out - the status is `failed` meaning it prematurely failed to complete and no product line got a chance to report - the status is `timeout` when the overall job did not manage to complete on time The job is considered in progress when: - the status is either `queued` meaning it hasn't been picked up yet by the orchestrator - the status is `in_progress` meaning it has been picked up by the orchestrator but product lines are still scanning\n","enum":["queued","in_progress","done","timeout","failed","unknown"],"example":"in_progress","type":"string"}},"required":["created_at","status","components"],"type":"object"},"id":{"example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"type":{"enum":["scan_job_results"],"example":"scan_job_results","type":"string"}},"required":["id","type","attributes"],"type":"object"},"ScanOptions":{"additionalProperties":false,"description":"Additional options for the scan","properties":{"limit_scan_to_files":{"description":"The findings will be limited to a subset of files only.","items":{"type":"string"},"type":"array"}},"type":"object"},"ScanRelationships":{"additionalProperties":true,"description":"Scan relationships","example":{"environment":{"data":{"id":"12000000-0000-0000-0000-000000000000","type":"environment"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"organization":{"data":{"id":"10000000-0000-0000-0000-000000000000","type":"organization"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}}},"type":"object"},"ScanResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ScanJob"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data"],"type":"object"},"ScanResultsResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ScanJobResults"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data"],"type":"object"},"ScanType":{"example":"scan","type":"string"},"Scopes":{"description":"The scopes this app is allowed to request during authorization.","items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"},"SecretAttributes":{"additionalProperties":false,"properties":{"encrypted":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"nonce":{"type":"string"}},"required":["nonce","encrypted","expires_at"],"type":"object"},"SecurityActionAnnotation":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"reason":{"type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":{"enum":["annotation"],"type":"string"}},"required":["type","data"],"type":"object"},"SecurityActionIgnore":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"ignore_type":{"enum":["wont-fix","not-vulnerable","temporary-ignore"],"type":"string"},"reason":{"type":"string"}},"required":["ignore_type"],"type":"object"},"type":{"enum":["ignore"],"type":"string"}},"required":["type","data"],"type":"object"},"SecurityActionSeverityOverride":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"reason":{"type":"string"},"severity":{"enum":["low","medium","high","critical"],"type":"string"}},"required":["severity"],"type":"object"},"type":{"enum":["severity-override"],"type":"string"}},"required":["type","data"],"type":"object"},"SecurityAttributes":{"additionalProperties":false,"properties":{"configuration":{"description":"A list of security policy rules.\n","items":{"additionalProperties":false,"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/SecurityActionSeverityOverride"},{"$ref":"#/components/schemas/SecurityActionIgnore"},{"$ref":"#/components/schemas/SecurityActionAnnotation"}]},"type":"array"},"conditions":{"items":{"oneOf":[{"$ref":"#/components/schemas/SecurityCondition"},{"$ref":"#/components/schemas/SecurityExploitMaturityCondition"}]},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"type":"array"},"default":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"orgs":{"items":{"format":"uuid","type":"string"},"type":"array"},"policy_type":{"enum":["security"],"type":"string"},"project_attributes":{"additionalProperties":false,"properties":{"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"}},"required":["business_criticality","lifecycle","environment"],"type":"object"}},"required":["name","default","policy_type","configuration"],"type":"object"},"SecurityAttributes20231127":{"additionalProperties":false,"properties":{"configuration":{"description":"A list of security policy rules.\n","items":{"additionalProperties":false,"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/PolicyActionSeverityOverride"},{"$ref":"#/components/schemas/PolicyActionIgnore20231127"}]},"type":"array"},"conditions":{"items":{"$ref":"#/components/schemas/SecurityCondition20231127"},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"type":"array"},"default":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"orgs":{"items":{"format":"uuid","type":"string"},"type":"array"},"policy_type":{"enum":["security"],"type":"string"},"project_attributes":{"additionalProperties":false,"properties":{"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"}},"required":["business_criticality","lifecycle","environment"],"type":"object"}},"required":["name","default","policy_type","configuration"],"type":"object"},"SecurityAttributesUpdate":{"additionalProperties":false,"properties":{"configuration":{"description":"A list of security policy rules.\n","items":{"additionalProperties":false,"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/SecurityActionSeverityOverride"},{"$ref":"#/components/schemas/SecurityActionIgnore"},{"$ref":"#/components/schemas/SecurityActionAnnotation"}]},"type":"array"},"conditions":{"items":{"oneOf":[{"$ref":"#/components/schemas/SecurityCondition"},{"$ref":"#/components/schemas/SecurityExploitMaturityCondition"}]},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"type":"array"},"default":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"SecurityAttributesUpdate20231127":{"additionalProperties":false,"properties":{"configuration":{"description":"A list of security policy rules.\n","items":{"additionalProperties":false,"properties":{"actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/PolicyActionSeverityOverride"},{"$ref":"#/components/schemas/PolicyActionIgnore20231127"}]},"type":"array"},"conditions":{"items":{"$ref":"#/components/schemas/SecurityCondition20231127"},"type":"array"},"name":{"type":"string"}},"required":["name","conditions","actions"],"type":"object"},"type":"array"},"default":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"SecurityCommandCenterConfigRequest":{"description":"A registration config specific to Google Security Command Center","properties":{"finding_source_name":{"description":"The full relative resource name for the SCC Finding Source that will be used to send findings.","example":"organizations/{organization_id}/sources/{source_id}","type":"string"},"org_id":{"description":"A GCP organization ID where Security Command Center is enabled.","example":"123456789012","type":"string"}},"required":["org_id"],"type":"object"},"SecurityCommandCenterConfigResponse":{"allOf":[{"$ref":"#/components/schemas/SecurityCommandCenterConfigRequest"},{"properties":{"finding_source_display_name":{"type":"string"}},"type":"object"}]},"SecurityCondition":{"additionalProperties":false,"properties":{"field":{"enum":["cwe","cve","snyk-id","fixable","severity"],"type":"string"},"operator":{"enum":["includes","not-includes"],"type":"string"},"value":{"items":{"type":"string"},"type":"array"}},"required":["field","operator","value"],"type":"object"},"SecurityCondition20231127":{"additionalProperties":false,"properties":{"field":{"enum":["exploit-maturity","cwe","cve","snyk-id","fixable","severity"],"type":"string"},"operator":{"enum":["includes","not-includes"],"type":"string"},"value":{"items":{"type":"string"},"type":"array"}},"required":["field","operator","value"],"type":"object"},"SecurityExploitMaturityCondition":{"additionalProperties":false,"properties":{"field":{"enum":["exploit-maturity"],"type":"string"},"operator":{"enum":["includes","not-includes"],"type":"string"},"value":{"enum":["mature","proof-of-concept","no-known-exploit","no-data"],"type":"string"}},"required":["field","operator","value"],"type":"object"},"SecurityHubConfig":{"description":"A registration config for AWS Security Hub","example":{"account_id":"123456789012"},"properties":{"account_id":{"example":"123456789012","type":"string"},"region":{"description":"The region where Security Hub is enabled.","example":"us-east-1","type":"string"}},"type":"object"},"SecurityPolicy":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SecurityAttributes"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"relationships":{"properties":{"orgs":{"additionalProperties":false,"description":"An optional set of organizations explicitly associated with this policy. Only one of explicit associations\nor project_attributes may be set.\n","properties":{"self":{"type":"string"}},"required":["self"],"type":"object"}},"type":"object"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"SecurityPolicy20231127":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SecurityAttributes20231127"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"relationships":{"properties":{"orgs":{"additionalProperties":false,"description":"An optional set of organizations explicitly associated with this policy. Only one of explicit associations\nor project_attributes may be set.\n","properties":{"self":{"type":"string"}},"required":["self"],"type":"object"}},"type":"object"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"SecurityPolicyUpdate":{"properties":{"attributes":{"$ref":"#/components/schemas/SecurityAttributesUpdate"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"SecurityPolicyUpdate20231127":{"properties":{"attributes":{"$ref":"#/components/schemas/SecurityAttributesUpdate20231127"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"SelfLink":{"additionalProperties":false,"example":{"self":"https://example.com/api/this_resource"},"properties":{"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"ServiceAccount":{"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":{"$ref":"#/components/schemas/Links"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"ServiceAccount20230828":{"additionalProperties":false,"properties":{"default_org_context":{"description":"ID of the default org for the service account.","format":"uuid","type":"string"},"name":{"description":"The name of the service account.","example":"user","type":"string"}},"required":["name"],"type":"object"},"ServiceAccount20240422":{"additionalProperties":false,"properties":{"default_org_context":{"description":"ID of the default org for the service account.","format":"uuid","type":"string"},"name":{"description":"The name of the service account.","example":"user","type":"string"}},"required":["name"],"type":"object"},"SessionAttributes":{"properties":{"created_at":{"format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"SessionData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SessionAttributes"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"SettingsAttributes":{"additionalProperties":false,"properties":{"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"}},"required":["target_channel_id","severity_threshold"],"type":"object"},"SettingsRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SettingsAttributes"},"type":{"enum":["slack"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"Severity3":{"properties":{"level":{"description":"Level of severity calculated via vector","example":"medium","type":"string"},"score":{"description":"The CVSS score calculated from the vector, representing the severity of the vulnerability on a scale from 0 to 10.","example":5.3,"nullable":true,"type":"number"},"source":{"description":"The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application.","example":"Snyk","type":"string"},"type":{"description":"Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.","example":"primary","type":"string"},"vector":{"description":"CVSS vector string detailing the metrics of a vulnerability.","example":"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:L","nullable":true,"type":"string"},"version":{"description":"CVSS version being described.","example":"4.0","type":"string"}},"type":"object"},"SeverityThreshold":{"description":"Minimum Snyk issue severity to send a notification for, messages will not be sent for any issue below this value","enum":["low","medium","high","critical"],"example":"high","type":"string"},"SlackChannel":{"properties":{"attributes":{"properties":{"name":{"description":"Name of the Slack Channel","example":"general","type":"string"},"type":{"description":"Channel type","enum":["public","private","direct_message","multiparty_direct_message"],"type":"string"}},"type":"object"},"id":{"example":"slack://channel?team=T123456\u0026id=C123456","format":"uri","type":"string"},"type":{"example":"slack_channel","type":"string"}},"type":"object"},"SlackDefaultSetting":{"properties":{"attributes":{"properties":{"severity_threshold":{"description":"Minimum Snyk issue severity to send a notification for, messages will not be sent for any issue below this value","enum":["low","medium","high","critical"],"example":"high","type":"string"},"target_channel":{"$ref":"#/components/schemas/TargetChannel"}},"type":"object"},"id":{"format":"uuid","type":"string"},"meta":{"properties":{"slack_authed":{"type":"boolean"},"snyk_authed":{"type":"boolean"},"team_id":{"type":"string"}},"required":["snyk_authed","slack_authed"],"type":"object"},"type":{"example":"slack","type":"string"}},"type":"object"},"SlackDefaultSettingsData":{"properties":{"attributes":{"additionalProperties":false,"properties":{"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"},"target_channel_name":{"$ref":"#/components/schemas/TargetChannelName"}},"required":["target_channel_id","target_channel_name","severity_threshold"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"example":"slack","type":"string"}},"type":"object"},"Slots":{"properties":{"disclosure_time":{"description":"The time at which this vulnerability was disclosed.","example":"2022-06-16T13:51:13Z","format":"date-time","type":"string"},"exploit_details":{"$ref":"#/components/schemas/ExploitDetails"},"publication_time":{"description":"The time at which this vulnerability was published.","example":"2022-06-16T14:00:24.315507Z","type":"string"},"references":{"items":{"properties":{"title":{"description":"Descriptor for an external reference to the issue","type":"string"},"url":{"description":"URL for an external reference to the issue","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"SnippetQueryAttributes":{"additionalProperties":false,"example":{"query":"s"},"properties":{"query":{"type":"string"}},"required":["query"],"type":"object"},"SonarqubeAttributes":{"properties":{"sonarqube_api_token":{"format":"uuid","type":"string"},"sonarqube_host_url":{"example":"sonarqube.customer.com","type":"string"}},"required":["sonarqube_host_url","sonarqube_api_token"],"type":"object"},"SourceLocation":{"properties":{"file":{"description":"A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n","maximum":2048,"minimum":1,"type":"string"},"region":{"properties":{"end":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"start":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"}},"required":["start","end"],"type":"object"}},"required":["file"],"type":"object"},"SpdxDocument":{"additionalProperties":true,"type":"object"},"Tag":{"properties":{"tag_type":{"type":"string"},"tag_values":{"items":{"type":"string"},"type":"array"}},"required":["tag_type","tag_values"],"type":"object"},"TargetChannel":{"additionalProperties":false,"properties":{"id":{"example":"slack://channel?team=team-id\u0026id=channel-id","format":"uri","type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"TargetChannelId":{"example":"slack://channel?team=team-id\u0026id=channel-id","format":"uri","type":"string"},"TargetChannelName":{"example":"channel-name","minLength":1,"type":"string"},"TenantAttributes":{"properties":{"created_at":{"description":"The time the tenant was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"name":{"description":"The display name of the tenant.","example":"My Tenant","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the tenant.","example":"my-tenant","type":"string"},"updated_at":{"description":"The time the tenant was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","created_at","updated_at"],"type":"object"},"TenantMembership":{"additionalProperties":false,"properties":{"attributes":{"type":"object"},"id":{"$ref":"#/components/schemas/TenantMembershipId"},"relationships":{"$ref":"#/components/schemas/TenantMembershipRelationships"},"type":{"$ref":"#/components/schemas/TenantMembershipType"}},"required":["id","type","relationships"],"type":"object"},"TenantMembershipId":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"TenantMembershipRelationships":{"additionalProperties":false,"properties":{"role":{"$ref":"#/components/schemas/Role"}},"required":["role"],"type":"object"},"TenantMembershipResponseData":{"additionalProperties":false,"items":{"properties":{"attributes":{"properties":{"created_at":{"description":"date the membership was created","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"role":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the role.","example":"Role name","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"The resource type the role is for","example":"tenant_role","type":"string"}},"required":["type","id","attributes"],"type":"object"},"tenant":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the tenant.","example":"Tenant display name","type":"string"}},"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"The tenant the membership belongs to.","example":"tenant","type":"string"}},"type":"object"},"user":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"account_type":{"description":"Account Type","example":"user","type":"string"},"active":{"description":"whether user is active","type":"boolean"},"email":{"description":"Related user email","example":"user@email.com","type":"string"},"login_method":{"description":"User login method","type":"string"},"name":{"description":"Related user display name","example":"user name","type":"string"},"username":{"description":"Related user username","example":"username","type":"string"}},"required":["name","email","login_method"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"meta":{"properties":{"tenant_owner":{"description":"true only if the user is tenant owner","type":"boolean"}},"type":"object"},"type":{"description":"Always \"user\"","example":"user","type":"string"}},"required":["type","id","attributes"],"type":"object"}},"required":["user","role"],"type":"object"},"type":{"description":"type of membership according to its entity","example":"tenant_membership","type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"},"type":"array"},"TenantMembershipType":{"description":"The type of the resource for tenant operations","enum":["tenant_membership"],"type":"string"},"TenantRelationships":{"properties":{"owner":{"properties":{"data":{"properties":{"id":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"},"type":{"description":"The type of the resource. Always 'user'.","example":"user","type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}},"type":"object"},"TenantResponseData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/TenantAttributes"},"id":{"description":"The Snyk ID of the tenant.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/TenantRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"TenantUpdateAttributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the tenant.","example":"My Tenant","maxLength":60,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"TestDependenciesResult":{"properties":{"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"meta":{"properties":{"ignore_settings":{"type":"boolean"},"is_licenses_enabled":{"type":"boolean"},"is_private":{"type":"boolean"},"org":{"type":"string"}},"type":"object"},"result":{"properties":{"dep_graph_data":{"properties":{"graph":{"properties":{"nodes":{"items":{"properties":{"deps":{"items":{"properties":{"node_id":{"type":"string"}},"type":"object"},"type":"array"},"node_id":{"type":"string"},"pkg_id":{"type":"string"}},"type":"object"},"type":"array"},"root_node_id":{"type":"string"}},"type":"object"},"pkg_manager":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"pkgs":{"items":{"properties":{"id":{"type":"string"},"info":{"properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"type":"object"}},"required":["id","info"],"type":"object"},"type":"array"},"schema_version":{"type":"string"}},"type":"object"},"deps_file_paths":{"additionalProperties":{"type":"string"},"type":"object"},"file_signatures_details":{"additionalProperties":{"properties":{"artifact":{"type":"string"},"author":{"type":"string"},"confidence":{"type":"number"},"cves":{"properties":{"cve":{"properties":{"data_format":{"type":"string"},"data_type":{"type":"string"},"data_version":{"type":"string"},"problem_type":{"properties":{"problem_data":{"items":{"properties":{"description":{"properties":{"lang":{"type":"string"},"value":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"}},"type":"object"},"file_paths":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"path":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"}},"type":"object"},"type":"object"},"issues":{"items":{"properties":{"fix_info":{"properties":{"is_patchable":{"type":"boolean"},"is_pinnable":{"type":"boolean"},"is_runtime":{"type":"boolean"}},"type":"object"},"issue_id":{"type":"string"},"pkg_name":{"type":"string"},"pkg_version":{"type":"string"}},"type":"object"},"type":"array"},"issues_data":{"additionalProperties":{"properties":{"CVSSv3":{"type":"string"},"alternative_ids":{"items":{"type":"string"},"type":"array"},"creation_time":{"type":"string"},"credit":{"items":{"type":"string"},"type":"array"},"cvss_score":{"type":"number"},"description":{"type":"string"},"disclosure_time":{"type":"string"},"exploit":{"type":"string"},"fixedIn":{"items":{"type":"string"},"type":"array"},"functions":{"items":{"type":"string"},"type":"array"},"functions_new":{"items":{"properties":{"function_id":{"properties":{"class_name":{"type":"string"},"function_name":{"type":"string"}},"type":"object"},"version":{"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"id":{"type":"string"},"identifiers":{"additionalProperties":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"type":"object"},"insights":{"properties":{"triage_advice":{"type":"string"}},"type":"object"},"language":{"type":"string"},"malicious":{"type":"boolean"},"modification_time":{"type":"string"},"package_manager":{"type":"string"},"package_name":{"type":"string"},"package_repository_url":{"type":"string"},"patches":{"items":{"properties":{"id":{"type":"string"},"modification_time":{"type":"string"},"urls":{"items":{"type":"string"},"type":"array"},"version":{"type":"string"}},"type":"object"},"type":"array"},"publication_time":{"type":"string"},"references":{"items":{"properties":{"title":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"semver":{"properties":{"vulnerable":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"vulnerable_by_distro":{"additionalProperties":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"type":"object"},"vulnerable_hashes":{"items":{"type":"string"},"type":"array"}},"type":"object"},"severity":{"type":"string"},"severity_with_critical":{"type":"string"},"social_trend_alert":{"type":"boolean"},"title":{"type":"string"}},"type":"object"},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"TestExecutionType":{"enum":["test-workflow-execution","custom-execution"],"type":"string"},"TestOptionsGitUrl":{"properties":{"integration_id":{"description":"A Snyk integration_id","example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"repo_url":{"description":"A repository url for which a test will run","example":"https://github/com/snyk/goof","format":"uri","type":"string"},"revision":{"description":"A git commit revision","example":"97cea0113b8807b00a5c70d5e9073f908a8baae2","type":"string"}},"required":["integration_id","repo_url","revision"],"type":"object"},"TestResponse":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"description":"The id of the Snyk test","example":"275af21f-e92b-40aa-8604-ef9b00c9bd8d","format":"uuid","type":"string"},"type":{"enum":["test"],"example":"test","type":"string"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","links"],"type":"object"},"TestResultAcceptedState":{"properties":{"created_at":{"description":"Timestamp when the test was created","format":"date-time","type":"string"},"state":{"enum":["accepted"],"type":"string"}},"required":["state","created_at"],"type":"object"},"TestResultCompletedState":{"properties":{"created_at":{"description":"Timestamp when the test was created","format":"date-time","type":"string"},"findings":{"items":{"properties":{"findings_url":{"description":"URL where findings can be downloaded","format":"uri","type":"string"},"format":{"description":"The format of the findings document","enum":["SARIF","CYCLONE_DX"],"type":"string"}},"required":["format","findings_url"],"type":"object"},"type":"array"},"result":{"properties":{"status":{"description":"The outcome of the test. passed - the test completed and passed policy gate, failed - the test completed and failed policy gate","enum":["passed","failed"],"type":"string"}},"required":["status"],"type":"object"},"state":{"enum":["completed"],"type":"string"}},"required":["state","created_at","result","findings"],"type":"object"},"TestResultErrorState":{"properties":{"created_at":{"description":"Timestamp when the test was created","format":"date-time","type":"string"},"state":{"enum":["error"],"type":"string"}},"required":["state","created_at"],"type":"object"},"TestResultInProgressState":{"properties":{"created_at":{"description":"Timestamp when the test was created","format":"date-time","type":"string"},"state":{"enum":["in_progress"],"type":"string"}},"required":["state","created_at"],"type":"object"},"TestResultResponse":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/TestResultState"},"id":{"description":"The id of the test","format":"uuid","type":"string"},"type":{"enum":["test"],"example":"test","type":"string"}},"required":["type","id","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi","links"],"type":"object"},"TestResultState":{"discriminator":{"propertyName":"state"},"oneOf":[{"$ref":"#/components/schemas/TestResultAcceptedState"},{"$ref":"#/components/schemas/TestResultInProgressState"},{"$ref":"#/components/schemas/TestResultCompletedState"},{"$ref":"#/components/schemas/TestResultErrorState"}]},"Type":{"type":"string"},"TypeDef":{"description":"The type of an issue.","enum":["package_vulnerability","license","cloud","code","custom","config"],"example":"cloud","type":"string"},"Types":{"example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"},"UpdateBrokerConnectionRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CommonConnectionAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_connection"],"type":"string"}},"required":["attributes","id","type"],"type":"object"}},"required":["data"],"type":"object"},"UpdateBrokerDeploymentRequest":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerDeploymentUpdateResource"}},"required":["data"],"type":"object"},"UpdateCollectionRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/name"}},"required":["name"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"UpdateCollectionWithProjectsRequest":{"additionalProperties":false,"properties":{"data":{"description":"IDs of items to add to a collection","items":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"type":{"description":"Type of the item id","enum":["project"],"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["data"],"type":"object"},"UpdateDeploymentCredentialRequest":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/DeploymentCredentialResource"}},"required":["data"],"type":"object"},"UpdateOrgMembershipRequestBody":{"additionalProperties":false,"properties":{"attributes":{"type":"object"},"id":{"description":"The Snyk ID of the organization.","example":"f60ff965-6889-4db2-8c86-0285d62f35ab","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"role":{"properties":{"data":{"additionalProperties":false,"properties":{"id":{"description":"The Snyk ID of the Org Role.","example":"f60ff965-6889-4db2-8c86-0285d62f35ab","format":"uuid","type":"string"},"type":{"description":"The type of the resource. Always 'org_role'.","example":"org_role","type":"string"}},"required":["type","id"],"type":"object"}},"type":"object"}},"required":["role"],"type":"object"},"type":{"description":"The type of the resource. Always 'org_membership'.","example":"org_membership","type":"string"}},"required":["type","id","relationships"],"type":"object"},"Updated":{"description":"The last time the settings were updated.","example":"2021-11-12T10:31:06.026Z","format":"date-time","type":"string"},"User":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"active":{"description":"Whether the user status is enabled or not","example":true,"type":"boolean"},"email":{"description":"The email of the user.","example":"user@someorg.com","type":"string"},"membership":{"properties":{"created_at":{"description":"The date the membership was established.","example":"2022-09-14T09:19:29.206Z","format":"date-time","type":"string"},"strategy":{"description":"Whether the membership is a direct, or indirect membership.","enum":["direct","indirect"],"example":"direct","type":"string"}},"type":"object"},"name":{"description":"The name of the user.","example":"user","type":"string"},"username":{"description":"The username of the user.","example":"username","type":"string"}},"type":"object"},"id":{"description":"The Snyk ID corresponding to this user","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"user","type":"string"}},"required":["type","id","attributes"],"type":"object"},"User20240422":{"additionalProperties":false,"properties":{"avatar_url":{"description":"The avatar url of the user.","example":"https://snyk.io/avatar.png","format":"uri","type":"string"},"default_org_context":{"description":"ID of the default org for the user.","format":"uuid","type":"string"},"email":{"description":"The email of the user.","example":"user@someorg.com","type":"string"},"name":{"description":"The name of the user.","example":"user","type":"string"},"username":{"description":"The username of the user.","example":"username","type":"string"}},"required":["name","email","avatar_url"],"type":"object"},"UserActivePatchRequestBody":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"active":{"description":"Is this user active","type":"boolean"}},"required":["active"],"type":"object"},"id":{"description":"The Snyk ID corresponding to this user","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type","example":"user","type":"string"}},"required":["type","id","attributes"],"type":"object"},"UserAttrs":{"additionalProperties":false,"properties":{"avatar_url":{"description":"The avatar url of the user.","example":"https://snyk.io/avatar.png","format":"uri","type":"string"},"default_org_context":{"description":"ID of the default org for the user.","format":"uuid","type":"string"},"email":{"description":"The email of the user.","example":"user@someorg.com","type":"string"},"name":{"description":"The name of the user.","example":"user","type":"string"},"username":{"description":"The username of the user.","example":"username","type":"string"}},"required":["name","email","avatar_url"],"type":"object"},"UserPatchRequestBody":{"additionalProperties":false,"properties":{"attributes":{"properties":{"membership":{"nullable":true,"properties":{"role":{"description":"Role name","example":"MEMBER","type":"string"}},"type":"object"}},"required":["membership"],"type":"object"},"id":{"description":"The Snyk ID corresponding to this user","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type","example":"user","type":"string"}},"required":["type","id","attributes"],"type":"object"},"UserPreferredOrgSettings":{"additionalProperties":false,"properties":{"preferred_org":{"additionalProperties":false,"description":"The org to use for operations when there is no explicit org in context","properties":{"id":{"description":"The id of the preferred org","format":"uuid","type":"string"}},"required":["id"],"type":"object"}},"type":"object"},"UserSettings":{"additionalProperties":false,"description":"user settings","properties":{"attributes":{"anyOf":[{"$ref":"#/components/schemas/UserPreferredOrgSettings"}]},"id":{"description":"The id of the user","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"description":"The resource type","enum":["user_settings"],"type":"string"}},"required":["id","type"],"type":"object"},"UserType":{"enum":["user"],"example":"user","type":"string"},"Uuid":{"format":"uuid","type":"string"},"Version":{"description":"The version of the package release","example":"1.2.3","type":"string"},"VersioningSchema":{"allOf":[{"oneOf":[{"$ref":"#/components/schemas/VersioningSchemaSemverType"},{"$ref":"#/components/schemas/VersioningSchemaCustomType"},{"$ref":"#/components/schemas/VersioningSchemaSingleSelectionType"}]}],"description":"The versioning scheme used by images in the repository.\n\nA versioning schema is a system for identifying and organizing different versions of a project. \nIt is used to track changes and updates to the project over time, and to help users identify which version they are using. \nA versioning schema typically consists of a series of numbers or labels that are incremented to reflect the progression of versions. \nFor example, a versioning schema might use a series of numbers, such as \"1.0\", \"1.1\", \"2.0\", and so on, to indicate major and minor releases of a product. \nA consistent and well-defined versioning schema helps users and tools understand and track the development of a project.\n"},"VersioningSchemaCustomType":{"additionalProperties":false,"description":"The Custom Schema type is a way for Snyk to understand your company’s container image tag versioning scheme,\nenabling Snyk to give more accurate base image upgrade recommendations.\n\nThis schema type is essentially a regular expression that groups the different parts of an image’s tag into comparable sections.\n\nIf your container image's tags follow a versioning scheme other than Semantic Versioning (SemVer), \nit is highly recommended that you select the \"Custom Versioning\" schema for your image repositories.\n","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":"(?\u003cC0\u003e.)\\-(?\u003cM2\u003e.*)","type":"string"},"label":{"description":"A customizable string that can be set for a custom versioning schema to describe its meaning.\nThis label has no function.\n","example":"calendar with flavor schema","type":"string"},"type":{"enum":["custom"],"type":"string"}},"required":["type","expression"],"type":"object"},"VersioningSchemaSemverType":{"additionalProperties":false,"properties":{"type":{"enum":["semver"],"example":"semver","type":"string"}},"required":["type"],"type":"object"},"VersioningSchemaSingleSelectionType":{"additionalProperties":false,"description":"The Single Selection Versioning Schema allows manual setting of which image should be given as a recommendation.\n\nOnly one image can be set as the current recommendation. If no images are set as the current selection, \nno recommendation will be given.\n\nIt is recommended to use this versioning schema if your repository's tags aren't supported by the other schemas.\n","properties":{"is_selected":{"description":"Whether this image should be the recommendation. Only one image can be selected at a given time. Setting this\nas true will remove previous selection.\n","example":true,"type":"boolean"},"type":{"enum":["single-selection"],"example":"single-selection","type":"string"}},"required":["type","is_selected"],"type":"object"},"WorkloadAttributes":{"properties":{"required":{"properties":{"workload_internal_uri":{"type":"string"},"workload_type_id":{"format":"uuid","type":"string"}},"required":["workload_type_id","workload_internal_uri"],"type":"object"},"type":{"enum":["workload"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"YarnBuildArgs":{"additionalProperties":false,"properties":{"root_workspace":{"type":"string"}},"required":["root_workspace"],"type":"object"},"name":{"description":"User-defined name of the collection","maxLength":255,"minLength":1,"pattern":"^([a-zA-Z0-9 _\\-\\/:.])+$","type":"string"}},"securitySchemes":{"APIToken":{"description":"API key value must be prefixed with \\\"Token \\\".","in":"header","name":"Authorization","type":"apiKey"},"BearerAuth":{"scheme":"bearer","type":"http"},"bearerAuth":{"scheme":"bearer","type":"http"}}},"info":{"title":"Snyk API","version":"REST"},"openapi":"3.0.3","paths":{"/broker/legacy/{hashed_broker_token}/orgs":{"get":{"description":"Get orgs supported by legacy broker token","operationId":"getOrgsForLegacyBrokerToken","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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/parameters/HashedBrokerToken"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BrokerAttributes"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Return list of orgs for legacy broker token","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Get list of orgs supported by a legacy broker token","tags":["SnykLegacyBrokers"],"x-snyk-api-releases":["2023-12-14~experimental"],"x-snyk-api-version":"2023-12-14~experimental"},"x-snyk-api-resource":"brokers"},"/code_custom_rule_testing_sessions/repo/{org_id}/completions":{"post":{"description":"Receive auto completion suggestions for a code repository and query from a code custom rule playground session","operationId":"getRepoAutoCompletions","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":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/RepoQueryAttributes"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Snippet auto completions response object","properties":{"attributes":{"$ref":"#/components/schemas/AutoCompletionsResponseAttributes"}},"required":["attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Receive repo auto completions suggestions 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":"Receive auto completion suggestions for a code repository and query from a code custom rule playground session","tags":["CodeCustomRuleRepoTestingSession"],"x-snyk-api-releases":["2024-05-15~experimental"],"x-snyk-api-version":"2024-05-15~experimental"},"x-snyk-api-resource":"code_custom_rule_testing_sessions"},"/code_custom_rule_testing_sessions/repo/{org_id}/create":{"post":{"description":"Create a code custom rule playground session using a code repository","operationId":"createRepoIndex","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":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CreateRepoIndexAttributes"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Repo create index response object","properties":{"attributes":{"$ref":"#/components/schemas/CreateIndexResponseAttributes"}},"required":["attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Created repo index 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":"Create a code custom rule playground session using a code repository","tags":["CodeCustomRuleRepoTestingSession"],"x-snyk-api-releases":["2024-05-15~experimental"],"x-snyk-api-version":"2024-05-15~experimental"},"x-snyk-api-resource":"code_custom_rule_testing_sessions"},"/code_custom_rule_testing_sessions/repo/{org_id}/matches":{"post":{"description":"Receive matches for a query against a repository in a code custom rule playground session","operationId":"getRepoMatches","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":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/RepoQueryAttributes"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Repo matches response object","properties":{"attributes":{"$ref":"#/components/schemas/MatchesResponseAttributes"}},"required":["attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Receive repo matches 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":"Receive matches for a query against a repository in a code custom rule playground session","tags":["CodeCustomRuleRepoTestingSession"],"x-snyk-api-releases":["2024-05-15~experimental"],"x-snyk-api-version":"2024-05-15~experimental"},"x-snyk-api-resource":"code_custom_rule_testing_sessions"},"/code_custom_rule_testing_sessions/snippet/{org_id}/completions":{"post":{"description":"Receive auto completion suggestions for a code snippet and query from a code custom rule playground session","operationId":"getSnippetAutoCompletions","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":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SnippetQueryAttributes"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Snippet auto completions response object","properties":{"attributes":{"$ref":"#/components/schemas/AutoCompletionsResponseAttributes"}},"required":["attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Receive snippet auto completions suggestions 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":"Receive auto completion suggestions for a code snippet and query from a code custom rule playground session","tags":["CodeCustomRuleSnippetTestingSession"],"x-snyk-api-releases":["2024-05-15~experimental"],"x-snyk-api-version":"2024-05-15~experimental"},"x-snyk-api-resource":"code_custom_rule_testing_sessions"},"/code_custom_rule_testing_sessions/snippet/{org_id}/create":{"post":{"description":"Create a code custom rule playground session using a code snippet","operationId":"createSnippetIndex","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":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CreateSnippetIndexAttributes"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Snippet create index response object","properties":{"attributes":{"$ref":"#/components/schemas/CreateIndexResponseAttributes"}},"required":["attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Created snippet index 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":"Create a code custom rule playground session using a code snippet","tags":["CodeCustomRuleSnippetTestingSession"],"x-snyk-api-releases":["2024-05-15~experimental"],"x-snyk-api-version":"2024-05-15~experimental"},"x-snyk-api-resource":"code_custom_rule_testing_sessions"},"/code_custom_rule_testing_sessions/snippet/{org_id}/matches":{"post":{"description":"Receive matches for a query against a code snippet in a code custom rule playground session","operationId":"getSnippetMatches","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":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SnippetQueryAttributes"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Snippet matches response object","properties":{"attributes":{"$ref":"#/components/schemas/MatchesResponseAttributes"}},"required":["attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Receive snippet matches 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":"Receive matches for a query against a code snippet in a code custom rule playground session","tags":["CodeCustomRuleSnippetTestingSession"],"x-snyk-api-releases":["2024-05-15~experimental"],"x-snyk-api-version":"2024-05-15~experimental"},"x-snyk-api-resource":"code_custom_rule_testing_sessions"},"/custom_base_images":{"get":{"description":"Get a list of custom base images with support for ordering and filtering.\nEither the org_id or group_id parameters must be set to authorize successfully.\nIf sorting by version, the repository filter is required.\n","operationId":"getCustomBaseImages","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/ProjectId"},{"description":"The organization ID of the custom base image","in":"query","name":"org_id","schema":{"format":"uuid","type":"string"}},{"description":"The group ID of the custom base image","in":"query","name":"group_id","schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Repository"},{"$ref":"#/components/parameters/Tag"},{"$ref":"#/components/parameters/IncludeInRecommendations"},{"description":"Which column to sort by. \nIf sorting by version, the versioning schema is used.\n","in":"query","name":"sort_by","schema":{"enum":["repository","tag","version"],"type":"string"}},{"$ref":"#/components/parameters/SortDirection"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImageCollectionResponse"}}},"description":"Returns custom base images","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 collection","tags":["Custom Base Images"],"x-snyk-api-releases":["2023-08-21","2023-09-20","2024-01-04","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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"}}},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"x-snyk-api-resource":"custombaseimages"},"/groups":{"get":{"description":"Returns a list of groups which a user is a member of","operationId":"listGroups","parameters":[{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Group"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of groups 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"}}},"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 all groups","tags":["Groups"],"x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-version":"2023-01-30~beta"},"x-snyk-api-resource":"groups"},"/groups/{group_id}":{"get":{"description":"Returns a group by its ID","operationId":"getGroup","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Group"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Group 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"}}},"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","tags":["Groups"],"x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-version":"2023-01-30~beta"},"x-snyk-api-resource":"groups"},"/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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get a list of apps installed for a group.","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 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Filter logs by user ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"user_id","schema":{"format":"uuid","type":"string"}},{"description":"Filter logs by project ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},{"$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":{"$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 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}/cloud_events/app_authorizations":{"get":{"description":"Cloud Events supports multiple integrations, each of which is implemented as a separate Snyk App. This endpoint returns an array of authorization data objects for each app/integration type which has been authorized for this group.","operationId":"getGroupAppAuthorizations","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AppAuthorizationData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns app authorization data for each app authorized for 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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a list of Cloud Events apps authorized for the given group.","tags":["Cloud Events App Authorizations"],"x-snyk-api-releases":["2023-07-31~experimental"],"x-snyk-api-version":"2023-07-31~experimental"},"x-snyk-api-resource":"appauthorizations"},"/groups/{group_id}/cloud_events/group_registrations":{"get":{"description":"List all group registrations for the given group.","operationId":"listGroupRegistrations","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupRegistrationData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of cloud event forwarding registrations for the given 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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List all group registrations for the given group.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"post":{"description":"Create a new group cloud-events registration.","operationId":"createGroupRegistration","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":{"properties":{"data":{"properties":{"attributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"},{"$ref":"#/components/schemas/EventBridgeConfigRequest"},{"$ref":"#/components/schemas/SecurityCommandCenterConfigRequest"}]},"credentials":{"description":"Optional credentials used to authenticate with external systems.","type":"string"},"name":{"description":"A name for users to more easily identify this registration.","type":"string"},"type":{"$ref":"#/components/schemas/GroupRegistrationType"}},"required":["name","type","config"],"type":"object"},"type":{"type":"string"}},"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Created registration 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":"Create a new group registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"x-snyk-api-resource":"registrations"},"/groups/{group_id}/cloud_events/group_registrations/{group_registration_id}":{"delete":{"description":"Delete a group registration","operationId":"deleteGroupRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/GroupRegistrationId"}],"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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a group registration","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"get":{"description":"Get a group registration.","operationId":"getGroupRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/GroupRegistrationId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returns the requested registration.","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 group registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"patch":{"description":"Update a group registration.","operationId":"updateGroupRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/GroupRegistrationId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"},{"$ref":"#/components/schemas/EventBridgeConfigRequest"},{"$ref":"#/components/schemas/SecurityCommandCenterConfigRequest"}]},"credentials":{"description":"Optional credentials used to authenticate with external systems.","type":"string"},"disabled":{"type":"boolean"},"name":{"type":"string"}},"required":["config"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["group_registration"],"type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Updated registration 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":"Update a group registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"x-snyk-api-resource":"registrations"},"/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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/PathIssueId20240123"}],"responses":{"200":{"$ref":"#/components/responses/GetIssue20020240123"},"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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}/memberships":{"get":{"description":"Returns all memberships of the group","operationId":"listGroupMemberships","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/SortBy"},{"$ref":"#/components/parameters/SortOrder"},{"$ref":"#/components/parameters/EmailFilter"},{"$ref":"#/components/parameters/UserIdFilter"},{"$ref":"#/components/parameters/UsernameFilter"},{"$ref":"#/components/parameters/RoleFilter"},{"$ref":"#/components/parameters/IncludeGroupMembershipCount"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupMembershipResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of group memberships 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"}}},"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 all memberships of the group","tags":["Groups"],"x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-version":"2024-05-09~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"post":{"description":"Create a group membership for a user with role","operationId":"createGroupMembership","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateGroupMembershipRequestBody"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupMembership"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Membership for the group was 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"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a group membership for a user with role","tags":["Groups"],"x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-version":"2024-05-09~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"x-snyk-api-resource":"groups"},"/groups/{group_id}/memberships/{membership_id}":{"delete":{"description":"Deletes a membership from a group","operationId":"deleteGroupMembership","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/MembershipId"},{"$ref":"#/components/parameters/Cascade"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"group membership is deleted from 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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a membership from a group","tags":["Groups"],"x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-version":"2024-05-09~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"patch":{"description":"Update a role from a group membership","operationId":"updateGroupUserMembership","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/MembershipId"},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/MembershipPatchRequestBody"}},"type":"object"}}}},"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":"Update a role from a group membership","tags":["Groups"],"x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-version":"2024-05-09~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"x-snyk-api-resource":"groups"},"/groups/{group_id}/org_memberships":{"get":{"description":"Get list of org memberships of a group user","operationId":"listGroupUserOrgMemberships","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/UserId"},{"$ref":"#/components/parameters/OrgName"},{"$ref":"#/components/parameters/RoleName"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupMembershipOrgMembership"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"properties":{"org_membership_count":{"description":"Org memberships for this user within this group.","type":"number"}},"type":"object"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of groups 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"}}},"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 list of org memberships of a group user","tags":["Groups"],"x-snyk-api-releases":["2024-05-07~experimental","2024-08-25"],"x-snyk-api-version":"2024-05-07~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"x-snyk-api-resource":"groups"},"/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":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"access_requests_enabled":{"description":"Whether the organization permits access requests from users who are not members of the organization.","example":false,"type":"boolean"},"created_at":{"description":"The time the organization was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"group_id":{"description":"The Snyk ID of the group to which the organization belongs.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"is_personal":{"description":"Whether the organization is independent (that is, not part of a group).","example":true,"type":"boolean"},"name":{"description":"The display name of the organization.","example":"My Org","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the organization.","example":"my-org","type":"string"},"updated_at":{"description":"The time the organization was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","is_personal"],"type":"object"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"type":{"example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id","attributes"],"type":"object"},"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":{"$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}/packages":{"get":{"description":"Package information sent to this endpoint is used to power Snyk upgrade pull requests.","operationId":"getPackages","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PackageNamespace"},{"$ref":"#/components/parameters/PackageName"},{"$ref":"#/components/parameters/PackageType"},{"$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":{"additionalProperties":false,"items":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PackageAttributes"},"id":{"$ref":"#/components/schemas/PackageUrl"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Package information accepted 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":{"$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 published version of a software package.","tags":["Package"],"x-snyk-api-releases":["2024-02-26~experimental"],"x-snyk-api-version":"2024-02-26~experimental"},"post":{"description":"Package information sent to this endpoint is used to power Snyk upgrade pull requests.","operationId":"createPackage","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"description":"The name of the package. Note namespace is a separate property.","example":"logging","type":"string"},"namespace":{"description":"Some name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization","example":"org.example","type":"string"},"published_date":{"description":"The date the package was published in YYYY-MM-DDTHH:mm:ssZ format. For example midnight on the 1st July 2021 would be written 2021-07-01T00:00:00Z.","example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"type":{"description":"The package \"type\" or package \"protocol\" such as maven, npm, nuget, gem, pypi, etc.","example":"maven","type":"string"},"version":{"description":"The version of the package","example":"1.2.3","type":"string"}},"required":["name","version","type"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Package response","properties":{"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Package information accepted 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":{"$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":"Send Snyk information about a software package.","tags":["Package"],"x-snyk-api-releases":["2023-11-20~experimental"],"x-snyk-api-version":"2023-11-20~experimental"},"x-snyk-api-resource":"packages"},"/groups/{group_id}/packages/recommended_version":{"get":{"description":"Resolves the recommended version for a software package based on current version and the major version policy.","operationId":"getPackageRecommendedVersion","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PackageNamespace"},{"$ref":"#/components/parameters/PackageName"},{"$ref":"#/components/parameters/PackageType"},{"$ref":"#/components/parameters/PackageVersion"},{"$ref":"#/components/parameters/MajorVersionPolicy"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Recommended package release information response","properties":{"attributes":{"$ref":"#/components/schemas/PackageAttributes"},"id":{"$ref":"#/components/schemas/PackageUrl"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Recommended package release information.","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"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get version recommendation about a software package.","tags":["Package"],"x-snyk-api-releases":["2024-02-26~experimental"],"x-snyk-api-version":"2024-02-26~experimental"},"x-snyk-api-resource":"packages"},"/groups/{group_id}/packages/recommended_versions":{"get":{"description":"Resolves the recommended version for a software package based on current version and the major version policy.","operationId":"getGroupPackageRecommendedVersions","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","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"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetRecommendedVersionsRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"additionalProperties":false,"description":"Recommended package release information response","properties":{"attributes":{"$ref":"#/components/schemas/RecommendedVersionAttributes"},"id":{"$ref":"#/components/schemas/PackageUrl"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Recommended package release information.","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"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get version recommendation about a software package.","tags":["Package"],"x-snyk-api-releases":["2024-02-26~experimental"],"x-snyk-api-version":"2024-02-26~experimental"},"x-snyk-api-resource":"packages"},"/groups/{group_id}/policies/code_security":{"get":{"description":"Get a list of a group's Code policies.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"getGroupsCodeSecurityPolicies","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"The id of the group for which to return a list of policies","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/CodeSecurityPolicy"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of policies are returned for 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":"Get Code policies by group ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental"],"x-snyk-api-version":"2023-11-27~experimental"},"x-snyk-api-resource":"policies"},"/groups/{group_id}/policies/code_security/{policy_id}":{"get":{"description":"Get a specified code policy for a group.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"getGroupsCodeSecurityPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group from which to return the policy.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the policy to return","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CodeSecurityPolicy"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is found in 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":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get security policy by ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental"],"x-snyk-api-version":"2023-11-27~experimental"},"patch":{"description":"Update a code policy by ID.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n\n*Policy APIs Severity Condidtion Notice:* Use of `severity` as a\ncondition is currently restricted via a feature flag and will result in\na 400 Bad Request error without the flag enabled. Please contact your\naccount representative for eligibility requirements.\n","operationId":"updateGroupsCodeSecurityPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group containing the policy to update.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the policy to update.","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CodeSecurityPolicyUpdate"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CodeSecurityPolicy"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is successfully updated in 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":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a security policy by ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental"],"x-snyk-api-version":"2023-11-27~experimental"},"x-snyk-api-resource":"policies"},"/groups/{group_id}/policies/license":{"get":{"description":"Get a list of a group's license policies.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"getGroupsLicensePolicies","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"The id of the group for which to return a list of policies","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of policies are returned for 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":"Get license policies by group ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental"],"x-snyk-api-version":"2023-11-27~experimental"},"x-snyk-api-resource":"policies"},"/groups/{group_id}/policies/license/{policy_id}":{"get":{"description":"Get a specified license policy for a group.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"getGroupsLicensePolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group from which to return the policy.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the policy to return","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Policy"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is found in 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":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get license policy by ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental"],"x-snyk-api-version":"2023-11-27~experimental"},"patch":{"description":"Update a license policy by ID.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"updateGroupsLicensePolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group containing the policy to update.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the policy to update.","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolicyUpdate"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Policy"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is successfully updated in 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":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a license policy by ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental"],"x-snyk-api-version":"2023-11-27~experimental"},"x-snyk-api-resource":"policies"},"/groups/{group_id}/policies/security":{"get":{"description":"Get a list of a group's security policies.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"getGroupsSecurityPolicies","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"The id of the group for which to return a list of policies","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/SecurityPolicy"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of policies are returned for 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":"Get security policies by group ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental","2024-04-25~experimental"],"x-snyk-api-version":"2024-04-25~experimental"},"x-snyk-api-resource":"policies"},"/groups/{group_id}/policies/security/{policy_id}":{"get":{"description":"Get a specified security policy for a group.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"getGroupsSecurityPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group from which to return the policy.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the policy to return","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SecurityPolicy"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is found in 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":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get security policy by ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental","2024-04-25~experimental"],"x-snyk-api-version":"2024-04-25~experimental"},"patch":{"description":"Update a security policy by ID.\n\n*Policy APIs Access Notice:* Access to our Policy APIs is currently\nrestricted via a feature flag and will result in a 404 Not Found error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n\n*Policy APIs Severity Condidtion Notice:* Use of `severity` as a\ncondition is currently restricted via a feature flag and will result in\na 400 Bad Request error without the flag enabled. Please contact your\naccount representative for eligibility requirements.\n","operationId":"updateGroupsSecurityPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group containing the policy to update.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the policy to update.","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SecurityPolicyUpdate"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SecurityPolicy"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is successfully updated in 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":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a security policy by ID","tags":["Policies"],"x-snyk-api-releases":["2023-11-27~experimental","2024-04-25~experimental"],"x-snyk-api-version":"2024-04-25~experimental"},"x-snyk-api-resource":"policies"},"/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":{"items":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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":{"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.","format":"uuid","type":"string"}},"required":["name","auth_type","role_id"],"type":"object"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["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/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"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 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"}},{"$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":{"$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,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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"}],"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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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,"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":{"$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,"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":{"$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","x-snyk-resource-singleton":true},"/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"}},{"$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":"Delete 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"},"get":{"description":"Get your groups pull request template","operationId":"getPullRequestTemplate","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","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":{"properties":{"data":{"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/PaginatedLinks"}},"type":"object"}}},"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"},"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 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"}},{"$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":{"$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":"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"},"/groups/{group_id}/sso_connections":{"get":{"description":"Returns a list of SSO connections for a group","operationId":"listGroupSsoConnections","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SSOConnection"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of SSO connections 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"}}},"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 all SSO connections for a group","tags":["Groups"],"x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-version":"2023-01-30~beta"},"x-snyk-api-resource":"groups"},"/groups/{group_id}/sso_connections/{sso_id}/users":{"get":{"description":"Returns a list of users for a SSO connection","operationId":"listGroupSsoConnectionUsers","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/SsoId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of users 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"}}},"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 all users using a given SSO connection","tags":["Groups"],"x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-version":"2023-01-30~beta"},"x-snyk-api-resource":"groups"},"/groups/{group_id}/sso_connections/{sso_id}/users/{user_id}":{"delete":{"description":"Deletes a user from a Group SSO connection","operationId":"deleteUser","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/SsoId"},{"$ref":"#/components/parameters/UserId20230130"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"User is deleted from Group SSO connection","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 a user from a Group SSO connection","tags":["Groups"],"x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-version":"2023-01-30~beta"},"patch":{"description":"Updates a user from a Group SSO connection","operationId":"updateUserForSso","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/SsoId"},{"$ref":"#/components/parameters/UserId20230303"},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserActivePatchRequestBody"}},"type":"object"}}}},"responses":{"204":{"description":"User from Group SSO connection 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"}}},"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 user from a Group SSO connection","tags":["Groups"],"x-snyk-api-releases":["2023-03-03~experimental"],"x-snyk-api-version":"2023-03-03~experimental"},"x-snyk-api-resource":"groups"},"/groups/{group_id}/users/{id}":{"patch":{"description":"Update a user's membership of the group.\n\nTo remove a user's membership, provide 'null' as the membership parameter (see example).\n\nAt present, only removing memberships is supported by this endpoint. To update a user's group membership, please use\nthe UI or legacy API.\n","operationId":"updateUser","parameters":[{"description":"The id of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the user","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"membership":null},"id":"55a348e2-c3ad-4bbc-b40e-9b232d1f4122","type":"user"}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserPatchRequestBody"}},"type":"object"}}}},"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":"Update a user's role in a group","tags":["Users"],"x-snyk-api-releases":["2022-10-06~beta"],"x-snyk-api-version":"2022-10-06~beta"},"x-snyk-api-resource":"users"},"/learn/catalog":{"get":{"description":"List Snyk Learn's catalog resources","operationId":"listLearnCatalog","parameters":[{"$ref":"#/components/parameters/ApiVersion"},{"$ref":"#/components/parameters/ContentSource"},{"$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/EducationResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","links","jsonapi"],"type":"object"}}},"description":"Returns a list of catalog resources","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":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List Snyk Learn's resources","tags":["Catalog Resource"],"x-snyk-api-releases":["2024-05-13~experimental","2024-10-13~beta"],"x-snyk-api-version":"2024-05-13~experimental","x-snyk-deprecated-by":"2024-10-13~beta","x-snyk-sunset-eligible":"2024-10-14"},"x-snyk-api-resource":"catalog"},"/learn/catalog/{resource_id}":{"get":{"description":"Retrieve a single record from Snyk Learn catalog resources","operationId":"getSingleLearnCatalogResource","parameters":[{"$ref":"#/components/parameters/ApiVersion"},{"$ref":"#/components/parameters/ResourceId"},{"$ref":"#/components/parameters/ContentSource"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/EducationResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","links","jsonapi"],"type":"object"}}},"description":"Returns a single catalog resource record","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":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieve single Snyk Learn resource","tags":["Catalog Resource"],"x-snyk-api-releases":["2024-05-13~experimental"],"x-snyk-api-version":"2024-05-13~experimental"},"x-snyk-api-resource":"catalog"},"/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"}}},"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 list of organizations you have access to.","operationId":"getOrgs","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Public ID of a group to filter requested orgs by","in":"query","name":"group_id","schema":{"format":"uuid","type":"string"}},{"description":"A boolean for filtering by personal org","in":"query","name":"is_personal","schema":{"type":"boolean"}},{"description":"Slug of an org to filter orgs by","in":"query","name":"slug","schema":{"type":"string"}}],"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/Links"}},"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-02-16~experimental","2022-04-06~experimental"],"x-snyk-api-version":"2022-04-06~experimental"},"x-snyk-api-resource":"orgs"},"/orgs/{org_id}":{"get":{"description":"Returns an org by its ID","operationId":"getOrg","parameters":[{"description":"The ID of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Org"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Org 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"}}},"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 org","tags":["Orgs"],"x-snyk-api-releases":["2022-02-16~experimental","2022-04-06~experimental","2022-12-15~beta"],"x-snyk-api-version":"2022-12-15~beta"},"patch":{"description":"Update the details of an organization","operationId":"updateOrg","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/PathOrgId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgUpdateAttributes"},"id":{"description":"The ID of the resource.","format":"uuid","type":"string"},"type":{"description":"The type of the resource.","enum":["org"],"example":"org","type":"string"}},"required":["id","type","attributes"],"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":{"enum":["org"],"example":"org","type":"string"}},"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","2024-02-28"],"x-snyk-api-version":"2024-02-28"},"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":"Organization 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":"Organization 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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/AppData20220311"},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/AppPostRequest20220311"}}},"description":"app to be created"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostResponse20220311"}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/AppId"},{"$ref":"#/components/parameters/Version"}],"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 requested 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret"},"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"}},"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Revoke app authorization for an Snyk Organization 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"},"/orgs/{org_id}/apps/installs/{install_id}/secrets":{"post":{"description":"Manage client secret for non-interactive Snyk App installations.","operationId":"updateOrgAppInstallSecret","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ClientId"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"The requested 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ClientId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPatchRequest20220311"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData20220311"},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$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,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret20220311"},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Filter logs by user ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"user_id","schema":{"format":"uuid","type":"string"}},{"description":"Filter logs by project ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},{"$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}/cloud/environments":{"get":{"description":"List environments for an organization","operationId":"listEnvironments","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Return environments created after this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},{"description":"Return environments created before this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},{"description":"Return environments updated after this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"updated_after","schema":{"format":"date-time","type":"string"}},{"description":"Return environments updated before this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"updated_before","schema":{"format":"date-time","type":"string"}},{"$ref":"#/components/parameters/NameInQuery"},{"$ref":"#/components/parameters/KindInQuery"},{"$ref":"#/components/parameters/StatusInQuery"},{"$ref":"#/components/parameters/IdInQuery"},{"description":"Filter environments by project ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentAttributes"},"id":{"description":"Environment ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/EnvironmentRelationships"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of environments","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":"List Environments","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-version":"2023-10-19~beta"},"post":{"description":"Create a new environment and run a scan","operationId":"createEnvironment","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentCreateAttributes"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Environment resource object","properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentAttributes"},"id":{"description":"Environment ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/EnvironmentRelationships"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}}}}},"description":"Created environment 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":"Create New Environment","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-version":"2023-10-19~beta"},"x-snyk-api-resource":"environments"},"/orgs/{org_id}/cloud/environments/{environment_id}":{"delete":{"description":"Delete an environment","operationId":"deleteEnvironment","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/EnvironmentId"}],"responses":{"204":{"description":"Returns an empty response","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":"Delete Environment","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-version":"2023-10-19~beta"},"patch":{"description":"Update an environment","operationId":"updateEnvironment","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/EnvironmentId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentUpdateAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"environment resource object","properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/EnvironmentRelationships"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Updated an environment 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":{"$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 Environment","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-version":"2023-10-19~beta"},"x-snyk-api-resource":"environments"},"/orgs/{org_id}/cloud/permissions":{"post":{"description":"Generate IAC template for Snyk to access your cloud resources","operationId":"getPermissions","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CreatePermissionsAttributes"},"type":{"example":"permission","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"permissions resource object","properties":{"attributes":{"$ref":"#/components/schemas/PermissionsAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"example":"permission","type":"string"}},"required":["attributes","id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}}}}},"description":"Created permissions 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":"Generate Cloud Provider Permissions","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-version":"2023-10-19~beta"},"x-snyk-api-resource":"permissions"},"/orgs/{org_id}/cloud/resources":{"get":{"description":"List resources for an organization","operationId":"listResources","parameters":[{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/EnvironmentIdQuery"},{"$ref":"#/components/parameters/ResourceType"},{"description":"Filter resources by resource ID (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"resource_id","schema":{"type":"string"},"style":"form"},{"$ref":"#/components/parameters/NativeId"},{"$ref":"#/components/parameters/Id"},{"description":"Filter resources by platform (multi-value, comma-separated): aws","example":"aws","explode":false,"in":"query","name":"platform","schema":{"type":"string"},"style":"form"},{"$ref":"#/components/parameters/Name"},{"$ref":"#/components/parameters/Kind"},{"$ref":"#/components/parameters/Location"},{"$ref":"#/components/parameters/Removed"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/ResourceAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ResourceRelationships"},"type":{"example":"resource","type":"string"}},"required":["id","type"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of resources","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":"List Resources","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-version":"2023-10-19~beta"},"x-snyk-api-resource":"resources"},"/orgs/{org_id}/cloud/rule_bundles":{"get":{"description":"Retrieve organization custom rules as a bundle","operationId":"getOrganizationRuleBundles","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RuleBundle"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"This endpoint returns a listing of rule bundles.","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":"Retrieve custom rule bundles","tags":["Cloud"],"x-snyk-api-releases":["2023-05-22~experimental"],"x-snyk-api-version":"2023-05-22~experimental"},"post":{"description":"Upload a custom rule bundle","operationId":"createCustomRules","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RuleBundle"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Uploaded custom rule bundle 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":"Upload a custom rule bundle","tags":["Cloud"],"x-snyk-api-releases":["2023-05-22~experimental"],"x-snyk-api-version":"2023-05-22~experimental"},"x-snyk-api-resource":"customrules"},"/orgs/{org_id}/cloud/rule_bundles/{rule_bundle_id}":{"delete":{"description":"Delete custom rules","operationId":"deleteCustomRules","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/RuleBundleId"}],"responses":{"204":{"description":"Returns an empty response","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 custom rules","tags":["Cloud"],"x-snyk-api-releases":["2023-05-22~experimental"],"x-snyk-api-version":"2023-05-22~experimental"},"patch":{"description":"Update custom rules","operationId":"updateCustomRules","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/RuleBundleId"}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RuleBundle"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns the updated custom rule","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":"Update custom rules","tags":["Cloud"],"x-snyk-api-releases":["2023-05-22~experimental"],"x-snyk-api-version":"2023-05-22~experimental"},"x-snyk-api-resource":"customrules"},"/orgs/{org_id}/cloud/scans":{"get":{"description":"List scans for an organization","operationId":"listScan","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/ScanAttributes"},"id":{"description":"Scan ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ScanRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["id","type"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of scan 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":{"$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 Scans","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta"],"x-snyk-api-version":"2022-12-21~beta"},"post":{"description":"Create and trigger a new scan for an environment","operationId":"createScan","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ScanCreateAttributes"},"relationships":{"$ref":"#/components/schemas/ScanCreateRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Scan resource object","properties":{"attributes":{"$ref":"#/components/schemas/ScanAttributes"},"id":{"description":"Scan ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ScanRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}}}}},"description":"Created scan 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":"Create Scan","tags":["Cloud"],"x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta"],"x-snyk-api-version":"2022-12-21~beta"},"x-snyk-api-resource":"scans"},"/orgs/{org_id}/cloud/scans/{scan_id}":{"get":{"description":"Get a single scan for an organization","operationId":"getScan","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ScanId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/ScanAttributes"},"id":{"description":"Scan ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ScanRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a single scan instance","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 scan","tags":["Cloud"],"x-snyk-api-releases":["2022-12-21~beta"],"x-snyk-api-version":"2022-12-21~beta"},"x-snyk-api-resource":"scans"},"/orgs/{org_id}/cloud_events/app_authorizations":{"get":{"description":"Cloud Events supports multiple integrations, each of which is implemented as a separate Snyk App. This endpoint returns an array of authorization data objects for each integration type which has been authorized for this org.","operationId":"getOrgAppAuthorizations","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"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AppAuthorizationData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns authorization data for each integration authorized for 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":{"$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 Cloud Events apps auhtorized for the given org.","tags":["Cloud Events App Authorizations"],"x-snyk-api-releases":["2023-07-31~experimental"],"x-snyk-api-version":"2023-07-31~experimental"},"x-snyk-api-resource":"appauthorizations"},"/orgs/{org_id}/cloud_events/org_registrations":{"get":{"description":"List all org registrations for the given org.","operationId":"listOrgRegistrations","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization 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"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgRegistrationData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of cloud event forwarding registrations for the given 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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List all org registrations for the given org.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"post":{"description":"Create a new org cloud-events registration.","operationId":"createOrgRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"},{"$ref":"#/components/schemas/EventBridgeConfigRequest"}]},"name":{"description":"A name for users to more easily identify this registration.","type":"string"},"type":{"$ref":"#/components/schemas/RegistrationType"}},"required":["name","type","config"],"type":"object"},"type":{"type":"string"}},"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Created registration 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":"Create a new org registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"x-snyk-api-resource":"registrations"},"/orgs/{org_id}/cloud_events/org_registrations/{org_registration_id}":{"delete":{"description":"Delete an org registration","operationId":"deleteOrgRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgRegistrationId"}],"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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete an org registration","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"get":{"description":"Get a registration.","operationId":"getOrgRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgRegistrationId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returns the requested registration.","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 an org registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"patch":{"description":"Update an org registration.","operationId":"updateOrgRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgRegistrationId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"}]},"disabled":{"type":"boolean"},"name":{"type":"string"}},"required":["config"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["org_registration"],"type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Updated registration 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":"Update an org registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"x-snyk-api-resource":"registrations"},"/orgs/{org_id}/cloud_events/org_registrations/{org_registration_id}/project_registrations":{"get":{"description":"List project registrations for the given org registration.","operationId":"listProjectRegistrations","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgRegistrationId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectRegistrationData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of project registrations related to the given org registration.","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":"List project registrations for the given org registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"post":{"description":"Create a new project registration.","operationId":"createProjectRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgRegistrationId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"}]},"name":{"description":"A name for users to more easily identify this registration.","type":"string"},"org_registration_id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"project_id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/RegistrationType"}},"required":["org_registration_id","name","type","config"],"type":"object"},"type":{"type":"string"}},"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ProjectRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Created registration 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":"Create a new project registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"x-snyk-api-resource":"registrations"},"/orgs/{org_id}/cloud_events/org_registrations/{org_registration_id}/project_registrations/{project_registration_id}":{"delete":{"description":"Delete a project registration","operationId":"deleteProjectRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgRegistrationId"},{"$ref":"#/components/parameters/ProjectRegistrationId"}],"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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a project registration","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"patch":{"description":"Update a project registration.","operationId":"updateProjectRegistration","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgRegistrationId"},{"$ref":"#/components/parameters/ProjectRegistrationId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"}]},"disabled":{"type":"boolean"}},"required":["config"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["project_registration"],"type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ProjectRegistrationData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Updated registration 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":"Update a project registration.","tags":["Cloud Events Registration"],"x-snyk-api-releases":["2023-01-25~experimental"],"x-snyk-api-version":"2023-01-25~experimental"},"x-snyk-api-resource":"registrations"},"/orgs/{org_id}/code_issue_details/{issue_id}":{"get":{"description":"This resource represents detailed information on an issue found by Snyk Code. This resource only contains issues of this type (Snyk Code); details for other issue types will need to be requested from their respective resources.\n","operationId":"getCodeIssueDetails","parameters":[{"description":"The ID of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Code issue ID","in":"path","name":"issue_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the project which contains the issue","in":"query","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CodeIssue"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Code issue 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"}}},"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 Snyk Code Issue by its ID","tags":["Issues"],"x-snyk-api-releases":["2023-03-08~experimental","2023-08-29~experimental"],"x-snyk-api-version":"2023-08-29~experimental"},"x-snyk-api-resource":"code_issues"},"/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","tags":["Collection"],"x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-version":"2023-09-12"},"post":{"description":"Create a collection","operationId":"createCollection","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/CreateCollectionRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"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"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned 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"},"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 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":{"properties":{"data":{"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"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned 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"},"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 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":{"properties":{"data":{"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"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned 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"},"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"},"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":"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"}}},"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":{"$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"}}}},"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"},"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":"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}/collections/{collection_id}/sbom":{"get":{"description":"This endpoint lets you retrieve the SBOM document of a project collection.\nIt supports the following formats:\n* CycloneDX version 1.5 in JSON (set `format` to `cyclonedx1.5+json`).\n* CycloneDX version 1.5 in XML (set `format` to `cyclonedx1.5+xml`).\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.\nThe SBOM will include all Container and Open Source projects; Snyk Code and Infrastructure as Code projects will be omitted.","operationId":"getCollectionSbom","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/CollectionId"},{"$ref":"#/components/parameters/Format20231219"},{"$ref":"#/components/parameters/Exclude"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SbomResponse"}},"application/vnd.cyclonedx+json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.cyclonedx+xml":{"schema":{"$ref":"#/components/schemas/SbomDocument"}}},"description":"Returns the SBOM document of a 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":{"$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’s SBOM document","tags":["SBOM"],"x-snyk-api-releases":["2023-12-19~experimental"],"x-snyk-api-version":"2023-12-19~experimental"},"x-snyk-api-resource":"sboms","x-snyk-resource-singleton":true},"/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":{"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":{"$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/ImageId20231102"}],"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":{"$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","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/ImageId20231102"},{"$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":{"$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}/ignores":{"get":{"description":"⚠️ _This endpoint currently only lists ignores for Snyk Cloud Scan Items._\nList all ignores for an org, scan item and/or issue.","operationId":"listIgnores","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/ScanItemIds"},{"$ref":"#/components/parameters/ScanItemTypes"},{"$ref":"#/components/parameters/VulnerabilityId"},{"$ref":"#/components/parameters/IssueKey"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Ignore"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Returns a list of ignores","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"List all ignores for an org, scan item and/or issue","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~wip","2023-12-20~experimental"],"x-snyk-api-version":"2023-12-20~experimental"},"post":{"description":"⚠️ _This endpoint currently only creates ignores for Snyk Cloud Scan Items._\nAdd an ignore rule to a scan item and create the corresponding ignore.","operationId":"createIgnore","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IgnoreCreateBody"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Ignore"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["jsonapi","data","links"]}}},"description":"Created ignore successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"uri","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Add an ignore rule to a scan item and create the corresponding ignore.","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~wip","2023-06-22~experimental","2023-12-20~experimental"],"x-snyk-api-version":"2023-12-20~experimental"},"x-snyk-api-resource":"ignores"},"/orgs/{org_id}/ignores/{ignore_id}":{"delete":{"description":"⚠️ _This endpoint currently only deletes ignores for Snyk Cloud Scan Items._\nDelete ignore, which maps to exactly one ignore rule","operationId":"deleteIgnore","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/IgnoreId"}],"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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Delete ignore","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~wip","2023-12-20~experimental"],"x-snyk-api-version":"2023-12-20~experimental"},"get":{"description":"⚠️ _This endpoint currently only gets ignores for Snyk Cloud Scan Items._\nGet an ignore","operationId":"getIgnore","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/IgnoreId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Ignore"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["jsonapi","data"]}}},"description":"Returns an instance of an ignore","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"uri","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get an ignore","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~wip","2023-12-20~experimental"],"x-snyk-api-version":"2023-12-20~experimental"},"patch":{"description":"⚠️ _This endpoint currently only updates ignores for Snyk Cloud Scan Items._\nUpdate an ignore, which maps to exactly one ignore rule","operationId":"updateIgnore","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/IgnoreId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IgnoreUpdateBody20231220"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Ignore"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"A single ignore rule associated to the provided organization and ignore.","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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Update an ignore","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~wip","2023-06-22~experimental","2023-12-20~experimental"],"x-snyk-api-version":"2023-12-20~experimental"},"x-snyk-api-resource":"ignores"},"/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":{"$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/OrgInvitation20240621"},"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","2024-06-21"],"x-snyk-api-version":"2024-06-21"},"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"}},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/detail/code/{issue_id}":{"get":{"description":"This resource represents detailed information on an issue found by Snyk Code. This resource only contains issues of this type (Snyk Code); details for other issue types will need to be requested from their respective resources.\n","operationId":"getCodeIssue","parameters":[{"description":"The ID of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Code issue ID","in":"path","name":"issue_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the project which contains the issue","in":"query","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CodeIssue20210813"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","data"],"type":"object"}}},"description":"Code issue 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"}}},"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 Snyk Code Issue by its ID","tags":["Issues"],"x-snyk-api-releases":["2021-08-13~experimental"],"x-snyk-api-version":"2021-08-13~experimental"},"x-snyk-api-resource":"code_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/PathIssueId20240123"}],"responses":{"200":{"$ref":"#/components/responses/GetIssue20020240123"},"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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}/memberships":{"get":{"description":"Returns all memberships of the org","operationId":"listOrgMemberships","parameters":[{"description":"The ID of the org","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"},{"description":"Which column to sort by.","in":"query","name":"sort_by","schema":{"enum":["username","user_display_name","email","login_method","role"],"type":"string"}},{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}},{"$ref":"#/components/parameters/EmailFilter"},{"$ref":"#/components/parameters/UserIdFilter"},{"$ref":"#/components/parameters/UsernameFilter"},{"$ref":"#/components/parameters/RoleFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgMembershipResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of org memberships 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"}}},"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 all memberships of the org","tags":["Orgs"],"x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-version":"2024-05-09~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"post":{"description":"Create a org membership for a user with role","operationId":"createOrgMembership","parameters":[{"description":"The ID of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateOrgMembershipRequestBody"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgMembership"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Membership for the user is created on the org","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 org membership for a user with role","tags":["Orgs"],"x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-version":"2024-05-09~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"x-snyk-api-resource":"orgs"},"/orgs/{org_id}/memberships/{membership_id}":{"delete":{"description":"Remove a user's membership of the group.\n","operationId":"deleteOrgMembership","parameters":[{"description":"The id of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgMembershipId"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"Org membership for the user was successfully 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":"Remove user's org membership","tags":["OrgMemberships"],"x-snyk-api-releases":["2024-06-06~experimental","2024-08-25"],"x-snyk-api-version":"2024-06-06~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"patch":{"description":"Update a org membership for a user with role","operationId":"updateOrgMembership","parameters":[{"description":"The id of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgMembershipId"},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UpdateOrgMembershipRequestBody"}},"type":"object"}}}},"responses":{"204":{"description":"The Membership 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"}}},"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 a org membership for a user with role","tags":["OrgMemberships"],"x-snyk-api-releases":["2024-06-06~experimental","2024-08-25"],"x-snyk-api-version":"2024-06-06~experimental","x-snyk-deprecated-by":"2024-08-25","x-snyk-sunset-eligible":"2024-08-26"},"x-snyk-api-resource":"org_memberships"},"/orgs/{org_id}/moves":{"get":{"description":"Retrieve a paginated list of the moves that have been requested and enacted for the identified org, optionally filtered by status.","operationId":"listOrgMove","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$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/MoveAttributes"},"id":{"description":"The public ID of the org move","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/MoveRelationships"},"type":{"$ref":"#/components/schemas/MoveType"}},"required":["id","type","attributes"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Returns a list of enacted org moves.","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":"Retrieve a paginated list of the moves that have been requested and enacted for the identified org, optionally filtered by status.","tags":["Org Move"],"x-snyk-api-releases":["2022-12-12~experimental"],"x-snyk-api-version":"2022-12-12~experimental"},"post":{"description":"Initiates the process of moving the identified org to be the child of another group. Note that this operation is irreversible, and existing org memberships, project tags and service accounts on the org will be lost.","operationId":"createOrgMove","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/MoveOrgRequestData"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/MoveAttributes"},"id":{"description":"The public ID of the org move","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/MoveType"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Org move was successfully initialized.","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":"Move an org from one group to another","tags":["Org Move"],"x-snyk-api-releases":["2022-12-12~experimental"],"x-snyk-api-version":"2022-12-12~experimental"},"x-snyk-api-resource":"moves"},"/orgs/{org_id}/moves/{move_id}":{"get":{"description":"Obtain information about an identified org move.","operationId":"getOrgMove","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/MoveId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/MoveAttributes"},"id":{"description":"The public ID of the org move","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/MoveRelationships"},"type":{"$ref":"#/components/schemas/MoveType"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Returns a single enacted org move.","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":"Obtain information about an identified org move.","tags":["Org Move"],"x-snyk-api-releases":["2022-12-12~experimental"],"x-snyk-api-version":"2022-12-12~experimental"},"x-snyk-api-resource":"moves"},"/orgs/{org_id}/packages/issues":{"post":{"description":"This endpoint is currently restricted and is not available to all customers. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned; transitive vulnerabilities (from dependencies) are not included as they can vary depending on the context.","operationId":"listIssuesForManyPurls","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"}],"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":{"$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)","tags":["Issues"],"x-snyk-api-releases":["2023-01-04~experimental","2023-03-29~beta","2023-04-17","2023-08-21","2024-06-26"],"x-snyk-api-version":"2024-06-26"},"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"},{"$ref":"#/components/parameters/OrgId"},{"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":{"$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","2024-06-26"],"x-snyk-api-version":"2024-06-26"},"x-snyk-api-resource":"issues"},"/orgs/{org_id}/policy_rules":{"post":{"description":"Create a new org level policy rule. The rule will be applied to the default org policy.\nIf the policy does not exist, it will be created.\n\n*Org level Policy APIs Access Notice:* Access to our Org level Policy APIs is currently\nrestricted via \"snykCodeConsistentIgnores\" feature flag and will result in a 403 Forbidden error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"createOrgPolicyRule","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of an org for which a new policy rule will be created.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Policy type, this API is only allowed for \"code\" policies at present.","in":"query","name":"policy_type","required":true,"schema":{"enum":["code"],"type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CreatePolicyRulePayload"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolicyRuleResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy rule is returned if it is successfully 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":"Create a new org level policy rule","tags":["Policy rules"],"x-snyk-api-releases":["2024-05-15~experimental"],"x-snyk-api-version":"2024-05-15~experimental"},"x-snyk-api-resource":"policy_rules"},"/orgs/{org_id}/policy_rules/{rule_id}":{"delete":{"description":"Delete an existing org level policy rule.\n\n*Org level Policy APIs Access Notice:* Access to our Org level Policy APIs is currently\nrestricted via \"snykCodeConsistentIgnores\" feature flag and will result in a 403 Forbidden error\nwithout the flag enabled. Please contact your account representative for\neligibility requirements.\n","operationId":"deleteOrgPolicyRule","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of an org for which a policy rule will be deleted.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the policy rule to delete.","in":"path","name":"rule_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"Confirmation that the policy rule 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 an org level policy rule","tags":["Policy rules"],"x-snyk-api-releases":["2024-06-18~experimental"],"x-snyk-api-version":"2024-06-18~experimental"},"x-snyk-api-resource":"policy_rules"},"/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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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.5 in JSON (set `format` to `cyclonedx1.5+json`).\n* CycloneDX version 1.5 in XML (set `format` to `cyclonedx1.5+xml`).\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"},{"$ref":"#/components/parameters/OrgId"},{"description":"Unique identifier for a project","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Format"},{"$ref":"#/components/parameters/Exclude"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SbomResponse"}},"application/vnd.cyclonedx+json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.cyclonedx+xml":{"schema":{"$ref":"#/components/schemas/SbomDocument"}}},"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","2024-08-15~beta","2024-08-22"],"x-snyk-api-version":"2024-03-12~experimental","x-snyk-deprecated-by":"2024-08-15~beta","x-snyk-sunset-eligible":"2024-08-16"},"x-snyk-api-resource":"sboms","x-snyk-resource-singleton":true},"/orgs/{org_id}/sbom_tests":{"post":{"description":"Create an SBOM test run by supplying an SBOM document. The components contained in the given document will get analyzed for known vulnerabilities. In order for component identification to be successful, they must have a PackageURL (purl) of a supported purl type assigned. Analysis will be skipped for any component that does not fulfill this requirement.\nSupported SBOM formats: CycloneDX 1.4 JSON, CycloneDX 1.5 JSON, CycloneDX 1.6 JSON, SPDX 2.3 JSON\nSupported purl types: apk, deb, cargo, cocoapods, composer, gem, generic, golang, hex, maven, npm, nuget, pypi, rpm, swift\n","operationId":"createSbomTestRun","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":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SbomTestCreateAttributes"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"SBOM test resource object","properties":{"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Created SBOM test 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":"Create an SBOM test run","tags":["SBOM"],"x-snyk-api-releases":["2023-06-02~experimental","2023-08-31~beta","2024-04-22~beta","2024-07-10~beta"],"x-snyk-api-version":"2024-04-22~beta","x-snyk-deprecated-by":"2024-07-10~beta","x-snyk-sunset-eligible":"2024-10-09"},"x-snyk-api-resource":"sbom_tests"},"/orgs/{org_id}/sbom_tests/{job_id}":{"get":{"description":"Get an SBOM test run status","operationId":"getSbomTestStatus","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/JobId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"description":"SBOM test resource object","properties":{"attributes":{"properties":{"status":{"enum":["processing","error","finished"],"type":"string"}},"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"SBOM test run status","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":"Gets an SBOM test run status","tags":["SBOM"],"x-snyk-api-releases":["2023-06-02~experimental","2023-08-31~beta","2024-04-22~beta","2024-07-10~beta"],"x-snyk-api-version":"2024-04-22~beta","x-snyk-deprecated-by":"2024-07-10~beta","x-snyk-sunset-eligible":"2024-10-09"},"x-snyk-api-resource":"sbom_tests"},"/orgs/{org_id}/sbom_tests/{job_id}/results":{"get":{"description":"Get an SBOM test run result","operationId":"getSbomTestResult","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/JobId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"SBOM test resource object","properties":{"attributes":{"$ref":"#/components/schemas/SbomTestResultsAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"properties":{"affected_packages":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ResourceReference"},"type":"array"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"included":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"SBOM test results","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"}}}},"summary":"Gets an SBOM test run result","tags":["SBOM"],"x-snyk-api-releases":["2023-06-02~experimental","2023-08-31~beta","2024-04-22~beta","2024-07-10~beta"],"x-snyk-api-version":"2024-04-22~beta","x-snyk-deprecated-by":"2024-07-10~beta","x-snyk-sunset-eligible":"2024-10-09"},"x-snyk-api-resource":"sbom_tests"},"/orgs/{org_id}/scans":{"post":{"description":"Scans take a workspace, run through all product lines, aggregating components, and serves them on demand later on","operationId":"createScanWorkspaceJobForUser","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}},{"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/PostScanRequest"}}},"description":"A workspace to be scanned"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ScanResponse"}}},"description":"Scan accepted, and scheduled to be processed","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"429":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Too many requests","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"security":[{"bearerAuth":[]}],"summary":"Scans a workspace and provides a scan URL that can be used to check status and results","tags":["Scan"],"x-snyk-api-releases":["2024-02-16~experimental"],"x-snyk-api-version":"2024-02-16~experimental"},"x-snyk-api-resource":"public"},"/orgs/{org_id}/scans/{scanjob_id}":{"get":{"description":"This endpoint returns the scan job result, including all components associated with this scan. Note that if the job is ongoing, partial results might be served.","operationId":"getScanWorkspaceJobForUser","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ScanJobId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ScanResultsResponse"}}},"description":"Scan job results including components collected for this scan job","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"429":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Too many requests","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"security":[{"bearerAuth":[]}],"summary":"Returns a single scan job result, including components associated with this scan job","tags":["Scan"],"x-snyk-api-releases":["2024-02-16~experimental"],"x-snyk-api-version":"2024-02-16~experimental"},"x-snyk-api-resource":"public"},"/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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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 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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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":{"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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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 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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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/code":{"get":{"description":"Retrieves the CODE settings for an org","operationId":"getCodeSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org for which we want to retrieve the CODE 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/CodeEnablement"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The CODE 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":{"$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 CODE settings for an org","tags":["CodeSettings"],"x-snyk-api-releases":["2023-09-13~experimental"],"x-snyk-api-version":"2023-09-13~experimental"},"patch":{"description":"Updates the Code settings for an org","operationId":"updateOrgCodeSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org for which we want to update the Code settings","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 setting for sastEnabled","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/CodeEnablement"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The Code 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":"Updates the Code settings for an org","tags":["CodeSettings"],"x-snyk-api-releases":["2023-09-14~experimental"],"x-snyk-api-version":"2023-09-14~experimental"},"x-snyk-api-resource":"code_settings","x-snyk-resource-singleton":true},"/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":{"$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":{"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":{"$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,"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":{"$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"}}},"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":{"$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","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":"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,"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":{"$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"},"patch":{"description":"Updates the Slack notifications default settings for an existing tenant.","operationId":"updateSlackDefaultSettings","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":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"severity_threshold":{"enum":["low","medium","high","critical"],"type":"string"},"target_channel":{"$ref":"#/components/schemas/TargetChannel"}},"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["slack"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Sets the default settings for an existing tenant"},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SlackDefaultSetting"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Default settings updated 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":{"$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":"Sets the default settings for an existing tenant.","tags":["SlackSettings"],"x-snyk-api-releases":["2022-11-07~experimental"],"x-snyk-api-version":"2022-11-07~experimental"},"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,"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":{"$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":{"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":{"$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"},"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":"Remove Slack settings override for a project.","tags":["SlackSettings"],"x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-version":"2022-12-14"},"patch":{"description":"Update Slack notification settings for a project.","operationId":"updateSlackProjectNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"},{"description":"Project ID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProjectSettingsPatchRequest"}}},"description":"Update existing project specific settings for a project."},"responses":{"200":{"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":"Slack notification settings for a project updated 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":{"$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"}},{"$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/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"},"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 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,"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":{"$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,"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":{"$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,"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"}}},"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","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"},{"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":{"$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,"properties":{"data":{"$ref":"#/components/schemas/PublicTarget"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single target is returned 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":{"$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"},"/orgs/{org_id}/targets/{target_id}/sbom":{"get":{"description":"This endpoint lets you retrieve the SBOM document of a target.\nIt supports the following formats:\n* CycloneDX version 1.5 in JSON (set `format` to `cyclonedx1.5+json`).\n* CycloneDX version 1.5 in XML (set `format` to `cyclonedx1.5+xml`).\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`).\nBy default it will respond with an empty JSON:API response.\nThe SBOM will include all Container and Open Source projects; Snyk Code and Infrastructure as Code projects will be omitted.","operationId":"getTargetSbom","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/TargetId"},{"$ref":"#/components/parameters/Format20231219"},{"$ref":"#/components/parameters/Exclude"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SbomResponse"}},"application/vnd.cyclonedx+json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.cyclonedx+xml":{"schema":{"$ref":"#/components/schemas/SbomDocument"}}},"description":"Returns the SBOM document of a target","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 target’s SBOM document","tags":["SBOM"],"x-snyk-api-releases":["2023-12-19~experimental"],"x-snyk-api-version":"2023-12-19~experimental"},"x-snyk-api-resource":"sboms","x-snyk-resource-singleton":true},"/orgs/{org_id}/tests":{"post":{"description":"Tests a git repository and provides a test URL that can be used to check state and results of the test","operationId":"createTest","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}},{"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/PostGitTestRequest"}}},"description":"The git repository to be scanned"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TestResponse"}}},"description":"Test accepted and queued for scheduling","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"422":{"$ref":"#/components/responses/422"},"429":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Too many requests","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"security":[{"bearerAuth":[]}],"summary":"Tests a git repository and provides a test URL that can be used to check state and results of the test","tags":["Test"],"x-snyk-api-releases":["2024-02-16~experimental"],"x-snyk-api-version":"2024-02-16~experimental"},"x-snyk-api-resource":"public"},"/orgs/{org_id}/tests/{test_id}":{"get":{"description":"This endpoint returns the result of a test","operationId":"getTestResult","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/TestId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TestResultResponse"}}},"description":"Test results including components collected from Snyk engines","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"422":{"$ref":"#/components/responses/422"},"429":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Too many requests","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"security":[{"bearerAuth":[]}],"summary":"Returns the results of a test result","tags":["Test"],"x-snyk-api-releases":["2024-02-16~experimental"],"x-snyk-api-version":"2024-02-16~experimental"},"x-snyk-api-resource":"public"},"/orgs/{org_id}/unmanaged_ecosystem/depgraphs":{"post":{"description":"Submit hashes for processing in order to create a DepGraph async","operationId":"createDepGraph","parameters":[{"description":"Org ID","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":{"hashes":{"items":{"properties":{"hashes_ffm":{"items":{"properties":{"data":{"type":"string"},"format":{"type":"number"}},"type":"object"},"type":"array"},"path":{"type":"string"},"size":{"type":"number"}},"type":"object"},"type":"array"}},"required":["hashes"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"dep graph return","properties":{"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"location":{"type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"properties":{"self":{"type":"string"}},"type":"object"}}}}},"description":"Returns the location of the processing task","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"The location of the processing task","example":"/unmanaged-ecosystems/depgraphs/1234567890","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":"Submit hashes for processing","tags":["Depgraphs"],"x-snyk-api-releases":["2022-05-23~experimental"],"x-snyk-api-version":"2022-05-23~experimental"},"x-snyk-api-resource":"depgraphs"},"/orgs/{org_id}/unmanaged_ecosystem/depgraphs/{task_id}":{"get":{"description":"Get a depgraph","operationId":"getDepGraph","parameters":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TaskId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DepGraphResponse"}}},"description":"Returns a depgraph","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 depgraph","tags":["Depgraphs"],"x-snyk-api-releases":["2022-05-23~experimental"],"x-snyk-api-version":"2022-05-23~experimental"},"x-snyk-api-resource":"depgraphs"},"/orgs/{org_id}/unmanaged_ecosystem/issues":{"post":{"description":"Send DepGraph to Phoenix to compute issues","operationId":"getIssues","parameters":[{"description":"Org ID","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":{"component_details":{"additionalProperties":{"properties":{"artifact":{"type":"string"},"author":{"type":"string"},"file_paths":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"path":{"type":"string"},"score":{"type":"number"},"url":{"type":"string"},"version":{"type":"string"}},"type":"object"},"type":"object"},"dep_graph":{"properties":{"graph":{"properties":{"nodes":{"items":{"properties":{"deps":{"items":{"properties":{"node_id":{"type":"string"}},"type":"object"},"type":"array"},"node_id":{"type":"string"},"pkg_id":{"type":"string"}},"type":"object"},"type":"array"},"root_node_id":{"type":"string"}},"type":"object"},"pkg_manager":{"properties":{"name":{"type":"string"}},"type":"object"},"pkgs":{"items":{"properties":{"id":{"type":"string"},"info":{"properties":{"name":{"type":"string"},"version":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"schema_version":{"type":"string"}},"type":"object"},"start_time":{"type":"number"},"target_severity":{"type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"meta":{"properties":{"ignore_settings":{"type":"boolean"},"is_licenses_enabled":{"type":"boolean"},"is_private":{"type":"boolean"},"org":{"type":"string"}},"type":"object"},"result":{"properties":{"dep_graph_data":{"properties":{"graph":{"properties":{"nodes":{"items":{"properties":{"deps":{"items":{"properties":{"node_id":{"type":"string"}},"type":"object"},"type":"array"},"node_id":{"type":"string"},"pkg_id":{"type":"string"}},"type":"object"},"type":"array"},"root_node_id":{"type":"string"}},"type":"object"},"pkg_manager":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"pkgs":{"items":{"properties":{"id":{"type":"string"},"info":{"properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"type":"object"}},"required":["id","info"],"type":"object"},"type":"array"},"schema_version":{"type":"string"}},"type":"object"},"deps_file_paths":{"additionalProperties":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"type":"object"},"file_signatures_details":{"additionalProperties":{"properties":{"artifact":{"type":"string"},"author":{"type":"string"},"confidence":{"type":"number"},"cves":{"properties":{"cve":{"properties":{"data_format":{"type":"string"},"data_type":{"type":"string"},"data_version":{"type":"string"},"problem_type":{"properties":{"problem_data":{"items":{"properties":{"description":{"properties":{"lang":{"type":"string"},"value":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"}},"type":"object"},"file_paths":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"path":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"}},"type":"object"},"type":"object"},"issues":{"items":{"properties":{"fix_info":{"properties":{"is_patchable":{"type":"boolean"},"is_pinnable":{"type":"boolean"},"is_runtime":{"type":"boolean"}},"type":"object"},"issue_id":{"type":"string"},"pkg_name":{"type":"string"},"pkg_version":{"type":"string"}},"type":"object"},"type":"array"},"issues_data":{"additionalProperties":{"properties":{"CVSSv3":{"type":"string"},"alternative_ids":{"items":{"type":"string"},"type":"array"},"creation_time":{"type":"string"},"credit":{"items":{"type":"string"},"type":"array"},"cvss_score":{"type":"number"},"description":{"type":"string"},"disclosure_time":{"type":"string"},"exploit":{"type":"string"},"fixed_in":{"items":{"type":"string"},"type":"array"},"functions":{"items":{"type":"string"},"type":"array"},"functions_new":{"items":{"properties":{"function_id":{"properties":{"class_name":{"type":"string"},"function_name":{"type":"string"}},"type":"object"},"version":{"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"id":{"type":"string"},"identifiers":{"additionalProperties":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"type":"object"},"insights":{"properties":{"triage_advice":{"type":"string"}},"type":"object"},"language":{"type":"string"},"malicious":{"type":"boolean"},"modification_time":{"type":"string"},"package_manager":{"type":"string"},"package_name":{"type":"string"},"package_repository_url":{"type":"string"},"patches":{"items":{"properties":{"id":{"type":"string"},"modification_time":{"type":"string"},"urls":{"items":{"type":"string"},"type":"array"},"version":{"type":"string"}},"type":"object"},"type":"array"},"publication_time":{"type":"string"},"references":{"items":{"properties":{"title":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"semver":{"properties":{"vulnerable":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"vulnerable_by_distro":{"additionalProperties":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"type":"object"},"vulnerable_hashes":{"items":{"type":"string"},"type":"array"}},"type":"object"},"severity":{"type":"string"},"severity_with_critical":{"type":"string"},"social_trend_alert":{"type":"boolean"},"title":{"type":"string"}},"type":"object"},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"properties":{"self":{"type":"string"}},"type":"object"}}}}},"description":"Returns issues","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"The location of the processing task","example":"/rest/orgs/2a70869c-7b32-4dfa-8605-199033c6db4c/depgraphs/1234567890","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":"Send DepGraph to Phoenix to compute issues","tags":["Issues"],"x-snyk-api-releases":["2022-06-29~experimental"],"x-snyk-api-version":"2022-06-29~experimental"},"x-snyk-api-resource":"issues"},"/orgs/{org_id}/users/{id}":{"get":{"description":"Get a summary of user.\n\nNote that Service Accounts are not returned by this endpoint. Please use the Service Accounts endpoints.\n","operationId":"getUser","parameters":[{"description":"The id of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the user","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/User"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","data"],"type":"object"}}},"description":"User details","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 user by ID","tags":["Users"],"x-snyk-api-releases":["2021-09-13~beta"],"x-snyk-api-version":"2021-09-13~beta"},"x-snyk-api-resource":"users"},"/packages/recommended_versions":{"get":{"description":"Resolves the recommended version for a software package based on current version and the major version policy.","operationId":"getPackageRecommendedVersions","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetRecommendedVersionsRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"additionalProperties":false,"description":"Recommended package release information response","properties":{"attributes":{"$ref":"#/components/schemas/RecommendedVersionAttributes"},"id":{"$ref":"#/components/schemas/PackageUrl"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Recommended package release information.","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"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get version recommendation about a software package.","tags":["Package"],"x-snyk-api-releases":["2024-02-26~experimental"],"x-snyk-api-version":"2024-02-26~experimental"},"x-snyk-api-resource":"packages"},"/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/Principal20240422"},"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"}}},"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/access_requests":{"get":{"description":"Get a list of user's access requests","operationId":"getAccessRequests","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/OrgIdFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AccessRequest"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of access requests are 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"}}},"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 access requests","tags":["AccessRequests"],"x-snyk-api-releases":["2023-12-01~experimental","2023-12-21~beta"],"x-snyk-api-version":"2023-12-21~beta"},"x-snyk-api-resource":"self"},"/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,"properties":{"data":{"items":{"$ref":"#/components/schemas/PublicApp"},"type":"array"},"jsonapi":{"$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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"$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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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,"properties":{"data":{"items":{"$ref":"#/components/schemas/SessionData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi"],"type":"object"}}},"description":"A list of active OAuth sessions for the 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Revoke an active user app session.","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/settings":{"get":{"description":"Get the settings for a user","operationId":"getUserSettings","parameters":[{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/UserSettings"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"]}}},"description":"Returns User Settings","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 User Settings","tags":["Users"],"x-snyk-api-releases":["2022-09-14~experimental"],"x-snyk-api-version":"2022-09-14~experimental"},"x-snyk-api-resource":"self","x-snyk-resource-singleton":true},"/tenants":{"get":{"description":"Get a list of all Tenants which the calling user is a member of","operationId":"listTenants","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,"properties":{"data":{"items":{"$ref":"#/components/schemas/TenantResponseData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Returns a list of tenants.","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 all accessible Tenants","tags":["Tenants"],"x-snyk-api-releases":["2024-04-11~experimental"],"x-snyk-api-version":"2024-04-11~experimental"},"x-snyk-api-resource":"tenants"},"/tenants/{tenant_id}/brokers/connections/{connection_id}/integrations":{"get":{"description":"Get all integrations using the Broker connection","operationId":"getBrokerConnectionIntegrations","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"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"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionIntegrationsResponse"}}},"description":"Returns a list of Integration IDs","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Get Integrations using the current Broker connection","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"connections"},"/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration":{"post":{"description":"Configures integrations to use the Broker connection for an deployment","operationId":"createBrokerConnectionIntegration","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBrokerConnectionIntegration"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionIntegrationResponse"}}},"description":"Configured integrations to use broker connection successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Creates Broker connection Integration Configuration","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"connections"},"/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id}":{"delete":{"description":"Deletes an existing Broker connection for an deployment","operationId":"deleteBrokerConnectionIntegration","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/IntegrationId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"204":{"description":"Broker connection integration was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes an Integration for a Broker connection","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"connections"},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments":{"get":{"description":"List Broker deployments for a given install ID","operationId":"listBrokerDeployments","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"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 requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerDeploymentsResponse"}}},"description":"Returns the list of Broker deployments by install ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Broker deployments","tags":["BrokerDeployments"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"post":{"description":"Creates a new Broker Deployment for an installation","operationId":"createBrokerDeployment","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBrokerDeploymentRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerDeploymentResponse"}}},"description":"Created broker deployment successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Creates Broker Deployment","tags":["BrokerDeployments"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"deployments"},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}":{"delete":{"description":"Delete a Broker deployment for a given install ID","operationId":"deleteBrokerDeployment","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"204":{"description":"Returns an empty response","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes Broker deployment","tags":["BrokerDeployments"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"patch":{"description":"Updates a Broker deployment for a given install ID","operationId":"updateBrokerDeployment","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerDeploymentRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerDeploymentResponse"}}},"description":"Updates an existing Broker deployment by install ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Updates Broker deployment","tags":["BrokerDeployments"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental"},"x-snyk-api-resource":"deployments"},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections":{"delete":{"description":"Deletes all existing Broker connections for an deployment","operationId":"deleteBrokerConnections","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"204":{"description":"All Broker connections were deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes Broker connections","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"get":{"description":"List all Broker connections for a given deployment","operationId":"listBrokerConnections","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"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 requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerConnectionsResponse"}}},"description":"Returns the list of Broker connections by deployment ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Broker connections","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"post":{"description":"Creates a new Broker connection for an deployment","operationId":"createBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBrokerConnectionRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionResponse"}}},"description":"Created broker connection successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Creates Broker connection","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"connections"},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}":{"delete":{"description":"Deletes an existing Broker connection for an deployment","operationId":"deleteBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"204":{"description":"Broker connection was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes Broker connection","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"get":{"description":"Get all Broker connection data for an deployment","operationId":"getBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"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"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionResponse"}}},"description":"Returns a Broker connection","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Get Broker connection","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"patch":{"description":"Updates a Broker connection for an deployment","operationId":"updateBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerConnectionRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionResponse"}}},"description":"Updates an existing Broker connection for an deployment","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Updates Broker connection","tags":["BrokerConnections"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"connections"},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials":{"get":{"description":"List Deployment credentials for a given deployment ID","operationId":"listDeploymentCredentials","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"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 requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListDeploymentCredentialsResponse"}}},"description":"Returns the list of deployment credentials by ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Deployment credentials","tags":["DeploymentCredentials"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"post":{"description":"Creates a new Deployment credential","operationId":"createDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentCredentialRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListDeploymentCredentialsResponse"}}},"description":"Created Deployment credential successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Create deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"credentials"},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}":{"delete":{"description":"Deletes an existing Deployment credential for an deployment","operationId":"deleteDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/CredentialId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"responses":{"204":{"description":"Deployment credential was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes Deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"get":{"description":"Get all Deployment credential data for an deployment","operationId":"getDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/CredentialId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"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"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetDeploymentCredentialResponse"}}},"description":"Returns a Deployment credential","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Get Deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"patch":{"description":"Updates a Deployment credential for an deployment","operationId":"updateDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/CredentialId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateDeploymentCredentialRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetDeploymentCredentialResponse"}}},"description":"Updates an existing Deployment credential for an deployment","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","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":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"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","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"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":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","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":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Updates Deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-releases":["2024-02-08~experimental"],"x-snyk-api-version":"2024-02-08~experimental","x-snyk-documentation":{"category":"Universal Broker"}},"x-snyk-api-resource":"credentials"},"/tenants/{tenant_id}/memberships":{"get":{"description":"Returns all memberships of the tenant","operationId":"getTenantMemberships","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TenantId20240509"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}},{"$ref":"#/components/parameters/EmailFilter"},{"$ref":"#/components/parameters/UserIdFilter"},{"$ref":"#/components/parameters/NameFilter"},{"$ref":"#/components/parameters/UsernameFilter"},{"$ref":"#/components/parameters/ConnectionTypeFilter"},{"$ref":"#/components/parameters/RoleFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TenantMembershipResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"List of tenant memberships 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"}}},"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 all memberships of the tenant","tags":["Tenant memberships"],"x-snyk-api-releases":["2024-05-09~experimental","2024-09-03~beta"],"x-snyk-api-version":"2024-05-09~experimental","x-snyk-deprecated-by":"2024-09-03~beta","x-snyk-sunset-eligible":"2024-09-04"},"x-snyk-api-resource":"memberships"},"/tenants/{tenant_id}/memberships/{membership_id}":{"delete":{"description":"Delete an individual tenant membership for a single user.","operationId":"deleteTenantMembership","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/MembershipId20240604"},{"$ref":"#/components/parameters/TenantId20240604"}],"responses":{"204":{"description":"successfully deleting an individual membership for a single user","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 an individual tenant membership for a single user.","tags":["Tenant"],"x-snyk-api-releases":["2024-06-04~experimental","2024-09-03~beta"],"x-snyk-api-version":"2024-06-04~experimental","x-snyk-deprecated-by":"2024-09-03~beta","x-snyk-sunset-eligible":"2024-09-04"},"patch":{"description":"Update the tenant membership with the new role\n","operationId":"updateTenantMembership","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TenantId20240609"},{"description":"Unique identifier for tenant membership","in":"path","name":"membership_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TenantMembership"}},"required":["data"],"type":"object"}}}},"responses":{"204":{"description":"successfully updated the tenant membership","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":"Update tenant membership","tags":["Tenant"],"x-snyk-api-releases":["2024-06-09~experimental","2024-09-03~beta"],"x-snyk-api-version":"2024-06-09~experimental","x-snyk-deprecated-by":"2024-09-03~beta","x-snyk-sunset-eligible":"2024-09-04"},"x-snyk-api-resource":"memberships"},"/tenants/{tenant_id}/relationships/owner":{"patch":{"description":"Update the Owner user ID of a tenant","operationId":"updateTenantOwner","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TenantId20240411"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"type":{"description":"The type of the user resource","type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}}}},"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"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a tenant owner","tags":["Tenants"],"x-snyk-api-releases":["2024-04-11~experimental"],"x-snyk-api-version":"2024-04-11~experimental"},"x-snyk-api-resource":"tenants"}},"security":[{"BearerAuth":[]},{"APIToken":[]}],"servers":[{"description":"Snyk REST API","url":"https://api.snyk.io/rest"}],"tags":[{"description":"Third-party Apps that integrate with the Snyk platform. See our [overview documentation](https://docs.snyk.io/integrations/snyk-apps) for more details.","name":"Apps"},{"description":"Audit Logs","name":"Audit Logs"},{"description":"Broker Connections","name":"BrokerConnections"},{"description":"Broker Deployments","name":"BrokerDeployments"},{"description":"Snyk's Catalog Resource","name":"Catalog Resource"},{"description":"Snyk Cloud API","name":"Cloud"},{"description":"Cloud Events supports several integrations, each implemented as a Snyk OAuth App.","name":"Cloud Events App Authorizations"},{"description":"A customer registration for a cloud event forwarding integration. A customer can register multiple event-forwarding integrations for a single org, and a single integration can be registered with multiple orgs.","name":"Cloud Events Registration"},{"description":"A code custom rule testing session","name":"CodeCustomRuleTestingSession"},{"description":"Update Code Settings for an org","name":"CodeSettings"},{"description":"User-defined collections of projects","name":"Collection"},{"description":"Container Image resource","name":"ContainerImage"},{"description":"Through the Custom Base Image Recommendation feature, Snyk can recommend an image upgrade from a pool of the your internal images. \nThis allows your teams to be notified of newer and more secure versions of internal base images.\n\nNotable changes to this API resource:\n- starting with version \"2023-09-20\", the `GET` `/custom_base_images` endpoint requires the `repository` filter when sorting by `version`.\n- starting with version \"2024-01-04\", `VersioningSchema` objects with `type` `\"date\"` are no longer supported. Snyk recommends updating custom base images with the deprecated type to `\"single-selection\"`.\n","name":"Custom Base Images"},{"description":"todo","name":"Depgraphs"},{"description":"Deployment Credentials","name":"DeploymentCredentials"},{"description":"A Group is a mid level of tenancy in Snyk, and contains a collection of orgs.","name":"Group"},{"description":"Groups can contain multiple organizations, allowing you to collaborate with multiple teams.","name":"Groups"},{"description":"Infrastructure as Code Settings.","name":"IacSettings"},{"description":"Snyk issue ignore rules","name":"Ignore"},{"description":"Organization Invites.","name":"Invites"},{"description":"Send DepGraph to Phoenix to compute issues","name":"Issues"},{"description":"The OpenAPI specification for unmanaged-deps.","name":"OpenAPI"},{"description":"Record of an organization moving from one group to another.","name":"Org Move"},{"description":"Membership record between a user and an org.","name":"OrgMemberships"},{"description":"An Organization is the lowest level of Snyk's tenancy hierarchy, and may contain projects and other data.","name":"Orgs"},{"description":"Information about a software package. Includes package metadata like it's name and version.","name":"Package"},{"description":"Policies define group-level configuration for issue severity overrides, ignores, and license violations.\n","name":"Policies"},{"description":"Policy rules resource\n","name":"Policy rules"},{"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.","name":"Pull Request Templates"},{"description":"A Software Bill of Materials document","name":"SBOM"},{"description":"SAST Settings modifications for an org","name":"SastSettings"},{"description":"The Scan API which provides an entry point to trigger analysis across product lines","name":"Scan"},{"description":"Service accounts can be used for continuous integration (CI) and other automation purposes, without using an actual Snyk user’s token.","name":"ServiceAccounts"},{"description":"Slack integration configuration.","name":"Slack"},{"description":"Slack app integration settings.","name":"SlackSettings"},{"description":"Legacy Broker connections for Internal Snyk","name":"SnykLegacyBrokers"},{"description":"A Tenant's Membership is a relationship between a tenant, a user, and a tenant role.","name":"Tenant"},{"description":"A Tenant is the highest level of tenancy in Snyk, and contains all the resources and settings relating to an individual customer.","name":"Tenants"},{"description":"The Test API which provides an entry point to trigger tests across product lines","name":"Test"},{"description":"Snyk Users","name":"Users"}],"x-cerberus":{"authentication":{"strategies":[{"InternalJWT":{}}]},"enableAccessAudit":true},"x-optic-url":"https://app.useoptic.com/organizations/390ef489-882c-48ba-acb3-4e0b73e48767/apis/5Tz5UMTNEIuz5-FZ6J2ki","x-snyk-api-lifecycle":"sunset","x-snyk-api-version":"2024-06-26~experimental"} ================================================ FILE: specs/snyk.json ================================================ {"components":{"examples":{"CloudListIssuesResponse":{"summary":"An example of a list issue response for a Cloud issue.","value":{"data":[{"attributes":{"classes":[{"id":"data","source":"snyk-cloud","type":"rule-category"},{"id":"CIS-AWS_v1.3.0_2.1.2","source":"CIS-AWS_v1.3.0","type":"compliance"},{"id":"CIS-AWS_v1.4.0_2.1.2","source":"CIS-AWS_v1.4.0","type":"compliance"},{"id":"HIPAA_§164.306(a)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_§164.312(a)(2)(iv)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_v2013_164.312(e)(2)(ii)","source":"HIPAA_v2013","type":"compliance"}],"coordinates":[{"remedies":[{"description":"1. Go to the AWS console\n2. Navigate to the S3 service page\n3. ...","type":"manual"},{"description":"1. Find the corresponding AWS::S3::Bucket resource\n2. ...","type":"cloudformation"},{"description":"1. Find the corresponding aws_s3_bucket resource\n2. ...","type":"terraform"},{"description":"Buckets should not ...","type":"rule_result_message"}],"representations":[{"cloud_resource":{"environment":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b6","name":"Staging","native_id":"721018433921","type":"aws"},"resource":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b7","input_type":"cloud_scan","location":"us-east-1","name":"policy-test-remediation","native_id":"arn:aws:s3:::policy-test-remediation","platform":"aws","resource_type":"aws_s3_bucket","tags":{"Stage":"Prod"},"type":"cloud"}}}]}],"created_at":"2022-09-27T20:09:05Z","description":"To protect data in transit, an S3 bucket policy should deny all HTTP requests to its objects and allow only HTTPS requests. HTTPS uses Transport Layer Security (TLS) to encrypt data, which preserves integrity and prevents tampering.","effective_severity_level":"medium","ignored":false,"key":"b50f2832-a901-565e-9e06-e4e59e8582b6","problems":[{"id":"SNYK-CC-00181","source":"snyk-cloud","type":"rule"}],"resolution":{"details":"rule_passed","resolved_at":"2022-09-28T20:09:05Z","type":"fixed"},"status":"resolved","title":"S3 bucket policies should only allow requests that use HTTPS","tool":"snyk://cloud","type":"cloud","updated_at":"2022-09-28T20:09:05Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"organization":{"data":{"id":"81e93f62-135f-48bc-84d0-47f16822313f","type":"organization"}},"scan_item":{"data":{"id":"24c8e771-ab3b-4e85-ac4f-f73950ba4acf","type":"environment"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"CodeListIssuesResponse20240123":{"summary":"An example of a list issue response for a Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1","status":"resolved","title":"Insecure hash function used","type":"code","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"IaCListIssuesResponse20240123":{"summary":"An example of a list issue response for an Infrastructure as Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"ff35a5c4d1cb4a1fd29c38b70f8ab89d1efea9d75aabf3a202d94f4776714b6191e2747cded23ba6cd7a47017a505a5d2c0823b69106ee2be0c11a18aa44b8a4","status":"resolved","title":"Container is running with writable root filesystem","type":"cloud","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"OpenSourceListIssuesResponse20240123":{"summary":"An example of a list issue response for an Open Source issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"medium","ignored":false,"key":"npm:hoek:20180212:hoek:2.16.3","status":"resolved","title":"Hoek - Prototype Pollution","type":"package_vulnerability","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}}},"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"}},"InternalGlooNormalizedPathHeader":{"description":"An internal header used by Snyk's API-Gateway for analytics.\n","schema":{"type":"string"},"x-snyk-internal":true},"InternalGlooOrgIdHeader":{"description":"An internal header used by Snyk's API-Gateway for analytics.\n","schema":{"format":"uuid","type":"string"},"x-snyk-internal":true},"Location":{"schema":{"type":"string"}},"LocationHeader":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"url","type":"string"}},"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"}},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}},"VersionRequestedResponseHeader":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"$ref":"#/components/schemas/QueryVersion"}},"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"}},"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"}}},"parameters":{"AppId":{"description":"App ID","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"BotId":{"description":"Bot ID","in":"path","name":"bot_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"ChannelId":{"description":"Slack Channel ID","in":"path","name":"channel_id","required":true,"schema":{"format":"uri","type":"string"}},"ChannelLimit":{"description":"Number of results to return per page","example":100,"in":"query","name":"limit","schema":{"default":1000,"format":"int32","maximum":1000,"minimum":10,"multipleOf":10,"type":"integer"}},"ClientId":{"description":"Client ID","in":"path","name":"client_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"CollectionId":{"description":"Unique identifier for a collection","in":"path","name":"collection_id","required":true,"schema":{"format":"uuid","type":"string"}},"CreatedAfter":{"description":"A filter to select issues created after this date.","in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},"CreatedBefore":{"description":"A filter to select issues created before this date.","in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},"Cursor":{"description":"The ID for the next page of results.","in":"query","name":"cursor","schema":{"type":"string"}},"CustomBaseImageId":{"description":"Unique identifier for custom base image","in":"path","name":"custombaseimage_id","required":true,"schema":{"format":"uuid","type":"string"}},"EffectiveSeverityLevel":{"description":"One or more effective severity levels to filter issues.","explode":false,"in":"query","name":"effective_severity_level","schema":{"items":{"enum":["info","low","medium","high","critical"],"type":"string"},"type":"array"},"style":"form"},"EndingBefore":{"description":"Return the page of results immediately before this cursor","example":"v1.eyJpZCI6IjExMDAifQo=","in":"query","name":"ending_before","schema":{"type":"string"}},"Events":{"description":"Filter logs by event types, cannot be used in conjunction with exclude_events parameter.","in":"query","name":"events","schema":{"items":{"type":"string"},"type":"array"}},"ExcludeEvents":{"description":"Exclude event types from results, cannot be used in conjunctions with events parameter.","in":"query","name":"exclude_events","schema":{"items":{"type":"string"},"type":"array"}},"Format":{"description":"The desired SBOM format of the response.","in":"query","name":"format","schema":{"enum":["cyclonedx1.4+json","cyclonedx1.4+xml","spdx2.3+json"],"example":"cyclonedx1.4+json","type":"string"}},"From":{"description":"The start date (inclusive) of the audit logs search. If not specified, the start of yesterday is used. Dates should be formatted as RFC3339, e.g. 2024-01-02T16:30:00Z.\n","in":"query","name":"from","schema":{"format":"date-time","type":"string"}},"GroupId":{"description":"The group ID of the custom base image","in":"query","name":"group_id","schema":{"format":"uuid","type":"string"}},"Ignored":{"description":"Whether an issue is ignored or not.","in":"query","name":"ignored","schema":{"type":"boolean"},"style":"form"},"ImageId20231102":{"description":"Image ID","in":"path","name":"image_id","required":true,"schema":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"}},"ImageIds":{"description":"A comma-separated list of Image IDs","example":["sha256:b26f21f90920dba8401e30b89ad803587f81cce9bd1f92750f963556da2f930f","sha256:28984a62eb713aa5fff922ba06e8689f20e4b2f07de30f3d753b868389c0904f"],"explode":false,"in":"query","name":"image_ids","schema":{"items":{"format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"},"maxItems":100,"type":"array"},"style":"form"},"IncludeInRecommendations":{"description":"Whether this image should be recommended as a base image upgrade","in":"query","name":"include_in_recommendations","schema":{"type":"boolean"}},"InstallId":{"description":"Install ID","in":"path","name":"install_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"Limit":{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":10,"multipleOf":10,"type":"integer"}},"Names":{"description":"The container registry names","example":["gcr.io/snyk/redis:5"],"explode":false,"in":"query","name":"names","schema":{"items":{"$ref":"#/components/schemas/ImageName"},"maxItems":1,"type":"array"},"style":"form"},"OrgId":{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},"PackageUrl":{"description":"A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required.","example":"pkg%3Amaven%2Fcom.fasterxml.woodstox%2Fwoodstox-core%405.0.0","in":"path","name":"purl","required":true,"schema":{"type":"string"}},"PathGroupId":{"description":"Unique identifier for group","in":"path","name":"group_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"PathIssueId20240123":{"description":"Issue ID","in":"path","name":"issue_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},"PathOrgId":{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"Platform":{"description":"The image Operating System and processor architecture","example":"linux/amd64","in":"query","name":"platform","schema":{"$ref":"#/components/schemas/Platform"}},"ProjectId":{"description":"The ID of the container project that the custom base image is based off of.","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},"QueryNameFilter":{"description":"Only return organizations whose name contains this value. Case insensitive.","in":"query","name":"name","schema":{"type":"string"}},"QuerySlugFilter":{"description":"Only return organizations whose slug exactly matches this value. Case sensitive.","in":"query","name":"slug","schema":{"type":"string"}},"Repository":{"description":"The image repository","in":"query","name":"repository","schema":{"type":"string"}},"ScanItemId":{"description":"A scan item id to filter issues through their scan item relationship.","in":"query","name":"scan_item.id","schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbee","format":"uuid","type":"string"},"style":"form"},"ScanItemType":{"description":"A scan item types to filter issues through their scan item relationship.","in":"query","name":"scan_item.type","schema":{"$ref":"#/components/schemas/ScanItemType"},"style":"form"},"Size":{"description":"Number of results to return per page.","example":10,"in":"query","name":"size","schema":{"default":100,"format":"int32","maximum":100,"minimum":1,"multipleOf":1,"type":"integer"}},"SortBy":{"description":"Which column to sort by. \nIf sorting by version, the versioning schema is used.\n","in":"query","name":"sort_by","schema":{"enum":["repository","tag","version"],"type":"string"}},"SortDirection":{"description":"Which direction to sort","in":"query","name":"sort_direction","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}},"SortOrder":{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},"StartingAfter":{"description":"Return the page of results immediately after this cursor","example":"v1.eyJpZCI6IjEwMDAifQo=","in":"query","name":"starting_after","schema":{"type":"string"}},"Status":{"description":"An issue's status","explode":false,"in":"query","name":"status","schema":{"items":{"enum":["open","resolved"],"type":"string"},"type":"array"},"style":"form"},"Tag":{"description":"The image tag","in":"query","name":"tag","schema":{"type":"string"}},"TenantId":{"description":"Tenant ID","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},"To":{"description":"The end date (exclusive) of the audit logs search. Dates should be formatted as RFC3339, e.g. 2024-01-02T16:30:00Z.\n","in":"query","name":"to","schema":{"format":"date-time","type":"string"}},"Type":{"description":"An issue type to filter issues.","in":"query","name":"type","schema":{"$ref":"#/components/schemas/TypeDef"},"style":"form"},"UpdatedAfter":{"description":"A filter to select issues updated after this date.","in":"query","name":"updated_after","schema":{"format":"date-time","type":"string"}},"UpdatedBefore":{"description":"A filter to select issues updated before this date.","in":"query","name":"updated_before","schema":{"format":"date-time","type":"string"}},"UserId":{"description":"Filter logs by user ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"user_id","schema":{"format":"uuid","type":"string"}},"Version":{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"$ref":"#/components/schemas/QueryVersion"}}},"responses":{"204":{"description":"The operation completed successfully with no content","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":{"$ref":"#/components/schemas/ErrorDocument"}}},"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"},"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":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Unauthorized: the request requires an authentication token.","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"}}},"403":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Forbidden: the request requires an authentication token with more or different permissions.","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":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Not Found: The resource being operated on could not be found.","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":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","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"}}},"500":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","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"}}},"GetIssue20020240123":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Issue"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"]}}},"description":"Returns an instance of an issue","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"uri","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"}}},"ListIssues200":{"content":{"application/vnd.api+json":{"examples":{"Cloud":{"$ref":"#/components/examples/CloudListIssuesResponse"},"Code":{"$ref":"#/components/examples/CodeListIssuesResponse20240123"},"IaC":{"$ref":"#/components/examples/IaCListIssuesResponse20240123"},"OpenSource":{"$ref":"#/components/examples/OpenSourceListIssuesResponse20240123"}},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Issue"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"]}}},"description":"Returns a collection 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"}}}},"schemas":{"AccessTokenTtlSeconds":{"description":"The access token time to live for your app, in seconds. It only affects the newly generated access tokens, existing access token will continue to have their previous time to live as expiration.","example":3600,"maximum":86400,"minimum":3600,"type":"number"},"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"},"AppBot":{"additionalProperties":false,"properties":{"attributes":{"type":"object"},"id":{"$ref":"#/components/schemas/Id"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicApp"}},"type":"object"}},"required":["app"],"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","relationships"],"type":"object"},"AppData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributes"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppData20220311":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributes20220311"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppDataWithSecret":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributesWithSecret"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppDataWithSecret20220311":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributesWithSecret20220311"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallData":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"description":"The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"installed_at":{"$ref":"#/components/schemas/InstalledAt"}},"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicAppData"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallDataWithSecret":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"description":"The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"client_secret":{"$ref":"#/components/schemas/ClientSecret20240523"},"installed_at":{"$ref":"#/components/schemas/InstalledAt"}},"required":["client_id","client_secret"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicAppData"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallWithClient":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"format":"uuid","type":"string"},"client_secret":{"type":"string"}},"required":["client_id","client_secret"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/Uuid"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes","relationships"],"type":"object"},"AppInstance":{"additionalProperties":false,"properties":{"default_org_context":{"description":"ID of the default org for the service account.","format":"uuid","type":"string"},"name":{"description":"The name of the service account.","example":"user","type":"string"}},"required":["name"],"type":"object"},"AppName":{"description":"New name of the app to display to users during authorization flow.","example":"My App","minLength":1,"type":"string"},"AppPatchRequest":{"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"}},"type":"object"},"type":{"enum":["app"],"type":"string"}},"type":"object"}},"required":["data"],"type":"object"},"AppPatchRequest20220311":{"additionalProperties":false,"minProperties":1,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"}},"type":"object"},"AppPostRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"context":{"description":"Allow installing the app to at org/group level or user level. Defaults to tenant.","enum":["tenant","user"],"type":"string"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","redirect_uris","scopes","context"],"type":"object"},"type":{"enum":["app"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"AppPostRequest20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"context":{"$ref":"#/components/schemas/Context"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","redirect_uris","scopes"],"type":"object"},"AppPostResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"},"AppPostResponse20220311":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"},"AppResourceAttributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId"},"context":{"description":"Allow installing the app to at org/group level or user level. Defaults to tenant.","enum":["tenant","user"],"type":"string"},"grant_type":{"$ref":"#/components/schemas/GrantType"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","scopes","access_token_ttl_seconds","is_public","is_confidential","context","grant_type"],"type":"object"},"AppResourceAttributes20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"description":"The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"context":{"$ref":"#/components/schemas/Context"},"grant_type":{"$ref":"#/components/schemas/GrantType20220311"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential20220311"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUrisNoMin"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","context","grant_type"],"type":"object"},"AppResourceAttributesWithSecret":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId"},"client_secret":{"$ref":"#/components/schemas/ClientSecret"},"context":{"description":"Allow installing the app to at org/group level or user level. Defaults to tenant.","enum":["tenant","user"],"type":"string"},"grant_type":{"$ref":"#/components/schemas/GrantType"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","client_secret","context","grant_type"],"type":"object"},"AppResourceAttributesWithSecret20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"description":"The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"client_secret":{"$ref":"#/components/schemas/ClientSecret"},"context":{"$ref":"#/components/schemas/Context"},"grant_type":{"$ref":"#/components/schemas/GrantType20220311"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential20220311"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","client_secret","context","grant_type"],"type":"object"},"AuditLogSearch":{"properties":{"items":{"items":{"properties":{"content":{"type":"object"},"created":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"org.create","type":"string"},"group_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"},"org_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"},"project_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"}},"required":["created","event"],"type":"object"},"type":"array"},"type":{"type":"string"}},"type":"object"},"AutoDependencyUpgradeSettings":{"additionalProperties":false,"description":"Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Project's integration.","properties":{"ignored_dependencies":{"description":"Dependencies which should NOT be included in an automatic upgrade operation.","example":["typescript"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically raise pull requests to update out-of-date dependencies.","example":true,"type":"boolean"},"is_inherited":{"description":"Apply the auto dependency integration settings of the Organization to this project.","example":true,"type":"boolean"},"is_major_upgrade_enabled":{"description":"Include major version in dependency upgrade recommendation.","example":true,"type":"boolean"},"limit":{"description":"Limit of dependency upgrade PRs which can be opened simultaneously. When the limit is reached, no new upgrade PRs are created. If specified, must be between 1 and 10.","example":10,"maximum":10,"minimum":1,"type":"number"},"minimum_age":{"description":"Minimum dependency maturity period in days. If specified, must be between 1 and 365.","example":365,"type":"number"}},"type":"object"},"AutoDependencyUpgradeSettings20240531":{"additionalProperties":false,"description":"Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Organization's integration.","properties":{"ignored_dependencies":{"description":"Dependencies which should NOT be included in an automatic upgrade operation.","example":["typescript"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically raise pull requests to update out-of-date dependencies.","example":true,"type":"boolean"},"is_major_upgrade_enabled":{"description":"Include major version in dependency upgrade recommendation.","example":true,"type":"boolean"},"limit":{"description":"Limit of dependency upgrade PRs which can be opened simultaneously. When the limit is reached, no new upgrade PRs are created. If specified, must be between 1 and 10.","example":10,"maximum":10,"minimum":1,"type":"number"},"minimum_age":{"description":"Minimum dependency maturity period in days. If specified, must be between 1 and 365.","example":365,"type":"number"}},"type":"object"},"AutoRemediationPRsSettings":{"additionalProperties":false,"description":"Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration.","properties":{"is_backlog_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities.","example":true,"type":"boolean"},"is_fresh_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for new vulnerabilities.","example":true,"type":"boolean"},"is_patch_remediation_enabled":{"description":"Include vulnerability patches in automatic pull requests.","example":true,"type":"boolean"}},"type":"object"},"AutoRemediationPRsSettings20240531":{"additionalProperties":false,"description":"Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.","properties":{"is_backlog_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities.","example":true,"type":"boolean"},"is_fresh_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for new vulnerabilities.","example":true,"type":"boolean"},"is_patch_remediation_enabled":{"description":"Include vulnerability patches in automatic pull requests.","example":true,"type":"boolean"}},"type":"object"},"BulkPackageUrlsRequestBody":{"properties":{"data":{"properties":{"attributes":{"properties":{"purls":{"description":"An array of Package URLs (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required.","items":{"type":"string"},"type":"array"}},"required":["purls"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"},"CVSSSource":{"additionalProperties":false,"properties":{"level":{"example":"medium","minLength":1,"type":"string"},"modification_time":{"description":"The time this CVSS data was last updated","format":"date-time","type":"string"},"score":{"example":4.2,"format":"float","type":"number"},"source":{"example":"snyk","minLength":1,"type":"string"},"vector":{"example":"CVSS:4.0/AV:N/AC:H/AT:N/PR:L/UI:A/VC:N/VI:N/VA:N/SC:H/SI:L/SA:L/E:A","minLength":1,"type":"string"},"version":{"example":"4.0","minLength":1,"type":"string"}},"required":["level","source","score","vector","version","modification_time"],"type":"object"},"Class":{"additionalProperties":false,"example":{"id":"CWE-190","source":"CWE","type":"weakness"},"properties":{"id":{"maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CWE","maxLength":64,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/ClassTypeDef"},"url":{"description":"An optional URL for this class.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","type","source"],"type":"object"},"ClassTypeDef":{"enum":["rule-category","compliance","weakness"],"example":"compliance","type":"string"},"ClientId":{"description":"The oauth2 client id for the app.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"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\u003c]S_v1","minLength":1,"type":"string"},"ClientSecret20240523":{"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. Only provided for installations of non-interactive Snyk Apps.","example":"snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht\u003c]S_v1","minLength":1,"type":"string"},"CloudResource":{"properties":{"environment":{"properties":{"id":{"description":"Internal ID for an environment.","format":"uuid","type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this environment. For example, a cloud account id.","maxLength":2048,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"resource":{"properties":{"iac_mappings_count":{"description":"Amount of IaC resources this resource maps to.","format":"int64","minimum":0,"type":"integer"},"id":{"description":"Internal ID for a resource.","format":"uuid","type":"string"},"input_type":{"enum":["cloud_scan","arm","k8s","tf","tf_hcl","tf_plan","tf_state","cfn"],"type":"string"},"location":{"maxLength":256,"minLength":1,"type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this resource. For example, a cloud resource id.","maxLength":2048,"minLength":1,"type":"string"},"platform":{"maxLength":256,"minLength":1,"type":"string"},"resource_type":{"maxLength":256,"minLength":1,"type":"string"},"tags":{"additionalProperties":{"maxLength":256,"type":"string"},"type":"object"},"type":{"enum":["cloud","iac"],"type":"string"}},"required":["input_type"],"type":"object"}},"required":["environment"],"type":"object"},"CollectionAttributes":{"additionalProperties":false,"properties":{"is_generated":{"type":"boolean"},"name":{"description":"User-defined name of the collection","type":"string"}},"required":["name"],"type":"object"},"CollectionMeta":{"additionalProperties":false,"properties":{"issues_critical_count":{"description":"The sum of critical severity issues of the collection's projects","example":10,"type":"number"},"issues_high_count":{"description":"The sum of high severity issues of the collection's projects","example":10,"type":"number"},"issues_low_count":{"description":"The sum of low severity issues of the collection's projects","example":10,"type":"number"},"issues_medium_count":{"description":"The sum of medium severity issues of the collection's projects","example":10,"type":"number"},"projects_count":{"description":"The amount of projects belonging to this collection","example":7,"type":"number"}},"required":["projects_count","issues_critical_count","issues_high_count","issues_medium_count","issues_low_count"],"type":"object"},"CollectionRelationships":{"additionalProperties":false,"properties":{"created_by_user":{"properties":{"data":{"properties":{"id":{"description":"ID of the user that created the collection. Null for auto-collections.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","nullable":true,"type":"string"},"type":{"enum":["user"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"org":{"properties":{"data":{"properties":{"id":{"description":"ID of the org that this collection belongs to","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"enum":["org"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["org","created_by_user"],"type":"object"},"CollectionResponse":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"id":{"format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/CollectionMeta"},"relationships":{"$ref":"#/components/schemas/CollectionRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","meta","attributes","relationships"],"type":"object"},"CommonIssueModelVThree":{"properties":{"attributes":{"properties":{"coordinates":{"items":{"$ref":"#/components/schemas/Coordinate"},"type":"array"},"created_at":{"example":"2022-06-16T13:51:13Z","format":"date-time","type":"string"},"description":{"description":"A description of the issue in Markdown format","example":"## Overview\\n\\n\\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.","type":"string"},"effective_severity_level":{"description":"The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies.","enum":["info","low","medium","high","critical"],"type":"string"},"problems":{"items":{"$ref":"#/components/schemas/Problem3"},"type":"array"},"severities":{"description":"An array of dictionaries containing all known data related to the vulnerability","items":{"$ref":"#/components/schemas/Severity3"},"type":"array"},"slots":{"$ref":"#/components/schemas/Slots"},"title":{"description":"A human-readable title for this issue.","example":"XML External Entity (XXE) Injection","type":"string"},"type":{"description":"The issue type","example":"package_vulnerability","type":"string"},"updated_at":{"description":"When the vulnerability information was last modified.","example":"2022-06-16T14:00:24.315507Z","format":"date-time","type":"string"}},"type":"object"},"id":{"description":"The Snyk ID of the vulnerability.","example":"SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754","type":"string"},"type":{"description":"The type of the REST resource. Always ‘issue’.","example":"issue","type":"string"}},"type":"object"},"ContainerBuildArgs":{"additionalProperties":false,"properties":{"platform":{"type":"string"}},"required":["platform"],"type":"object"},"Context":{"description":"Allow installing the app to a org/group or to a user, default tenant.","enum":["tenant","user"],"type":"string"},"Coordinate":{"properties":{"remedies":{"items":{"$ref":"#/components/schemas/Remedy3"},"type":"array"},"representations":{"description":"The affected versions of this vulnerability.","items":{"anyOf":[{"$ref":"#/components/schemas/ResourcePathRepresentation"},{"$ref":"#/components/schemas/PackageRepresentation"}]},"type":"array"}},"required":["representations"],"type":"object"},"CreateCollectionRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/name"}},"required":["name"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CustomBaseImageAttributes":{"additionalProperties":false,"properties":{"include_in_recommendations":{"description":"Whether this image should be recommended as a base image upgrade. \nIf set to true, this image could be shown as a base image upgrade to other projects.\nIf set to false this image will never be recommended as an upgrade.\n","example":true,"type":"boolean"},"project_id":{"description":"The ID of the container project that the custom base image is based off of.\nThe attributes of this custom base image are taken from the latest snapshot at the time of creation.\nThis means that no changes should be made to the original project after the creation of the custom base image,\nas new snapshots created from any changes will NOT be picked up.\n","example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"},"versioning_schema":{"$ref":"#/components/schemas/VersioningSchema"}},"required":["project_id","include_in_recommendations"],"type":"object"},"CustomBaseImageCollectionResponse":{"additionalProperties":false,"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageSnapshot"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi"],"type":"object"},"CustomBaseImagePatchRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"include_in_recommendations":{"example":true,"type":"boolean"},"versioning_schema":{"$ref":"#/components/schemas/VersioningSchema"}},"type":"object"},"id":{"description":"The ID of the custom base image that should be updated. (Same one used in the URI)","format":"uuid","type":"string"},"type":{"description":"This should always be \"custom_base_image\"","example":"custom_base_image","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CustomBaseImagePostRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageAttributes"},"type":{"description":"This should always be \"custom_base_image\"","example":"custom_base_image","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CustomBaseImageResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageAttributes"},"id":{"example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"},"type":{"example":"custom_base_image","type":"string"}},"required":["id","type","attributes"],"type":"object"},"CustomBaseImageResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CustomBaseImageResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi"],"type":"object"},"CustomBaseImageSnapshot":{"properties":{"group_id":{"format":"uuid","type":"string"},"include_in_recommendations":{"type":"boolean"},"org_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"repository":{"type":"string"},"tag":{"type":"string"}},"type":"object"},"CycloneDxComponent":{"properties":{"bom-ref":{"example":"common-util@3.0.0","type":"string","xml":{"attribute":true}},"name":{"example":"acme-lib","type":"string"},"purl":{"example":"pkg:golang/golang.org/x/text@v0.3.7","type":"string"},"type":{"example":"library","type":"string","xml":{"attribute":true}},"version":{"example":"1.0.0","type":"string"}},"type":"object","xml":{"name":"component"}},"CycloneDxDependency":{"properties":{"dependsOn":{"example":["web-framework@1.0.0","persistence@3.1.0"],"items":{"type":"string"},"type":"array","xml":{"name":"dependency"}},"ref":{"example":"common-util@3.0.0","type":"string","xml":{"attribute":true}}},"type":"object","xml":{"name":"dependency"}},"CycloneDxDocument":{"properties":{"bomFormat":{"enum":["CycloneDX"],"example":"CycloneDX","type":"string"},"components":{"description":"A list of included software components","items":{"$ref":"#/components/schemas/CycloneDxComponent"},"type":"array"},"dependencies":{"items":{"$ref":"#/components/schemas/CycloneDxDependency"},"type":"array"},"metadata":{"$ref":"#/components/schemas/CycloneDxMetadata"},"specVersion":{"example":"1.4","type":"string"},"version":{"example":1,"type":"integer"}},"required":["bomFormat","specVersion","version","metadata","dependencies"],"type":"object"},"CycloneDxMetadata":{"properties":{"component":{"$ref":"#/components/schemas/CycloneDxComponent"},"properties":{"items":{"$ref":"#/components/schemas/CycloneDxProperty"},"type":"array","xml":{"wrapped":true}},"timestamp":{"example":"2021-02-09T20:40:32Z","type":"string"},"tools":{"items":{"$ref":"#/components/schemas/CycloneDxTool"},"type":"array","xml":{"wrapped":true}}},"type":"object"},"CycloneDxProperty":{"properties":{"name":{"example":"snyk:org_id","type":"string","xml":{"attribute":true}},"value":{"example":"f1bb66d1-a94e-4574-aea1-9697d794e04d","type":"string"}},"type":"object","xml":{"name":"property"}},"CycloneDxTool":{"properties":{"name":{"example":"Snyk Open Source","type":"string"},"vendor":{"example":"Snyk","type":"string"}},"type":"object","xml":{"name":"tool"}},"CycloneDxXmlDocument":{"properties":{"components":{"description":"A list of included software components","items":{"$ref":"#/components/schemas/CycloneDxComponent"},"type":"array","xml":{"wrapped":true}},"dependencies":{"items":{"$ref":"#/components/schemas/CycloneDxDependency"},"type":"array","xml":{"wrapped":true}},"metadata":{"$ref":"#/components/schemas/CycloneDxMetadata"}},"required":["metadata","components","dependencies"],"type":"object","xml":{"name":"bom"}},"DeleteProjectsFromCollectionRequest":{"additionalProperties":false,"properties":{"data":{"description":"IDs of items to remove from a collection","items":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"type":{"description":"Type of the item id","enum":["project"],"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["data"],"type":"object"},"Dependency":{"properties":{"package_name":{"description":"The package name the issue was found in","maxLength":2048,"minLength":1,"type":"string"},"package_version":{"description":"The package version the issue was found in","maxLength":2048,"minLength":1,"type":"string"}},"required":["package_name","package_version"],"type":"object"},"DeployedRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"Environment":{"properties":{"id":{"description":"Internal ID for an environment.","format":"uuid","type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this environment. For example, a cloud account id.","maxLength":2048,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"EnvironmentTypeDef":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"},"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":{"$ref":"#/components/schemas/ErrorLink"},"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"},"ErrorDocument":{"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":{"$ref":"#/components/schemas/Error"},"minItems":1,"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","errors"],"type":"object"},"ErrorLink":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"ExploitDetails":{"description":"Details about the exploits","properties":{"maturity_levels":{"description":"List of maturity levels","items":{"$ref":"#/components/schemas/MaturityLevel"},"type":"array"},"sources":{"description":"Sources for determining exploit maturity level, e.g., CISA, ExploitDB, Snyk.","items":{"type":"string"},"type":"array"}},"type":"object"},"FilePosition":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"GetProjectSettingsCollection":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectSettingsData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"},"GetProjectsOfCollectionResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectOfCollection"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"},"GrantType":{"description":"An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token. The grant type represents the way your app will get the access token.","enum":["authorization_code","client_credentials"],"type":"string"},"GrantType20220311":{"description":"An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token.","enum":["authorization_code","client_credentials"],"type":"string"},"GroupIacSettingsRequest":{"description":"The Infrastructure as Code settings for a group.","properties":{"attributes":{"properties":{"custom_rules":{"additionalProperties":false,"description":"The Infrastructure as Code custom rules settings for a group.","minProperties":1,"properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"}},"type":"object"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"required":["type","attributes"],"type":"object"},"GroupIacSettingsResponse":{"description":"The Infrastructure as Code settings for a group.","properties":{"attributes":{"properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for a group.","properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"},"id":{"description":"ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"type":"object"},"Id":{"format":"uuid","type":"string"},"IgnoreType":{"enum":["ignore"],"example":"ignore","type":"string"},"Image":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ImageAttributes"},"id":{"$ref":"#/components/schemas/ImageDigest"},"relationships":{"properties":{"image_target_refs":{"properties":{"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}},"type":"object"},"type":{"enum":["container_image"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"ImageAttributes":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/ImageDigest"},"minItems":1,"type":"array"},"names":{"items":{"$ref":"#/components/schemas/ImageName"},"type":"array"},"platform":{"$ref":"#/components/schemas/Platform"}},"required":["platform","layers"],"type":"object"},"ImageDigest":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"},"ImageName":{"example":"gcr.io/snyk/redis:5","pattern":"^((?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?\\/)?[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?(?:(?:\\/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?)(?::([\\w][\\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][A-Fa-f0-9]{32,}))?$","type":"string"},"ImageTargetRef":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ImageTargetRefAttributes"},"id":{"example":"3cd4af4c-fb15-45c4-9acd-8e8fcc6690af","format":"uuid","type":"string"},"type":{"enum":["image_target_reference"],"type":"string"}},"type":"object"},"ImageTargetRefAttributes":{"properties":{"platform":{"$ref":"#/components/schemas/Platform"},"target_id":{"format":"uuid","type":"string"},"target_reference":{"type":"string"}},"type":"object"},"InheritFromParent":{"description":"Which parent to inherit settings from.","enum":["group"],"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,"type":"boolean"},"IsConfidential":{"description":"A boolean to indicate if an app is confidential or not as per the OAuth2 RFC. Confidential apps can securely store secrets. Examples of non-confidential apps are full web-based or CLIs.","example":true,"type":"boolean"},"IsConfidential20220311":{"description":"A boolean to indicate if an app is confidential or not as per the OAuth2 RFC.","example":true,"type":"boolean"},"IsEnabled":{"description":"Whether the custom rules feature is enabled or not.","example":true,"type":"boolean"},"IsPublic":{"description":"A boolean to indicate if an app is publicly available or not.","example":false,"type":"boolean"},"Issue":{"additionalProperties":false,"description":"A Snyk Issue.","properties":{"attributes":{"$ref":"#/components/schemas/IssueAttributes"},"id":{"example":"73832c6c-19ff-4a92-850c-2e1ff2800c16","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/IssueRelationships"},"type":{"$ref":"#/components/schemas/IssueType"}},"required":["id","type","attributes","relationships"],"type":"object"},"IssueAttributes":{"additionalProperties":false,"description":"issue attributes","properties":{"classes":{"description":"A list of details for weakness data, policy, etc that are the class of this issue's source.","items":{"$ref":"#/components/schemas/Class"},"maxItems":50,"minItems":1,"type":"array"},"coordinates":{"description":"Where the issue originated, specific to issue type. Details on what\ncode, package, etc introduced the issue. An issue may be caused by\nmore than one coordinate.\n","items":{"properties":{"is_fixable_manually":{"type":"boolean"},"is_fixable_snyk":{"type":"boolean"},"is_fixable_upstream":{"type":"boolean"},"is_patchable":{"type":"boolean"},"is_pinnable":{"type":"boolean"},"is_upgradeable":{"type":"boolean"},"reachability":{"enum":["function","package","no-info","not-applicable"],"type":"string"},"remedies":{"items":{"additionalProperties":false,"properties":{"correlation_id":{"description":"An optional identifier for correlating remedies between coordinates or across issues. They are scoped\nto a single Project and test run. Remedies with the same correlation_id must have the same contents.\n","maxLength":256,"minLength":1,"type":"string"},"description":{"description":"A markdown-formatted optional description of this remedy. Links are not permitted.","maxLength":4096,"minLength":1,"type":"string"},"meta":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.","type":"object"},"schema_version":{"description":"A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n","maxLength":256,"minLength":1,"type":"string"}},"required":["data","schema_version"],"type":"object"},"type":{"enum":["indeterminate","manual","automated","rule_result_message","terraform","cloudformation","cli","kubernetes","arm"],"type":"string"}},"required":["type"],"type":"object"},"maxItems":5,"minItems":1,"type":"array"},"representations":{"description":"A list of precise locations that surface an issue. A coordinate may have multiple representations.\n","items":{"oneOf":[{"description":"An object that contains an opaque identifying string.","properties":{"resourcePath":{"maxLength":2024,"minLength":1,"type":"string"}},"required":["resourcePath"],"type":"object"},{"description":"An object that contains a list of opaque identifying strings.","properties":{"dependency":{"properties":{"package_name":{"description":"The package name the issue was found in","maxLength":2048,"minLength":1,"type":"string"},"package_version":{"description":"The package version the issue was found in","maxLength":2048,"minLength":1,"type":"string"}},"required":["package_name","package_version"],"type":"object"}},"required":["dependency"],"type":"object"},{"description":"A resource location to some service, like a cloud resource.","properties":{"cloud_resource":{"properties":{"environment":{"properties":{"id":{"description":"Internal ID for an environment.","format":"uuid","type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this environment. For example, a cloud account id.","maxLength":2048,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"resource":{"properties":{"iac_mappings_count":{"description":"Amount of IaC resources this resource maps to.","format":"int64","minimum":0,"type":"integer"},"id":{"description":"Internal ID for a resource.","format":"uuid","type":"string"},"input_type":{"enum":["cloud_scan","arm","k8s","tf","tf_hcl","tf_plan","tf_state","cfn"],"type":"string"},"location":{"maxLength":256,"minLength":1,"type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this resource. For example, a cloud resource id.","maxLength":2048,"minLength":1,"type":"string"},"platform":{"maxLength":256,"minLength":1,"type":"string"},"resource_type":{"maxLength":256,"minLength":1,"type":"string"},"tags":{"additionalProperties":{"maxLength":256,"type":"string"},"type":"object"},"type":{"enum":["cloud","iac"],"type":"string"}},"required":["input_type"],"type":"object"}},"required":["environment"],"type":"object"}},"required":["cloud_resource"],"type":"object"},{"description":"A location within a file.","properties":{"sourceLocation":{"properties":{"file":{"description":"A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n","maximum":2048,"minimum":1,"type":"string"},"region":{"properties":{"end":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"start":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"}},"required":["start","end"],"type":"object"}},"required":["file"],"type":"object"}},"required":["sourceLocation"],"type":"object"}]},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"minItems":1,"type":"array"},"created_at":{"description":"The creation time of this issue.","format":"date-time","type":"string"},"description":{"description":"A markdown-formatted optional description of this issue. Links are not permitted.","example":"Affected versions of this package are vulnerable to Prototype Pollution.\nThe utilities function allow modification of the `Object` prototype.\nIf an attacker can control part of the structure passed to this function,\nthey could add or modify an existing property.\n","maxLength":4096,"minLength":1,"type":"string"},"effective_severity_level":{"description":"The computed effective severity of this issue. This is either the highest level from all included severities,\nor an overridden value set via group level policy.\n","enum":["info","low","medium","high","critical"],"type":"string"},"exploit_details":{"additionalProperties":false,"properties":{"maturity_levels":{"items":{"additionalProperties":false,"properties":{"format":{"example":"CVSS_v4","minLength":1,"type":"string"},"level":{"example":"attacked","minLength":1,"type":"string"}},"required":["format","level"],"type":"object"},"type":"array"},"sources":{"example":["CISA"],"items":{"type":"string"},"type":"array"}},"required":["sources","maturity_levels"],"type":"object"},"ignored":{"description":"A flag indicating if the issue is being ignored. Derived from the issue's ignore, which provides more details.","type":"boolean"},"key":{"description":"An opaque key used for uniquely identifying this issue across test runs, within a project.","example":"24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1","maxLength":2048,"type":"string"},"problems":{"description":"A list of details for vulnerability data, policy, etc that are the source of this issue.","items":{"$ref":"#/components/schemas/Problem"},"minItems":1,"type":"array"},"resolution":{"$ref":"#/components/schemas/Resolution"},"risk":{"$ref":"#/components/schemas/Risk"},"severities":{"items":{"$ref":"#/components/schemas/CVSSSource"},"type":"array"},"status":{"description":"The issue's status. Derived from the issue's resolution, which provides more details.","enum":["open","resolved"],"type":"string"},"title":{"description":"A human-readable title for this issue.","example":"Insecure hash function used","maxLength":2048,"minLength":1,"type":"string"},"tool":{"description":"An opaque identifier for corelating across test runs.","example":"snyk://npm-deps","maxLength":1024,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/TypeDef"},"updated_at":{"description":"The time when this issue was last modified.","format":"date-time","type":"string"}},"required":["key","title","type","effective_severity_level","created_at","updated_at","status","ignored"],"type":"object"},"IssueRelationships":{"additionalProperties":false,"description":"issue relationships","example":{"ignore":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5d","type":"ignore"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}},"test_executions":{"data":[{"id":"0086e1bc-7c27-4f2e-9a99-5fe793ba4bef","type":"test-workflow-execution"}]}},"properties":{"ignore":{"description":"An optional reference to an ignore rule that marks this issue as ignored.","properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"string"},"type":{"$ref":"#/components/schemas/IgnoreType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"organization":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/OrganizationType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"scan_item":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/ScanItemType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"test_executions":{"description":"The \"test execution\" that identified this Issues. This ID represents\na grouping of issues, that were identified by some analysis run, to produce\nIssues.\n","properties":{"data":{"description":"List of metadata associated with the test executions that identified this issue","items":{"properties":{"id":{"example":"3344947d-a5c3-4e20-928b-385a5d8792a3","type":"string"},"type":{"$ref":"#/components/schemas/TestExecutionType"}},"required":["type","id"],"type":"object"},"maxItems":25,"type":"array"}},"required":["data"],"type":"object"}},"required":["organization","scan_item"],"type":"object"},"IssueType":{"enum":["issue"],"example":"issue","type":"string"},"IssuesMeta":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta"}},"type":"object"},"IssuesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModelVThree"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"$ref":"#/components/schemas/IssuesMeta"}},"type":"object"},"IssuesWithPurlsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModelVThree"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}},"type":"object"}},"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"},"LatestDependencyTotal":{"additionalProperties":false,"properties":{"total":{"type":"number"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"LatestIssueCounts":{"additionalProperties":false,"properties":{"critical":{"type":"number"},"high":{"type":"number"},"low":{"type":"number"},"medium":{"type":"number"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"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":{"$ref":"#/components/schemas/Meta"}},"required":["href"],"type":"object"}]},"Links":{"additionalProperties":false,"properties":{"first":{"$ref":"#/components/schemas/LinkProperty"},"last":{"$ref":"#/components/schemas/LinkProperty"},"next":{"$ref":"#/components/schemas/LinkProperty"},"prev":{"$ref":"#/components/schemas/LinkProperty"},"related":{"$ref":"#/components/schemas/LinkProperty"},"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"LoadedPackageRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"ManualRemediationPRsSettings":{"additionalProperties":false,"description":"Manually raise pull requests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration.","properties":{"is_patch_remediation_enabled":{"description":"Include vulnerability patches in manual pull requests.","example":true,"type":"boolean"}},"type":"object"},"ManualRemediationPRsSettings20240531":{"additionalProperties":false,"description":"Manually raise pull requests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.","properties":{"is_patch_remediation_enabled":{"description":"Include vulnerability patches in manual pull requests.","example":true,"type":"boolean"}},"type":"object"},"MaturityLevel":{"description":"Details about the maturity level","properties":{"format":{"description":"The standard by which the “maturity” value is shown.","example":"CVSSv4","type":"string"},"level":{"description":"Exploit maturity of the vulnerability. For CVSSv3: Proof of Concept, Functional, High. For CVSSv4: Unreported, Proof of Concept, Attacked.","example":"Attacked","type":"string"},"type":{"description":"Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.","example":"primary","type":"string"}},"type":"object"},"MemberRoleRelationship":{"additionalProperties":false,"nullable":true,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgRoleAttributes"},"id":{"description":"The Snyk ID of the organization role.","example":"f60ff965-6889-4db2-8c86-0285d62f35ab","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id"],"type":"object"}},"required":["data"],"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"},"NugetBuildArgs":{"additionalProperties":false,"properties":{"target_framework":{"type":"string"}},"required":["target_framework"],"type":"object"},"OSConditionRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"OciRegistryTag":{"description":"The tag for an OCI artifact inside an OCI registry.","example":"latest","type":"string"},"OciRegistryUrl":{"description":"The URL to an OCI registry.","example":"https://registry-1.docker.io/account/bundle","type":"string"},"Org":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"OrgAttributes":{"additionalProperties":false,"properties":{"access_requests_enabled":{"description":"Whether the organization permits access requests from users who are not members of the organization.","example":false,"type":"boolean"},"created_at":{"description":"The time the organization was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"group_id":{"description":"The Snyk ID of the group to which the organization belongs.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"is_personal":{"description":"Whether the organization is independent (that is, not part of a group).","example":true,"type":"boolean"},"name":{"description":"The display name of the organization.","example":"My Org","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the organization.","example":"my-org","type":"string"},"updated_at":{"description":"The time the organization was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","is_personal"],"type":"object"},"OrgIacSettingsRequest":{"description":"The Infrastructure as Code settings for an org.","properties":{"attributes":{"properties":{"custom_rules":{"additionalProperties":false,"description":"The Infrastructure as Code custom rules settings for an org.","minProperties":1,"properties":{"inherit_from_parent":{"$ref":"#/components/schemas/InheritFromParent"},"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"}},"type":"object"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"required":["type","attributes"],"type":"object"},"OrgIacSettingsResponse":{"description":"The Infrastructure as Code settings for an org.","properties":{"attributes":{"properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for an org.","properties":{"inherit_from_parent":{"$ref":"#/components/schemas/InheritFromParent"},"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"},"parents":{"description":"Contains all parents the org can inherit settings from.","properties":{"group":{"description":"The Infrastructure as Code settings at the group level.","properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for a group.","properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"}},"type":"object"},"id":{"description":"ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"type":"object"},"OrgInvitation":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitation20230828":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes20230428"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitation20240621":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes20230828"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitationAttributes":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role assigned to the invitee on acceptance.","example":"Developer","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationAttributes20230428":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationAttributes20230828":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationPostAttributes":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid"}},"required":["email","role"],"type":"object"},"OrgInvitationPostData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationPostAttributes"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","attributes"],"type":"object"},"OrgInvitationPostData20230428":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationPostAttributes"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","attributes"],"type":"object"},"OrgRelationships":{"additionalProperties":false,"properties":{"member_role":{"$ref":"#/components/schemas/MemberRoleRelationship"}},"type":"object"},"OrgRoleAttributes":{"properties":{"name":{"description":"The display name of the organization role.","example":"Collaborator","type":"string"}},"type":"object"},"OrgUpdateAttributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the organization.","example":"My Org","maxLength":60,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"OrgWithRelationships":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"OrganizationType":{"enum":["organization"],"example":"organization","type":"string"},"Package":{"properties":{"name":{"description":"The package’s name","example":"spring-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"org.springframework","type":"string"},"type":{"description":"The package type or protocol","example":"maven","type":"string"},"url":{"description":"The purl of the package","example":"pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0","type":"string"},"version":{"description":"The version of the package","example":"1.0.0","type":"string"}},"required":["name","type","url","version"],"type":"object"},"PackageMeta":{"properties":{"name":{"description":"The package’s name","example":"spring-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"org.springframework","type":"string"},"type":{"description":"The package type or protocol","example":"maven","type":"string"},"url":{"description":"The purl of the package","example":"pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0","type":"string"},"version":{"description":"The version of the package","example":"1.0.0","type":"string"}},"type":"object"},"PackageRepresentation":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta"}},"type":"object"},"PaginatedLinks":{"additionalProperties":false,"example":{"first":"https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K","last":"https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K","next":"https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"},"properties":{"first":{"$ref":"#/components/schemas/LinkProperty"},"last":{"$ref":"#/components/schemas/LinkProperty"},"next":{"$ref":"#/components/schemas/LinkProperty"},"prev":{"$ref":"#/components/schemas/LinkProperty"},"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"PatchProjectRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"test_frequency":{"description":"Test frequency of a project. Also controls when automated PRs may be created.","enum":["daily","weekly","never"],"example":"daily","type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"properties":{"owner":{"properties":{"data":{"properties":{"id":{"description":"The public ID of the user that owns the project","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","nullable":true,"type":"string"},"type":{"enum":["user"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"type":"object"},"type":{"description":"The Resource type.","enum":["project"],"type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"}},"required":["data"],"type":"object"},"Platform":{"enum":["aix/ppc64","android/386","android/amd64","android/arm","android/arm/v5","android/arm/v6","android/arm/v7","android/arm64","android/arm64/v8","darwin/amd64","darwin/arm","darwin/arm/v5","darwin/arm/v6","darwin/arm/v7","darwin/arm64","darwin/arm64/v8","dragonfly/amd64","freebsd/386","freebsd/amd64","freebsd/arm","freebsd/arm/v5","freebsd/arm/v6","freebsd/arm/v7","illumos/amd64","ios/arm64","ios/arm64/v8","js/wasm","linux/386","linux/amd64","linux/arm","linux/arm/v5","linux/arm/v6","linux/arm/v7","linux/arm64","linux/arm64/v8","linux/loong64","linux/mips","linux/mipsle","linux/mips64","linux/mips64le","linux/ppc64","linux/ppc64le","linux/riscv64","linux/s390x","linux/x86_64","netbsd/386","netbsd/amd64","netbsd/arm","netbsd/arm/v5","netbsd/arm/v6","netbsd/arm/v7","openbsd/386","openbsd/amd64","openbsd/arm","openbsd/arm/v5","openbsd/arm/v6","openbsd/arm/v7","openbsd/arm64","openbsd/arm64/v8","plan9/386","plan9/amd64","plan9/arm","plan9/arm/v5","plan9/arm/v6","plan9/arm/v7","solaris/amd64","windows/386","windows/amd64","windows/arm","windows/arm/v5","windows/arm/v6","windows/arm/v7","windows/arm64","windows/arm64/v8"],"example":"linux/amd64","type":"string"},"Principal20240422":{"additionalProperties":false,"properties":{"attributes":{"anyOf":[{"$ref":"#/components/schemas/User20240422"},{"$ref":"#/components/schemas/ServiceAccount20240422"},{"$ref":"#/components/schemas/AppInstance"}]},"id":{"description":"The Snyk ID corresponding to this user, service account or app","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type.","enum":["user","service_account","app_instance"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"Problem":{"additionalProperties":false,"example":{"id":"SNYK-DEBIAN8-CURL-358558","source":"snyk","type":"rule"},"properties":{"disclosed_at":{"description":"When this problem was disclosed to the public.","format":"date-time","type":"string"},"discovered_at":{"description":"When this problem was first discovered.","format":"date-time","type":"string"},"id":{"maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CVE","maxLength":64,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/ProblemTypeDef"},"updated_at":{"description":"When this problem was last updated.","format":"date-time","type":"string"},"url":{"description":"An optional URL for this problem.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","type","source"],"type":"object"},"Problem3":{"properties":{"disclosed_at":{"description":"When this problem was disclosed to the public.","format":"date-time","type":"string"},"discovered_at":{"description":"When this problem was first discovered.","format":"date-time","type":"string"},"id":{"example":"CWE-61","maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CVE","maxLength":64,"minLength":1,"type":"string"},"updated_at":{"description":"When this problem was last updated.","format":"date-time","type":"string"},"url":{"description":"An optional URL for this problem.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","source"],"type":"object"},"ProblemTypeDef":{"enum":["rule","vulnerability"],"type":"string"},"ProjectAttributes":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings20240531"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectAttributes20230215":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectAttributes20230828":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectMeta":{"additionalProperties":false,"properties":{"imported":{"description":"The time the project was imported","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"issues_critical_count":{"description":"The sum of critical severity issues of the project","example":10,"type":"number"},"issues_high_count":{"description":"The sum of high severity issues of the project","example":10,"type":"number"},"issues_low_count":{"description":"The sum of low severity issues of the project","example":10,"type":"number"},"issues_medium_count":{"description":"The sum of medium severity issues of the project","example":10,"type":"number"},"last_tested_at":{"description":"The time the project was last tested","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"}},"required":["imported","last_tested_at","issues_critical_count","issues_high_count","issues_medium_count","issues_low_count"],"type":"object"},"ProjectOfCollection":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/ProjectMeta"},"relationships":{"additionalProperties":false,"properties":{"target":{"properties":{"data":{"properties":{"id":{"description":"ID of the target that owns the project","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"enum":["target"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["target"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","meta","relationships"],"type":"object"},"ProjectRelationships":{"additionalProperties":false,"properties":{"importer":{"$ref":"#/components/schemas/Relationship"},"organization":{"$ref":"#/components/schemas/Relationship"},"owner":{"$ref":"#/components/schemas/Relationship"},"target":{"oneOf":[{"$ref":"#/components/schemas/Relationship"},{"$ref":"#/components/schemas/ProjectRelationshipsTarget20230215"}]}},"required":["target","organization"],"type":"object"},"ProjectRelationshipsTarget":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectRelationshipsTarget20230215":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectRelationshipsTarget20230911":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectSettings":{"additionalProperties":false,"properties":{"auto_dependency_upgrade":{"$ref":"#/components/schemas/AutoDependencyUpgradeSettings"},"auto_remediation_prs":{"$ref":"#/components/schemas/AutoRemediationPRsSettings"},"manual_remediation_prs":{"$ref":"#/components/schemas/ManualRemediationPRsSettings"},"pull_request_assignment":{"$ref":"#/components/schemas/PullRequestAssignmentSettings"},"pull_requests":{"$ref":"#/components/schemas/PullRequestsSettings"},"recurring_tests":{"$ref":"#/components/schemas/RecurringTestsSettings"}},"required":["recurring_tests","pull_requests"],"type":"object"},"ProjectSettings20240531":{"additionalProperties":false,"properties":{"auto_dependency_upgrade":{"$ref":"#/components/schemas/AutoDependencyUpgradeSettings20240531"},"auto_remediation_prs":{"$ref":"#/components/schemas/AutoRemediationPRsSettings20240531"},"manual_remediation_prs":{"$ref":"#/components/schemas/ManualRemediationPRsSettings20240531"},"pull_request_assignment":{"$ref":"#/components/schemas/PullRequestAssignmentSettings20240531"},"pull_requests":{"$ref":"#/components/schemas/PullRequestsSettings"},"recurring_tests":{"$ref":"#/components/schemas/RecurringTestsSettings"}},"required":["recurring_tests","pull_requests"],"type":"object"},"ProjectSettingsData":{"properties":{"attributes":{"additionalProperties":false,"properties":{"is_active":{"$ref":"#/components/schemas/IsActive"},"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"},"target_channel_name":{"$ref":"#/components/schemas/TargetChannelName"},"target_project_name":{"description":"The target file name for the project.","example":"snyk/goof:package.json","type":"string"}},"required":["target_channel_id","target_channel_name","severity_threshold","target_project_name","is_active"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"example":"slack","type":"string"}},"type":"object"},"ProjectSettingsPatchRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"is_active":{"$ref":"#/components/schemas/IsActive"},"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"}},"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"enum":["slack"],"type":"string"}},"required":["type","attributes","id"],"type":"object"}},"type":"object"},"PublicApp":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PublicAppAttributes"},"id":{"$ref":"#/components/schemas/Id"},"links":{"$ref":"#/components/schemas/Links"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"},"PublicAppAttributes":{"properties":{"client_id":{"$ref":"#/components/schemas/ClientId"},"context":{"$ref":"#/components/schemas/Context"},"name":{"$ref":"#/components/schemas/AppName"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","client_id"],"type":"object"},"PublicAppData":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"client_id":{"format":"uuid","type":"string"},"context":{"description":"Allow installing the app to a org/group or to a user, default tenant.","enum":["tenant","user"],"type":"string"},"name":{"description":"New name of the app to display to users during authorization flow.","example":"My App","minLength":1,"type":"string"},"scopes":{"description":"The scopes this app is allowed to request during authorization.","items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"}},"required":["name","client_id"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"},"PublicFacingRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"PublicTarget":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"created_at":{"description":"The creation date of the target","example":"2022-09-01T00:00:00Z","format":"date-time","type":"string"},"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source.\n","example":"snyk-fixtures/goof","type":"string"},"is_private":{"description":"If the target is private, or publicly accessible","example":false,"type":"boolean"},"url":{"description":"The URL for the resource.","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"required":["display_name","url","is_private"],"type":"object"},"id":{"description":"The id of this target","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"integration":{"additionalProperties":false,"description":"The configured integration which this target relates to","properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"integration_type":{"description":"The human readable name for this type of integration","example":"gitlab","type":"string"}},"required":["integration_type"],"type":"object"},"id":{"example":"7667dae6-602c-45d9-baa9-79e1a640f199","format":"uuid","nullable":true,"type":"string"},"type":{"description":"Content type.","example":"integration","type":"string"}},"required":["id","type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"organization":{"additionalProperties":false,"description":"The organization which owns this target","properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"e661d4ef-5ad5-4cef-ad16-5157cefa83f5","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"organization","type":"string"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["organization","integration"],"type":"object"},"type":{"description":"Content type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"PullRequestAssignmentSettings":{"additionalProperties":false,"description":"Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Project's integration.","properties":{"assignees":{"description":"Manually specify users to assign (and all will be assigned).","example":["my-github-username"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically assign pull requests created by Snyk.","example":true,"type":"boolean"},"type":{"description":"Automatically assign the last user to change the manifest file (\"auto\"), or manually specify a list of users (\"manual\").","enum":["auto","manual"],"example":"auto","type":"string"}},"type":"object"},"PullRequestAssignmentSettings20240531":{"additionalProperties":false,"description":"Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Organization's integration.","properties":{"assignees":{"description":"Manually specify users to assign (and all will be assigned).","example":["my-github-username"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically assign pull requests created by Snyk.","example":true,"type":"boolean"},"type":{"description":"Automatically assign the last user to change the manifest file (\"auto\"), or manually specify a list of users (\"manual\").","enum":["auto","manual"],"example":"auto","type":"string"}},"type":"object"},"PullRequestTemplateAttributes":{"additionalProperties":false,"minProperties":1,"properties":{"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.","properties":{"fail_only_for_issues_with_fix":{"description":"Only fail when the issues found have a fix available.","example":true,"type":"boolean"},"policy":{"description":"Fail if the project has any issues (\"all\"), or fail if a PR is introducing a new dependency with issues (\"only_new\"). If this value is unset, the setting is inherited from the org default.","enum":["all","only_new"],"example":"all","type":"string"},"severity_threshold":{"description":"Only fail for issues greater than or equal to the specified severity. If this value is unset, the setting is inherited from the org default.","enum":["low","medium","high","critical"],"example":"high","type":"string"}},"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))?))$","type":"string"},"ReachabilityDef":{"enum":["function","package","no-info","not-applicable"],"type":"string"},"RecurringTestsSettings":{"additionalProperties":false,"description":"Settings which describe how recurring tests are run for a project.","properties":{"frequency":{"description":"Test frequency of a project. Also controls when automated PRs may be created.","enum":["daily","weekly","never"],"example":"daily","type":"string"}},"type":"object"},"RedirectUris":{"description":"List of allowed redirect URIs to call back after authentication.","example":["https://example.com/callback"],"items":{"format":"uri","type":"string"},"minItems":1,"type":"array"},"RedirectUrisNoMin":{"description":"List of allowed redirect URIs to call back after authentication.","example":["https://example.com/callback"],"items":{"format":"uri","type":"string"},"type":"array"},"Region":{"properties":{"end":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"start":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"}},"required":["start","end"],"type":"object"},"RelatedLink":{"additionalProperties":false,"example":{"related":"https://example.com/api/other_resource"},"properties":{"related":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"Relationship":{"example":{"data":{"id":"4a72d1db-b465-4764-99e1-ecedad03b06a","type":"resource"},"links":{"related":{"href":"https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"}}},"properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"4a72d1db-b465-4764-99e1-ecedad03b06a","format":"uuid","type":"string"},"type":{"description":"Type of the related resource","example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","links"],"type":"object"},"Remedy":{"additionalProperties":false,"properties":{"correlation_id":{"description":"An optional identifier for correlating remedies between coordinates or across issues. They are scoped\nto a single Project and test run. Remedies with the same correlation_id must have the same contents.\n","maxLength":256,"minLength":1,"type":"string"},"description":{"description":"A markdown-formatted optional description of this remedy. Links are not permitted.","maxLength":4096,"minLength":1,"type":"string"},"meta":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.","type":"object"},"schema_version":{"description":"A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n","maxLength":256,"minLength":1,"type":"string"}},"required":["data","schema_version"],"type":"object"},"type":{"enum":["indeterminate","manual","automated","rule_result_message","terraform","cloudformation","cli","kubernetes","arm"],"type":"string"}},"required":["type"],"type":"object"},"Remedy3":{"properties":{"description":{"description":"A markdown-formatted optional description of this remedy.","example":"Upgrade the package version to 5.4.0,6.4.0 to fix this vulnerability","type":"string"},"details":{"properties":{"upgrade_package":{"description":"A minimum version to upgrade to in order to remedy the issue.","example":"5.4.0,6.4.0","type":"string"}},"type":"object"},"type":{"description":"The type of the remedy. Always ‘indeterminate’.","example":"indeterminate","type":"string"}},"type":"object"},"RemedyMetadata":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.","type":"object"},"schema_version":{"description":"A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n","maxLength":256,"minLength":1,"type":"string"}},"required":["data","schema_version"],"type":"object"},"Resolution":{"additionalProperties":false,"description":"An optional field recording when and via what means an issue was resolved, if it was resolved.\nResolved issues are retained for XX days.\n","properties":{"details":{"description":"Optional details about the resolution. Used by Snyk Cloud so far.","type":"string"},"resolved_at":{"description":"The time when this issue was resolved.","format":"date-time","type":"string"},"type":{"$ref":"#/components/schemas/ResolutionTypeDef"}},"required":["type","resolved_at"],"type":"object"},"ResolutionTypeDef":{"enum":["disappeared","fixed"],"type":"string"},"Resource":{"properties":{"iac_mappings_count":{"description":"Amount of IaC resources this resource maps to.","format":"int64","minimum":0,"type":"integer"},"id":{"description":"Internal ID for a resource.","format":"uuid","type":"string"},"input_type":{"enum":["cloud_scan","arm","k8s","tf","tf_hcl","tf_plan","tf_state","cfn"],"type":"string"},"location":{"maxLength":256,"minLength":1,"type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this resource. For example, a cloud resource id.","maxLength":2048,"minLength":1,"type":"string"},"platform":{"maxLength":256,"minLength":1,"type":"string"},"resource_type":{"maxLength":256,"minLength":1,"type":"string"},"tags":{"additionalProperties":{"maxLength":256,"type":"string"},"type":"object"},"type":{"enum":["cloud","iac"],"type":"string"}},"required":["input_type"],"type":"object"},"ResourcePath":{"example":",5.4.0),[6.0.0.pr1,6.4.0)","maxLength":2024,"minLength":1,"type":"string"},"ResourcePathRepresentation":{"description":"An object that contains an opaque identifying string.","properties":{"resource_path":{"$ref":"#/components/schemas/ResourcePath"}},"required":["resource_path"],"type":"object"},"Risk":{"additionalProperties":false,"description":"Risk prioritization information for an issue","example":{"factors":[{"name":"deployed","updated_at":"2023-09-07T13:36:37Z","value":true}],"score":{"model":"v4","value":700}},"properties":{"factors":{"description":"Risk factors identified for an issue","items":{"$ref":"#/components/schemas/RiskFactor"},"type":"array"},"score":{"$ref":"#/components/schemas/RiskScore"}},"required":["factors"],"type":"object"},"RiskFactor":{"discriminator":{"mapping":{"deployed":"#/components/schemas/DeployedRiskFactor","loaded_package":"#/components/schemas/LoadedPackageRiskFactor","os_condition":"#/components/schemas/OSConditionRiskFactor","public_facing":"#/components/schemas/PublicFacingRiskFactor"},"propertyName":"name"},"oneOf":[{"$ref":"#/components/schemas/DeployedRiskFactor"},{"$ref":"#/components/schemas/OSConditionRiskFactor"},{"$ref":"#/components/schemas/PublicFacingRiskFactor"},{"$ref":"#/components/schemas/LoadedPackageRiskFactor"}]},"RiskFactorLinks":{"properties":{"evidence":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"RiskScore":{"description":"Risk prioritization score based on an analysis model","example":{"model":"v1","value":700},"properties":{"model":{"description":"Risk scoring model used to calculate the score value","type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"description":"Risk score value, which may be used for overall prioritization","maximum":1000,"minimum":0,"type":"integer"}},"required":["value","model"],"type":"object"},"SastEnablement":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"autofix_enabled":{"type":"boolean"},"sast_enabled":{"type":"boolean"}},"required":["sast_enabled"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"SbomResource":{"additionalProperties":false,"properties":{"id":{"example":"b68b0b85-d039-4c05-abc0-04eb50ca0fe9","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"SbomResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SbomResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","data"],"type":"object"},"ScanItemType":{"enum":["project","environment"],"example":"project","type":"string"},"Scopes":{"description":"The scopes this app is allowed to request during authorization.","items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"},"SelfLink":{"additionalProperties":false,"example":{"self":"https://example.com/api/this_resource"},"properties":{"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"ServiceAccount":{"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":{"$ref":"#/components/schemas/Links"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"ServiceAccount20240422":{"additionalProperties":false,"properties":{"default_org_context":{"description":"ID of the default org for the service account.","format":"uuid","type":"string"},"name":{"description":"The name of the service account.","example":"user","type":"string"}},"required":["name"],"type":"object"},"SessionAttributes":{"properties":{"created_at":{"format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"SessionData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SessionAttributes"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"SettingsAttributes":{"additionalProperties":false,"properties":{"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"}},"required":["target_channel_id","severity_threshold"],"type":"object"},"SettingsRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SettingsAttributes"},"type":{"enum":["slack"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"Severity3":{"properties":{"level":{"description":"Level of severity calculated via vector","example":"medium","type":"string"},"score":{"description":"The CVSS score calculated from the vector, representing the severity of the vulnerability on a scale from 0 to 10.","example":5.3,"nullable":true,"type":"number"},"source":{"description":"The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application.","example":"Snyk","type":"string"},"type":{"description":"Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.","example":"primary","type":"string"},"vector":{"description":"CVSS vector string detailing the metrics of a vulnerability.","example":"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:L","nullable":true,"type":"string"},"version":{"description":"CVSS version being described.","example":"4.0","type":"string"}},"type":"object"},"SeverityThreshold":{"description":"Minimum Snyk issue severity to send a notification for, messages will not be sent for any issue below this value","enum":["low","medium","high","critical"],"example":"high","type":"string"},"SlackChannel":{"properties":{"attributes":{"properties":{"name":{"description":"Name of the Slack Channel","example":"general","type":"string"},"type":{"description":"Channel type","enum":["public","private","direct_message","multiparty_direct_message"],"type":"string"}},"type":"object"},"id":{"example":"slack://channel?team=T123456\u0026id=C123456","format":"uri","type":"string"},"type":{"example":"slack_channel","type":"string"}},"type":"object"},"SlackDefaultSettingsData":{"properties":{"attributes":{"additionalProperties":false,"properties":{"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"},"target_channel_name":{"$ref":"#/components/schemas/TargetChannelName"}},"required":["target_channel_id","target_channel_name","severity_threshold"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"example":"slack","type":"string"}},"type":"object"},"Slots":{"properties":{"disclosure_time":{"description":"The time at which this vulnerability was disclosed.","example":"2022-06-16T13:51:13Z","format":"date-time","type":"string"},"exploit_details":{"$ref":"#/components/schemas/ExploitDetails"},"publication_time":{"description":"The time at which this vulnerability was published.","example":"2022-06-16T14:00:24.315507Z","type":"string"},"references":{"items":{"properties":{"title":{"description":"Descriptor for an external reference to the issue","type":"string"},"url":{"description":"URL for an external reference to the issue","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"SourceLocation":{"properties":{"file":{"description":"A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n","maximum":2048,"minimum":1,"type":"string"},"region":{"properties":{"end":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"start":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"}},"required":["start","end"],"type":"object"}},"required":["file"],"type":"object"},"SpdxDocument":{"additionalProperties":true,"type":"object"},"TargetChannelId":{"example":"slack://channel?team=team-id\u0026id=channel-id","format":"uri","type":"string"},"TargetChannelName":{"example":"channel-name","minLength":1,"type":"string"},"TestExecutionType":{"enum":["test-workflow-execution","custom-execution"],"type":"string"},"Type":{"type":"string"},"TypeDef":{"description":"The type of an issue.","enum":["package_vulnerability","license","cloud","code","custom","config"],"example":"cloud","type":"string"},"Types":{"example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"},"UpdateCollectionRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/name"}},"required":["name"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"UpdateCollectionWithProjectsRequest":{"additionalProperties":false,"properties":{"data":{"description":"IDs of items to add to a collection","items":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"type":{"description":"Type of the item id","enum":["project"],"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["data"],"type":"object"},"Updated":{"description":"The last time the settings were updated.","example":"2021-11-12T10:31:06.026Z","format":"date-time","type":"string"},"User20240422":{"additionalProperties":false,"properties":{"avatar_url":{"description":"The avatar url of the user.","example":"https://snyk.io/avatar.png","format":"uri","type":"string"},"default_org_context":{"description":"ID of the default org for the user.","format":"uuid","type":"string"},"email":{"description":"The email of the user.","example":"user@someorg.com","type":"string"},"name":{"description":"The name of the user.","example":"user","type":"string"},"username":{"description":"The username of the user.","example":"username","type":"string"}},"required":["name","email","avatar_url"],"type":"object"},"Uuid":{"format":"uuid","type":"string"},"VersioningSchema":{"allOf":[{"oneOf":[{"$ref":"#/components/schemas/VersioningSchemaSemverType"},{"$ref":"#/components/schemas/VersioningSchemaCustomType"},{"$ref":"#/components/schemas/VersioningSchemaSingleSelectionType"}]}],"description":"The versioning scheme used by images in the repository.\n\nA versioning schema is a system for identifying and organizing different versions of a project. \nIt is used to track changes and updates to the project over time, and to help users identify which version they are using. \nA versioning schema typically consists of a series of numbers or labels that are incremented to reflect the progression of versions. \nFor example, a versioning schema might use a series of numbers, such as \"1.0\", \"1.1\", \"2.0\", and so on, to indicate major and minor releases of a product. \nA consistent and well-defined versioning schema helps users and tools understand and track the development of a project.\n"},"VersioningSchemaCustomType":{"additionalProperties":false,"description":"The Custom Schema type is a way for Snyk to understand your company’s container image tag versioning scheme,\nenabling Snyk to give more accurate base image upgrade recommendations.\n\nThis schema type is essentially a regular expression that groups the different parts of an image’s tag into comparable sections.\n\nIf your container image's tags follow a versioning scheme other than Semantic Versioning (SemVer), \nit is highly recommended that you select the \"Custom Versioning\" schema for your image repositories.\n","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":"(?\u003cC0\u003e.)\\-(?\u003cM2\u003e.*)","type":"string"},"label":{"description":"A customizable string that can be set for a custom versioning schema to describe its meaning.\nThis label has no function.\n","example":"calendar with flavor schema","type":"string"},"type":{"enum":["custom"],"type":"string"}},"required":["type","expression"],"type":"object"},"VersioningSchemaSemverType":{"additionalProperties":false,"properties":{"type":{"enum":["semver"],"example":"semver","type":"string"}},"required":["type"],"type":"object"},"VersioningSchemaSingleSelectionType":{"additionalProperties":false,"description":"The Single Selection Versioning Schema allows manual setting of which image should be given as a recommendation.\n\nOnly one image can be set as the current recommendation. If no images are set as the current selection, \nno recommendation will be given.\n\nIt is recommended to use this versioning schema if your repository's tags aren't supported by the other schemas.\n","properties":{"is_selected":{"description":"Whether this image should be the recommendation. Only one image can be selected at a given time. Setting this\nas true will remove previous selection.\n","example":true,"type":"boolean"},"type":{"enum":["single-selection"],"example":"single-selection","type":"string"}},"required":["type","is_selected"],"type":"object"},"YarnBuildArgs":{"additionalProperties":false,"properties":{"root_workspace":{"type":"string"}},"required":["root_workspace"],"type":"object"},"name":{"description":"User-defined name of the collection","maxLength":255,"minLength":1,"pattern":"^([a-zA-Z0-9 _\\-\\/:.])+$","type":"string"}},"securitySchemes":{"APIToken":{"description":"API key value must be prefixed with \\\"Token \\\".","in":"header","name":"Authorization","type":"apiKey"},"BearerAuth":{"scheme":"bearer","type":"http"}}},"info":{"title":"Snyk API","version":"REST"},"openapi":"3.0.3","paths":{"/custom_base_images":{"get":{"description":"Get a list of custom base images with support for ordering and filtering.\nEither the org_id or group_id parameters must be set to authorize successfully.\nIf sorting by version, the repository filter is required.\n","operationId":"getCustomBaseImages","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/ProjectId"},{"description":"The organization ID of the custom base image","in":"query","name":"org_id","schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/Repository"},{"$ref":"#/components/parameters/Tag"},{"$ref":"#/components/parameters/IncludeInRecommendations"},{"$ref":"#/components/parameters/SortBy"},{"$ref":"#/components/parameters/SortDirection"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImageCollectionResponse"}}},"description":"Returns custom base images","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 collection","tags":["Custom Base Images"],"x-snyk-api-releases":["2023-08-21","2023-09-20","2024-01-04","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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"}}},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get a list of apps installed for a group.","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 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Filter logs by project ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},{"$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":{"$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 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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/PathIssueId20240123"}],"responses":{"200":{"$ref":"#/components/responses/GetIssue20020240123"},"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"$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":{"items":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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":{"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.","format":"uuid","type":"string"}},"required":["name","auth_type","role_id"],"type":"object"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["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/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"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 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"}},{"$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":{"$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,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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"}],"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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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,"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":{"$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,"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":{"$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","x-snyk-resource-singleton":true},"/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"}},{"$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":"Delete 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"},"get":{"description":"Get your groups pull request template","operationId":"getPullRequestTemplate","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","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":{"properties":{"data":{"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/PaginatedLinks"}},"type":"object"}}},"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"},"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 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"}},{"$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":{"$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":"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"}}},"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":{"$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"},{"$ref":"#/components/parameters/PathOrgId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgUpdateAttributes"},"id":{"description":"The ID of the resource.","format":"uuid","type":"string"},"type":{"description":"The type of the resource.","enum":["org"],"example":"org","type":"string"}},"required":["id","type","attributes"],"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":{"enum":["org"],"example":"org","type":"string"}},"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","2024-02-28"],"x-snyk-api-version":"2024-02-28"},"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":"Organization 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":"Organization 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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/AppData20220311"},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/AppPostRequest20220311"}}},"description":"app to be created"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostResponse20220311"}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/AppId"},{"$ref":"#/components/parameters/Version"}],"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 requested 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret"},"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"}},"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Revoke app authorization for an Snyk Organization 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"},"/orgs/{org_id}/apps/installs/{install_id}/secrets":{"post":{"description":"Manage client secret for non-interactive Snyk App installations.","operationId":"updateOrgAppInstallSecret","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ClientId"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"The requested 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ClientId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPatchRequest20220311"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData20220311"},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$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,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret20220311"},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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"},{"description":"Filter logs by project ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},{"$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","tags":["Collection"],"x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-version":"2023-09-12"},"post":{"description":"Create a collection","operationId":"createCollection","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/CreateCollectionRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"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"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned 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"},"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 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":{"properties":{"data":{"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"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned 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"},"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 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":{"properties":{"data":{"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"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned 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"},"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"},"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":"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"}}},"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":{"$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"}}}},"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"},"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":"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":{"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":{"$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/ImageId20231102"}],"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":{"$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","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/ImageId20231102"},{"$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":{"$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"},"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/OrgInvitation20240621"},"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","2024-06-21"],"x-snyk-api-version":"2024-06-21"},"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"}},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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/PathIssueId20240123"}],"responses":{"200":{"$ref":"#/components/responses/GetIssue20020240123"},"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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 currently restricted and is not available to all customers. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned; transitive vulnerabilities (from dependencies) are not included as they can vary depending on the context.","operationId":"listIssuesForManyPurls","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"}],"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":{"$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)","tags":["Issues"],"x-snyk-api-releases":["2023-01-04~experimental","2023-03-29~beta","2023-04-17","2023-08-21","2024-06-26"],"x-snyk-api-version":"2024-06-26"},"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"},{"$ref":"#/components/parameters/OrgId"},{"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":{"$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","2024-06-26"],"x-snyk-api-version":"2024-06-26"},"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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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":{"$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","2024-05-31"],"x-snyk-api-version":"2024-05-31"},"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"},{"$ref":"#/components/parameters/OrgId"},{"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","2024-08-15~beta","2024-08-22"],"x-snyk-api-version":"2023-03-20","x-snyk-deprecated-by":"2024-08-22","x-snyk-sunset-eligible":"2025-02-19"},"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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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 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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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":{"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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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 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":{"$ref":"#/components/schemas/ServiceAccount"},"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":{"$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.","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":{"$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":{"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":{"$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,"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":{"$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"}}},"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":{"$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","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":"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,"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":{"$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,"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":{"$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":{"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":{"$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"},"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":"Remove Slack settings override for a project.","tags":["SlackSettings"],"x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-version":"2022-12-14"},"patch":{"description":"Update Slack notification settings for a project.","operationId":"updateSlackProjectNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"},{"description":"Project ID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProjectSettingsPatchRequest"}}},"description":"Update existing project specific settings for a project."},"responses":{"200":{"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":"Slack notification settings for a project updated 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":{"$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"}},{"$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/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"},"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 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,"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":{"$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,"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":{"$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,"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"}}},"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","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"},{"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":{"$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,"properties":{"data":{"$ref":"#/components/schemas/PublicTarget"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single target is returned 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":{"$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":{"properties":{"data":{"$ref":"#/components/schemas/Principal20240422"},"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"}}},"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,"properties":{"data":{"items":{"$ref":"#/components/schemas/PublicApp"},"type":"array"},"jsonapi":{"$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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"$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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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,"properties":{"data":{"items":{"$ref":"#/components/schemas/SessionData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi"],"type":"object"}}},"description":"A list of active OAuth sessions for the 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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"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":{"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.","headers":{"deprecation":{"description":"A header containing the deprecation date of the 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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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":{"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","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"},"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. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Revoke an active user app session.","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"}},"security":[{"BearerAuth":[]},{"APIToken":[]}],"servers":[{"description":"Snyk REST API","url":"https://api.snyk.io/rest"}],"tags":[{"description":"Third-party Apps that integrate with the Snyk platform. See our [overview documentation](https://docs.snyk.io/integrations/snyk-apps) for more details.","name":"Apps"},{"description":"Audit Logs","name":"Audit Logs"},{"description":"User-defined collections of projects","name":"Collection"},{"description":"Container Image resource","name":"ContainerImage"},{"description":"Through the Custom Base Image Recommendation feature, Snyk can recommend an image upgrade from a pool of the your internal images. \nThis allows your teams to be notified of newer and more secure versions of internal base images.\n\nNotable changes to this API resource:\n- starting with version \"2023-09-20\", the `GET` `/custom_base_images` endpoint requires the `repository` filter when sorting by `version`.\n- starting with version \"2024-01-04\", `VersioningSchema` objects with `type` `\"date\"` are no longer supported. Snyk recommends updating custom base images with the deprecated type to `\"single-selection\"`.\n","name":"Custom Base Images"},{"description":"Infrastructure as Code Settings.","name":"IacSettings"},{"description":"Organization Invites.","name":"Invites"},{"description":"Issues discovered in projects.","name":"Issues"},{"description":"The OpenAPI specification for slack-app.","name":"OpenAPI"},{"description":"An Organization is the lowest level of Snyk's tenancy hierarchy, and may contain projects and other data.","name":"Orgs"},{"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.","name":"Pull Request Templates"},{"description":"A Software Bill of Materials document","name":"SBOM"},{"description":"SAST Settings modifications for an org","name":"SastSettings"},{"description":"Service accounts can be used for continuous integration (CI) and other automation purposes, without using an actual Snyk user’s token.","name":"ServiceAccounts"},{"description":"Slack integration configuration.","name":"Slack"},{"description":"Slack app integration settings.","name":"SlackSettings"},{"description":"Snyk Users","name":"Users"}],"x-cerberus":{"authentication":{"strategies":[{"InternalJWT":{}}]},"enableAccessAudit":true},"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-06-26"} ================================================ FILE: testing/sbom.cyclonedx-1.5.json ================================================ { "bomFormat": "CycloneDX", "specVersion": "1.5", "serialNumber": "urn:uuid:2bc89cc4-93e1-42cc-a0b6-5f6a305161fe", "version": 1, "metadata": { "timestamp": "2024-02-19T15:41:53.826Z", "tools": { "components": [ { "group": "@cyclonedx", "name": "cdxgen", "version": "10.1.2", "purl": "pkg:npm/%40cyclonedx/cdxgen@10.1.2", "type": "application", "bom-ref": "pkg:npm/@cyclonedx/cdxgen@10.1.2", "author": "OWASP Foundation", "publisher": "OWASP Foundation" } ] }, "authors": [ { "name": "OWASP Foundation" } ], "lifecycles": [ { "phase": "build" } ], "component": { "group": "", "name": "parlay-test", "version": "0.1.0", "type": "application", "purl": "pkg:npm/parlay-test@0.1.0", "bom-ref": "pkg:npm/parlay-test@0.1.0", "components": [] } }, "components": [ { "group": "", "name": "react", "version": "18.2.0", "scope": "required", "hashes": [ { "alg": "SHA-512", "content": "ff722331d6f62fd41b05d5a25b97b73f6fe7a70301694f661c24825333659f464261b71f4ec19b4c9ad4fe419e99d1f6216981da2a19fb3931b66aba834f5f19" } ], "purl": "pkg:npm/react@18.2.0", "type": "framework", "bom-ref": "pkg:npm/react@18.2.0", "evidence": { "identity": { "field": "purl", "confidence": 1, "methods": [ { "technique": "manifest-analysis", "confidence": 1, "value": "/Users/roscapaul/Documents/Playground/parlay-test/package-lock.json" } ] }, "occurrences": [ { "location": "src/index.js#1" } ] }, "properties": [ { "name": "SrcFile", "value": "/Users/roscapaul/Documents/Playground/parlay-test/package-lock.json" }, { "name": "ResolvedUrl", "value": "https://registry.npmjs.org/react/-/react-18.2.0.tgz" }, { "name": "ImportedModules", "value": "react" } ] }, { "group": "", "name": "loose-envify", "version": "1.4.0", "scope": "optional", "hashes": [ { "alg": "SHA-512", "content": "972bb13c6aff59f86b95e9b608bfd472751cd7372a280226043cee918ed8e45ff242235d928ebe7d12debe5c351e03324b0edfeb5d54218e34f04b71452a0add" } ], "purl": "pkg:npm/loose-envify@1.4.0", "type": "library", "bom-ref": "pkg:npm/loose-envify@1.4.0", "evidence": { "identity": { "field": "purl", "confidence": 1, "methods": [ { "technique": "manifest-analysis", "confidence": 1, "value": "/Users/roscapaul/Documents/Playground/parlay-test/package-lock.json" } ] } }, "properties": [ { "name": "SrcFile", "value": "/Users/roscapaul/Documents/Playground/parlay-test/package-lock.json" }, { "name": "ResolvedUrl", "value": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz" } ] }, { "group": "", "name": "js-tokens", "version": "4.0.0", "scope": "optional", "hashes": [ { "alg": "SHA-512", "content": "45d2547e5704ddc5332a232a420b02bb4e853eef5474824ed1b7986cf84737893a6a9809b627dca02b53f5b7313a9601b690f690233a49bce0e026aeb16fcf29" } ], "purl": "pkg:npm/js-tokens@4.0.0", "type": "library", "bom-ref": "pkg:npm/js-tokens@4.0.0", "evidence": { "identity": { "field": "purl", "confidence": 1, "methods": [ { "technique": "manifest-analysis", "confidence": 1, "value": "/Users/roscapaul/Documents/Playground/parlay-test/package-lock.json" } ] } }, "properties": [ { "name": "SrcFile", "value": "/Users/roscapaul/Documents/Playground/parlay-test/package-lock.json" }, { "name": "ResolvedUrl", "value": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz" } ] } ], "services": [], "dependencies": [ { "ref": "pkg:npm/js-tokens@4.0.0", "dependsOn": [] }, { "ref": "pkg:npm/loose-envify@1.4.0", "dependsOn": [ "pkg:npm/js-tokens@4.0.0" ] }, { "ref": "pkg:npm/react@18.2.0", "dependsOn": [ "pkg:npm/loose-envify@1.4.0" ] }, { "ref": "pkg:npm/parlay-test@0.1.0", "dependsOn": [ "pkg:npm/react@18.2.0" ] } ] } ================================================ FILE: testing/sbom.cyclonedx.json ================================================ {"bomFormat":"CycloneDX","specVersion":"1.4","version":1,"metadata":{"timestamp":"2023-04-11T06:14:27Z","tools":[{"vendor":"Snyk","name":"Snyk Open Source"}],"component":{"bom-ref":"1-snykin@0.1.0","type":"application","name":"snykin","version":"0.1.0","purl":"pkg:npm/snykin@0.1.0"}},"components":[{"bom-ref":"2-mime-db@1.52.0","type":"library","name":"mime-db","version":"1.52.0","purl":"pkg:npm/mime-db@1.52.0"},{"bom-ref":"3-mime-types@2.1.35","type":"library","name":"mime-types","version":"2.1.35","purl":"pkg:npm/mime-types@2.1.35"},{"bom-ref":"4-negotiator@0.6.3","type":"library","name":"negotiator","version":"0.6.3","purl":"pkg:npm/negotiator@0.6.3"},{"bom-ref":"5-accepts@1.3.8","type":"library","name":"accepts","version":"1.3.8","purl":"pkg:npm/accepts@1.3.8"},{"bom-ref":"6-array-flatten@1.1.1","type":"library","name":"array-flatten","version":"1.1.1","purl":"pkg:npm/array-flatten@1.1.1"},{"bom-ref":"7-bytes@3.1.2","type":"library","name":"bytes","version":"3.1.2","purl":"pkg:npm/bytes@3.1.2"},{"bom-ref":"8-content-type@1.0.4","type":"library","name":"content-type","version":"1.0.4","purl":"pkg:npm/content-type@1.0.4"},{"bom-ref":"9-ms@2.0.0","type":"library","name":"ms","version":"2.0.0","purl":"pkg:npm/ms@2.0.0"},{"bom-ref":"10-debug@2.6.9","type":"library","name":"debug","version":"2.6.9","purl":"pkg:npm/debug@2.6.9"},{"bom-ref":"11-depd@2.0.0","type":"library","name":"depd","version":"2.0.0","purl":"pkg:npm/depd@2.0.0"},{"bom-ref":"12-destroy@1.2.0","type":"library","name":"destroy","version":"1.2.0","purl":"pkg:npm/destroy@1.2.0"},{"bom-ref":"13-inherits@2.0.4","type":"library","name":"inherits","version":"2.0.4","purl":"pkg:npm/inherits@2.0.4"},{"bom-ref":"14-setprototypeof@1.2.0","type":"library","name":"setprototypeof","version":"1.2.0","purl":"pkg:npm/setprototypeof@1.2.0"},{"bom-ref":"15-statuses@2.0.1","type":"library","name":"statuses","version":"2.0.1","purl":"pkg:npm/statuses@2.0.1"},{"bom-ref":"16-toidentifier@1.0.1","type":"library","name":"toidentifier","version":"1.0.1","purl":"pkg:npm/toidentifier@1.0.1"},{"bom-ref":"17-http-errors@2.0.0","type":"library","name":"http-errors","version":"2.0.0","purl":"pkg:npm/http-errors@2.0.0"},{"bom-ref":"18-safer-buffer@2.1.2","type":"library","name":"safer-buffer","version":"2.1.2","purl":"pkg:npm/safer-buffer@2.1.2"},{"bom-ref":"19-iconv-lite@0.4.24","type":"library","name":"iconv-lite","version":"0.4.24","purl":"pkg:npm/iconv-lite@0.4.24"},{"bom-ref":"20-ee-first@1.1.1","type":"library","name":"ee-first","version":"1.1.1","purl":"pkg:npm/ee-first@1.1.1"},{"bom-ref":"21-on-finished@2.4.1","type":"library","name":"on-finished","version":"2.4.1","purl":"pkg:npm/on-finished@2.4.1"},{"bom-ref":"22-function-bind@1.1.1","type":"library","name":"function-bind","version":"1.1.1","purl":"pkg:npm/function-bind@1.1.1"},{"bom-ref":"23-has@1.0.3","type":"library","name":"has","version":"1.0.3","purl":"pkg:npm/has@1.0.3"},{"bom-ref":"24-has-symbols@1.0.3","type":"library","name":"has-symbols","version":"1.0.3","purl":"pkg:npm/has-symbols@1.0.3"},{"bom-ref":"25-get-intrinsic@1.1.2","type":"library","name":"get-intrinsic","version":"1.1.2","purl":"pkg:npm/get-intrinsic@1.1.2"},{"bom-ref":"26-call-bind@1.0.2","type":"library","name":"call-bind","version":"1.0.2","purl":"pkg:npm/call-bind@1.0.2"},{"bom-ref":"27-object-inspect@1.12.2","type":"library","name":"object-inspect","version":"1.12.2","purl":"pkg:npm/object-inspect@1.12.2"},{"bom-ref":"28-side-channel@1.0.4","type":"library","name":"side-channel","version":"1.0.4","purl":"pkg:npm/side-channel@1.0.4"},{"bom-ref":"29-qs@6.10.3","type":"library","name":"qs","version":"6.10.3","purl":"pkg:npm/qs@6.10.3"},{"bom-ref":"30-unpipe@1.0.0","type":"library","name":"unpipe","version":"1.0.0","purl":"pkg:npm/unpipe@1.0.0"},{"bom-ref":"31-raw-body@2.5.1","type":"library","name":"raw-body","version":"2.5.1","purl":"pkg:npm/raw-body@2.5.1"},{"bom-ref":"32-media-typer@0.3.0","type":"library","name":"media-typer","version":"0.3.0","purl":"pkg:npm/media-typer@0.3.0"},{"bom-ref":"33-type-is@1.6.18","type":"library","name":"type-is","version":"1.6.18","purl":"pkg:npm/type-is@1.6.18"},{"bom-ref":"34-body-parser@1.20.0","type":"library","name":"body-parser","version":"1.20.0","purl":"pkg:npm/body-parser@1.20.0"},{"bom-ref":"35-safe-buffer@5.2.1","type":"library","name":"safe-buffer","version":"5.2.1","purl":"pkg:npm/safe-buffer@5.2.1"},{"bom-ref":"36-content-disposition@0.5.4","type":"library","name":"content-disposition","version":"0.5.4","purl":"pkg:npm/content-disposition@0.5.4"},{"bom-ref":"37-cookie@0.5.0","type":"library","name":"cookie","version":"0.5.0","purl":"pkg:npm/cookie@0.5.0"},{"bom-ref":"38-cookie-signature@1.0.6","type":"library","name":"cookie-signature","version":"1.0.6","purl":"pkg:npm/cookie-signature@1.0.6"},{"bom-ref":"39-encodeurl@1.0.2","type":"library","name":"encodeurl","version":"1.0.2","purl":"pkg:npm/encodeurl@1.0.2"},{"bom-ref":"40-escape-html@1.0.3","type":"library","name":"escape-html","version":"1.0.3","purl":"pkg:npm/escape-html@1.0.3"},{"bom-ref":"41-etag@1.8.1","type":"library","name":"etag","version":"1.8.1","purl":"pkg:npm/etag@1.8.1"},{"bom-ref":"42-parseurl@1.3.3","type":"library","name":"parseurl","version":"1.3.3","purl":"pkg:npm/parseurl@1.3.3"},{"bom-ref":"43-finalhandler@1.2.0","type":"library","name":"finalhandler","version":"1.2.0","purl":"pkg:npm/finalhandler@1.2.0"},{"bom-ref":"44-fresh@0.5.2","type":"library","name":"fresh","version":"0.5.2","purl":"pkg:npm/fresh@0.5.2"},{"bom-ref":"45-merge-descriptors@1.0.1","type":"library","name":"merge-descriptors","version":"1.0.1","purl":"pkg:npm/merge-descriptors@1.0.1"},{"bom-ref":"46-methods@1.1.2","type":"library","name":"methods","version":"1.1.2","purl":"pkg:npm/methods@1.1.2"},{"bom-ref":"47-path-to-regexp@0.1.7","type":"library","name":"path-to-regexp","version":"0.1.7","purl":"pkg:npm/path-to-regexp@0.1.7"},{"bom-ref":"48-forwarded@0.2.0","type":"library","name":"forwarded","version":"0.2.0","purl":"pkg:npm/forwarded@0.2.0"},{"bom-ref":"49-ipaddr.js@1.9.1","type":"library","name":"ipaddr.js","version":"1.9.1","purl":"pkg:npm/ipaddr.js@1.9.1"},{"bom-ref":"50-proxy-addr@2.0.7","type":"library","name":"proxy-addr","version":"2.0.7","purl":"pkg:npm/proxy-addr@2.0.7"},{"bom-ref":"51-range-parser@1.2.1","type":"library","name":"range-parser","version":"1.2.1","purl":"pkg:npm/range-parser@1.2.1"},{"bom-ref":"52-mime@1.6.0","type":"library","name":"mime","version":"1.6.0","purl":"pkg:npm/mime@1.6.0"},{"bom-ref":"53-ms@2.1.3","type":"library","name":"ms","version":"2.1.3","purl":"pkg:npm/ms@2.1.3"},{"bom-ref":"54-send@0.18.0","type":"library","name":"send","version":"0.18.0","purl":"pkg:npm/send@0.18.0"},{"bom-ref":"55-serve-static@1.15.0","type":"library","name":"serve-static","version":"1.15.0","purl":"pkg:npm/serve-static@1.15.0"},{"bom-ref":"56-utils-merge@1.0.1","type":"library","name":"utils-merge","version":"1.0.1","purl":"pkg:npm/utils-merge@1.0.1"},{"bom-ref":"57-vary@1.1.2","type":"library","name":"vary","version":"1.1.2","purl":"pkg:npm/vary@1.1.2"},{"bom-ref":"58-express@4.18.1","type":"library","name":"express","version":"4.18.1","purl":"pkg:npm/express@4.18.1"},{"bom-ref":"59-hoek@6.1.3","type":"library","name":"hoek","version":"6.1.3","purl":"pkg:npm/hoek@6.1.3"},{"bom-ref":"60-boom@7.3.0","type":"library","name":"boom","version":"7.3.0","purl":"pkg:npm/boom@7.3.0"},{"bom-ref":"61-bourne@1.1.2","type":"library","name":"bourne","version":"1.1.2","purl":"pkg:npm/bourne@1.1.2"},{"bom-ref":"62-content@4.0.6","type":"library","name":"content","version":"4.0.6","purl":"pkg:npm/content@4.0.6"},{"bom-ref":"63-b64@4.1.2","type":"library","name":"b64","version":"4.1.2","purl":"pkg:npm/b64@4.1.2"},{"bom-ref":"64-vise@3.0.2","type":"library","name":"vise","version":"3.0.2","purl":"pkg:npm/vise@3.0.2"},{"bom-ref":"65-nigel@3.0.4","type":"library","name":"nigel","version":"3.0.4","purl":"pkg:npm/nigel@3.0.4"},{"bom-ref":"66-pez@4.0.5","type":"library","name":"pez","version":"4.0.5","purl":"pkg:npm/pez@4.0.5"},{"bom-ref":"67-wreck@14.2.0","type":"library","name":"wreck","version":"14.2.0","purl":"pkg:npm/wreck@14.2.0"},{"bom-ref":"68-subtext@6.0.12","type":"library","name":"subtext","version":"6.0.12","purl":"pkg:npm/subtext@6.0.12"}],"dependencies":[{"ref":"1-snykin@0.1.0","dependsOn":["58-express@4.18.1","68-subtext@6.0.12"]},{"ref":"2-mime-db@1.52.0"},{"ref":"3-mime-types@2.1.35","dependsOn":["2-mime-db@1.52.0"]},{"ref":"4-negotiator@0.6.3"},{"ref":"5-accepts@1.3.8","dependsOn":["3-mime-types@2.1.35","4-negotiator@0.6.3"]},{"ref":"6-array-flatten@1.1.1"},{"ref":"7-bytes@3.1.2"},{"ref":"8-content-type@1.0.4"},{"ref":"9-ms@2.0.0"},{"ref":"10-debug@2.6.9","dependsOn":["9-ms@2.0.0"]},{"ref":"11-depd@2.0.0"},{"ref":"12-destroy@1.2.0"},{"ref":"13-inherits@2.0.4"},{"ref":"14-setprototypeof@1.2.0"},{"ref":"15-statuses@2.0.1"},{"ref":"16-toidentifier@1.0.1"},{"ref":"17-http-errors@2.0.0","dependsOn":["11-depd@2.0.0","13-inherits@2.0.4","14-setprototypeof@1.2.0","15-statuses@2.0.1","16-toidentifier@1.0.1"]},{"ref":"18-safer-buffer@2.1.2"},{"ref":"19-iconv-lite@0.4.24","dependsOn":["18-safer-buffer@2.1.2"]},{"ref":"20-ee-first@1.1.1"},{"ref":"21-on-finished@2.4.1","dependsOn":["20-ee-first@1.1.1"]},{"ref":"22-function-bind@1.1.1"},{"ref":"23-has@1.0.3","dependsOn":["22-function-bind@1.1.1"]},{"ref":"24-has-symbols@1.0.3"},{"ref":"25-get-intrinsic@1.1.2","dependsOn":["22-function-bind@1.1.1","23-has@1.0.3","24-has-symbols@1.0.3"]},{"ref":"26-call-bind@1.0.2","dependsOn":["22-function-bind@1.1.1","25-get-intrinsic@1.1.2"]},{"ref":"27-object-inspect@1.12.2"},{"ref":"28-side-channel@1.0.4","dependsOn":["26-call-bind@1.0.2","25-get-intrinsic@1.1.2","27-object-inspect@1.12.2"]},{"ref":"29-qs@6.10.3","dependsOn":["28-side-channel@1.0.4"]},{"ref":"30-unpipe@1.0.0"},{"ref":"31-raw-body@2.5.1","dependsOn":["7-bytes@3.1.2","17-http-errors@2.0.0","19-iconv-lite@0.4.24","30-unpipe@1.0.0"]},{"ref":"32-media-typer@0.3.0"},{"ref":"33-type-is@1.6.18","dependsOn":["32-media-typer@0.3.0","3-mime-types@2.1.35"]},{"ref":"34-body-parser@1.20.0","dependsOn":["7-bytes@3.1.2","8-content-type@1.0.4","10-debug@2.6.9","11-depd@2.0.0","12-destroy@1.2.0","17-http-errors@2.0.0","19-iconv-lite@0.4.24","21-on-finished@2.4.1","29-qs@6.10.3","31-raw-body@2.5.1","33-type-is@1.6.18","30-unpipe@1.0.0"]},{"ref":"35-safe-buffer@5.2.1"},{"ref":"36-content-disposition@0.5.4","dependsOn":["35-safe-buffer@5.2.1"]},{"ref":"37-cookie@0.5.0"},{"ref":"38-cookie-signature@1.0.6"},{"ref":"39-encodeurl@1.0.2"},{"ref":"40-escape-html@1.0.3"},{"ref":"41-etag@1.8.1"},{"ref":"42-parseurl@1.3.3"},{"ref":"43-finalhandler@1.2.0","dependsOn":["10-debug@2.6.9","39-encodeurl@1.0.2","40-escape-html@1.0.3","21-on-finished@2.4.1","42-parseurl@1.3.3","15-statuses@2.0.1","30-unpipe@1.0.0"]},{"ref":"44-fresh@0.5.2"},{"ref":"45-merge-descriptors@1.0.1"},{"ref":"46-methods@1.1.2"},{"ref":"47-path-to-regexp@0.1.7"},{"ref":"48-forwarded@0.2.0"},{"ref":"49-ipaddr.js@1.9.1"},{"ref":"50-proxy-addr@2.0.7","dependsOn":["48-forwarded@0.2.0","49-ipaddr.js@1.9.1"]},{"ref":"51-range-parser@1.2.1"},{"ref":"52-mime@1.6.0"},{"ref":"53-ms@2.1.3"},{"ref":"54-send@0.18.0","dependsOn":["10-debug@2.6.9","11-depd@2.0.0","12-destroy@1.2.0","39-encodeurl@1.0.2","40-escape-html@1.0.3","41-etag@1.8.1","44-fresh@0.5.2","17-http-errors@2.0.0","52-mime@1.6.0","53-ms@2.1.3","21-on-finished@2.4.1","51-range-parser@1.2.1","15-statuses@2.0.1"]},{"ref":"55-serve-static@1.15.0","dependsOn":["39-encodeurl@1.0.2","40-escape-html@1.0.3","42-parseurl@1.3.3","54-send@0.18.0"]},{"ref":"56-utils-merge@1.0.1"},{"ref":"57-vary@1.1.2"},{"ref":"58-express@4.18.1","dependsOn":["5-accepts@1.3.8","6-array-flatten@1.1.1","34-body-parser@1.20.0","36-content-disposition@0.5.4","8-content-type@1.0.4","37-cookie@0.5.0","38-cookie-signature@1.0.6","10-debug@2.6.9","11-depd@2.0.0","39-encodeurl@1.0.2","40-escape-html@1.0.3","41-etag@1.8.1","43-finalhandler@1.2.0","44-fresh@0.5.2","17-http-errors@2.0.0","45-merge-descriptors@1.0.1","46-methods@1.1.2","21-on-finished@2.4.1","42-parseurl@1.3.3","47-path-to-regexp@0.1.7","50-proxy-addr@2.0.7","29-qs@6.10.3","51-range-parser@1.2.1","35-safe-buffer@5.2.1","54-send@0.18.0","55-serve-static@1.15.0","14-setprototypeof@1.2.0","15-statuses@2.0.1","33-type-is@1.6.18","56-utils-merge@1.0.1","57-vary@1.1.2"]},{"ref":"59-hoek@6.1.3"},{"ref":"60-boom@7.3.0","dependsOn":["59-hoek@6.1.3"]},{"ref":"61-bourne@1.1.2"},{"ref":"62-content@4.0.6","dependsOn":["60-boom@7.3.0"]},{"ref":"63-b64@4.1.2","dependsOn":["59-hoek@6.1.3"]},{"ref":"64-vise@3.0.2","dependsOn":["59-hoek@6.1.3"]},{"ref":"65-nigel@3.0.4","dependsOn":["59-hoek@6.1.3","64-vise@3.0.2"]},{"ref":"66-pez@4.0.5","dependsOn":["63-b64@4.1.2","60-boom@7.3.0","62-content@4.0.6","59-hoek@6.1.3","65-nigel@3.0.4"]},{"ref":"67-wreck@14.2.0","dependsOn":["60-boom@7.3.0","61-bourne@1.1.2","59-hoek@6.1.3"]},{"ref":"68-subtext@6.0.12","dependsOn":["60-boom@7.3.0","61-bourne@1.1.2","62-content@4.0.6","59-hoek@6.1.3","66-pez@4.0.5","67-wreck@14.2.0"]}]} ================================================ FILE: testing/sbom.cyclonedx.xml ================================================ 2023-06-12T19:17:47ZSnykSnyk Open Sourcepackage-file-basic1.0.0pkg:npm/package-file-basic@1.0.0debug1.0.5pkg:npm/debug@1.0.5ms2.0.0pkg:npm/ms@2.0.0minimatch3.0.0pkg:npm/minimatch@3.0.0brace-expansion1.1.11pkg:npm/brace-expansion@1.1.11balanced-match1.0.2pkg:npm/balanced-match@1.0.2concat-map0.0.1pkg:npm/concat-map@0.0.1 ================================================ FILE: testing/sbom.spdx-2.3.json ================================================ { "spdxVersion": "SPDX-2.3", "dataLicense": "CC0-1.0", "SPDXID": "SPDXRef-DOCUMENT", "name": "package-file-basic@1.0.0", "documentNamespace": "32bfb85d-d34e-4a5b-a08d-5c295fbc9948", "creationInfo": { "licenseListVersion": "3.19", "creators": [ "Tool: Snyk Open Source", "Organization: Snyk" ], "created": "2000-01-01T00:00:00Z" }, "packages": [ { "name": "package-file-basic", "SPDXID": "SPDXRef-1-package-file-basic-1.0.0", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/package-file-basic@1.0.0" } ] }, { "name": "debug", "SPDXID": "SPDXRef-2-debug-1.0.5", "versionInfo": "1.0.5", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/debug@1.0.5" } ] }, { "name": "ms", "SPDXID": "SPDXRef-3-ms-2.0.0", "versionInfo": "2.0.0", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/ms@2.0.0" } ] }, { "name": "minimatch", "SPDXID": "SPDXRef-4-minimatch-3.0.0", "versionInfo": "3.0.0", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/minimatch@3.0.0" } ] }, { "name": "brace-expansion", "SPDXID": "SPDXRef-5-brace-expansion-1.1.11", "versionInfo": "1.1.11", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/brace-expansion@1.1.11" } ] }, { "name": "balanced-match", "SPDXID": "SPDXRef-6-balanced-match-1.0.2", "versionInfo": "1.0.2", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/balanced-match@1.0.2" } ] }, { "name": "concat-map", "SPDXID": "SPDXRef-7-concat-map-0.0.1", "versionInfo": "0.0.1", "downloadLocation": "NOASSERTION", "copyrightText": "NOASSERTION", "externalRefs": [ { "referenceCategory": "PACKAGE-MANAGER", "referenceType": "purl", "referenceLocator": "pkg:npm/concat-map@0.0.1" } ] } ], "relationships": [ { "spdxElementId": "SPDXRef-DOCUMENT", "relatedSpdxElement": "SPDXRef-1-package-file-basic-1.0.0", "relationshipType": "DESCRIBES" }, { "spdxElementId": "SPDXRef-2-debug-1.0.5", "relatedSpdxElement": "SPDXRef-1-package-file-basic-1.0.0", "relationshipType": "DEPENDENCY_OF" }, { "spdxElementId": "SPDXRef-4-minimatch-3.0.0", "relatedSpdxElement": "SPDXRef-1-package-file-basic-1.0.0", "relationshipType": "DEPENDENCY_OF" }, { "spdxElementId": "SPDXRef-3-ms-2.0.0", "relatedSpdxElement": "SPDXRef-2-debug-1.0.5", "relationshipType": "DEPENDENCY_OF" }, { "spdxElementId": "SPDXRef-5-brace-expansion-1.1.11", "relatedSpdxElement": "SPDXRef-4-minimatch-3.0.0", "relationshipType": "DEPENDENCY_OF" }, { "spdxElementId": "SPDXRef-6-balanced-match-1.0.2", "relatedSpdxElement": "SPDXRef-5-brace-expansion-1.1.11", "relationshipType": "DEPENDENCY_OF" }, { "spdxElementId": "SPDXRef-7-concat-map-0.0.1", "relatedSpdxElement": "SPDXRef-5-brace-expansion-1.1.11", "relationshipType": "DEPENDENCY_OF" } ] } ================================================ FILE: testing/sbom2.cyclonedx.json ================================================ {"bomFormat":"CycloneDX","specVersion":"1.4","version":1,"metadata":{"timestamp":"2023-04-22T09:07:39Z","tools":[{"vendor":"Snyk","name":"Snyk Open Source"}],"component":{"bom-ref":"1-io.pivotal.sporing:todo-list@0.0.1-SNAPSHOT","type":"application","name":"io.pivotal.sporing:todo-list","version":"0.0.1-SNAPSHOT","purl":"pkg:maven/io.pivotal.sporing/todo-list@0.0.1-SNAPSHOT"},"properties":[{"name":"snyk:org_id","value":"6d11b520-9f82-42e3-b60c-a4c23add7f77"},{"name":"snyk:project_id","value":"535ff486-222c-4d0f-84cc-60c13ec55c9d"}]},"components":[{"bom-ref":"2-com.h2database:h2@1.4.200","type":"library","name":"com.h2database:h2","version":"1.4.200","purl":"pkg:maven/com.h2database/h2@1.4.200"},{"bom-ref":"3-org.apache.logging.log4j:log4j-api@2.14.0","type":"library","name":"org.apache.logging.log4j:log4j-api","version":"2.14.0","purl":"pkg:maven/org.apache.logging.log4j/log4j-api@2.14.0"},{"bom-ref":"4-org.apache.logging.log4j:log4j-api@2.14.0","type":"library","name":"org.apache.logging.log4j:log4j-api","version":"2.14.0","purl":"pkg:maven/org.apache.logging.log4j/log4j-api@2.14.0"},{"bom-ref":"5-org.apache.logging.log4j:log4j-core@2.14.0","type":"library","name":"org.apache.logging.log4j:log4j-core","version":"2.14.0","purl":"pkg:maven/org.apache.logging.log4j/log4j-core@2.14.0"},{"bom-ref":"6-org.mariadb.jdbc:mariadb-java-client@1.8.0","type":"library","name":"org.mariadb.jdbc:mariadb-java-client","version":"1.8.0","purl":"pkg:maven/org.mariadb.jdbc/mariadb-java-client@1.8.0"},{"bom-ref":"7-org.projectlombok:lombok@1.18.20","type":"library","name":"org.projectlombok:lombok","version":"1.18.20","purl":"pkg:maven/org.projectlombok/lombok@1.18.20"},{"bom-ref":"8-org.springframework:spring-context@5.3.3","type":"library","name":"org.springframework:spring-context","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-context@5.3.3"},{"bom-ref":"9-org.springframework:spring-context@5.3.3","type":"library","name":"org.springframework:spring-context","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-context@5.3.3"},{"bom-ref":"10-org.springframework:spring-core@5.3.3","type":"library","name":"org.springframework:spring-core","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-core@5.3.3"},{"bom-ref":"11-org.springframework:spring-core@5.3.3","type":"library","name":"org.springframework:spring-core","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-core@5.3.3"},{"bom-ref":"12-org.springframework.boot:spring-boot@2.4.2","type":"library","name":"org.springframework.boot:spring-boot","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot@2.4.2"},{"bom-ref":"13-org.springframework.boot:spring-boot@2.4.2","type":"library","name":"org.springframework.boot:spring-boot","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot@2.4.2"},{"bom-ref":"14-org.springframework.boot:spring-boot-autoconfigure@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-autoconfigure","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-autoconfigure@2.4.2"},{"bom-ref":"15-org.springframework.boot:spring-boot-autoconfigure@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-autoconfigure","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-autoconfigure@2.4.2"},{"bom-ref":"16-org.springframework.boot:spring-boot-devtools@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-devtools","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-devtools@2.4.2"},{"bom-ref":"17-org.hdrhistogram:HdrHistogram@2.1.12","type":"library","name":"org.hdrhistogram:HdrHistogram","version":"2.1.12","purl":"pkg:maven/org.hdrhistogram/HdrHistogram@2.1.12"},{"bom-ref":"18-org.latencyutils:LatencyUtils@2.0.3","type":"library","name":"org.latencyutils:LatencyUtils","version":"2.0.3","purl":"pkg:maven/org.latencyutils/LatencyUtils@2.0.3"},{"bom-ref":"19-io.micrometer:micrometer-core@1.6.3","type":"library","name":"io.micrometer:micrometer-core","version":"1.6.3","purl":"pkg:maven/io.micrometer/micrometer-core@1.6.3"},{"bom-ref":"20-com.fasterxml.jackson.core:jackson-databind@2.11.4","type":"library","name":"com.fasterxml.jackson.core:jackson-databind","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.11.4"},{"bom-ref":"21-com.fasterxml.jackson.core:jackson-databind@2.11.4","type":"library","name":"com.fasterxml.jackson.core:jackson-databind","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.11.4"},{"bom-ref":"22-com.fasterxml.jackson.datatype:jackson-datatype-jsr310@2.11.4","type":"library","name":"com.fasterxml.jackson.datatype:jackson-datatype-jsr310","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310@2.11.4"},{"bom-ref":"23-com.fasterxml.jackson.datatype:jackson-datatype-jsr310@2.11.4","type":"library","name":"com.fasterxml.jackson.datatype:jackson-datatype-jsr310","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.datatype/jackson-datatype-jsr310@2.11.4"},{"bom-ref":"24-org.springframework.boot:spring-boot-actuator@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-actuator","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-actuator@2.4.2"},{"bom-ref":"25-org.springframework.boot:spring-boot-actuator-autoconfigure@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-actuator-autoconfigure","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-actuator-autoconfigure@2.4.2"},{"bom-ref":"26-org.springframework.boot:spring-boot-starter@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter@2.4.2"},{"bom-ref":"27-org.springframework.boot:spring-boot-starter@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter@2.4.2"},{"bom-ref":"28-org.springframework.boot:spring-boot-starter-actuator@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-actuator","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-actuator@2.4.2"},{"bom-ref":"29-jakarta.persistence:jakarta.persistence-api@2.2.3","type":"library","name":"jakarta.persistence:jakarta.persistence-api","version":"2.2.3","purl":"pkg:maven/jakarta.persistence/jakarta.persistence-api@2.2.3"},{"bom-ref":"30-jakarta.transaction:jakarta.transaction-api@1.3.3","type":"library","name":"jakarta.transaction:jakarta.transaction-api","version":"1.3.3","purl":"pkg:maven/jakarta.transaction/jakarta.transaction-api@1.3.3"},{"bom-ref":"31-antlr:antlr@2.7.7","type":"library","name":"antlr:antlr","version":"2.7.7","purl":"pkg:maven/antlr/antlr@2.7.7"},{"bom-ref":"32-com.fasterxml:classmate@1.5.1","type":"library","name":"com.fasterxml:classmate","version":"1.5.1","purl":"pkg:maven/com.fasterxml/classmate@1.5.1"},{"bom-ref":"33-net.bytebuddy:byte-buddy@1.10.19","type":"library","name":"net.bytebuddy:byte-buddy","version":"1.10.19","purl":"pkg:maven/net.bytebuddy/byte-buddy@1.10.19"},{"bom-ref":"34-org.dom4j:dom4j@2.1.3","type":"library","name":"org.dom4j:dom4j","version":"2.1.3","purl":"pkg:maven/org.dom4j/dom4j@2.1.3"},{"bom-ref":"35-com.sun.activation:jakarta.activation@1.2.2","type":"library","name":"com.sun.activation:jakarta.activation","version":"1.2.2","purl":"pkg:maven/com.sun.activation/jakarta.activation@1.2.2"},{"bom-ref":"36-com.sun.istack:istack-commons-runtime@3.0.11","type":"library","name":"com.sun.istack:istack-commons-runtime","version":"3.0.11","purl":"pkg:maven/com.sun.istack/istack-commons-runtime@3.0.11"},{"bom-ref":"37-jakarta.xml.bind:jakarta.xml.bind-api@2.3.3","type":"library","name":"jakarta.xml.bind:jakarta.xml.bind-api","version":"2.3.3","purl":"pkg:maven/jakarta.xml.bind/jakarta.xml.bind-api@2.3.3"},{"bom-ref":"38-org.glassfish.jaxb:txw2@2.3.3","type":"library","name":"org.glassfish.jaxb:txw2","version":"2.3.3","purl":"pkg:maven/org.glassfish.jaxb/txw2@2.3.3"},{"bom-ref":"39-org.glassfish.jaxb:jaxb-runtime@2.3.3","type":"library","name":"org.glassfish.jaxb:jaxb-runtime","version":"2.3.3","purl":"pkg:maven/org.glassfish.jaxb/jaxb-runtime@2.3.3"},{"bom-ref":"40-org.jboss.logging:jboss-logging@3.4.1.Final","type":"library","name":"org.jboss.logging:jboss-logging","version":"3.4.1.Final","purl":"pkg:maven/org.jboss.logging/jboss-logging@3.4.1.Final"},{"bom-ref":"41-org.jboss.logging:jboss-logging@3.4.1.Final","type":"library","name":"org.jboss.logging:jboss-logging","version":"3.4.1.Final","purl":"pkg:maven/org.jboss.logging/jboss-logging@3.4.1.Final"},{"bom-ref":"42-org.hibernate.common:hibernate-commons-annotations@5.1.2.Final","type":"library","name":"org.hibernate.common:hibernate-commons-annotations","version":"5.1.2.Final","purl":"pkg:maven/org.hibernate.common/hibernate-commons-annotations@5.1.2.Final"},{"bom-ref":"43-org.javassist:javassist@3.27.0-GA","type":"library","name":"org.javassist:javassist","version":"3.27.0-GA","purl":"pkg:maven/org.javassist/javassist@3.27.0-GA"},{"bom-ref":"44-org.jboss:jandex@2.1.3.Final","type":"library","name":"org.jboss:jandex","version":"2.1.3.Final","purl":"pkg:maven/org.jboss/jandex@2.1.3.Final"},{"bom-ref":"45-org.hibernate:hibernate-core@5.4.27.Final","type":"library","name":"org.hibernate:hibernate-core","version":"5.4.27.Final","purl":"pkg:maven/org.hibernate/hibernate-core@5.4.27.Final"},{"bom-ref":"46-org.aspectj:aspectjweaver@1.9.6","type":"library","name":"org.aspectj:aspectjweaver","version":"1.9.6","purl":"pkg:maven/org.aspectj/aspectjweaver@1.9.6"},{"bom-ref":"47-org.aspectj:aspectjweaver@1.9.6","type":"library","name":"org.aspectj:aspectjweaver","version":"1.9.6","purl":"pkg:maven/org.aspectj/aspectjweaver@1.9.6"},{"bom-ref":"48-org.springframework:spring-aop@5.3.3","type":"library","name":"org.springframework:spring-aop","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-aop@5.3.3"},{"bom-ref":"49-org.springframework:spring-aop@5.3.3","type":"library","name":"org.springframework:spring-aop","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-aop@5.3.3"},{"bom-ref":"50-org.springframework.boot:spring-boot-starter-aop@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-aop","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-aop@2.4.2"},{"bom-ref":"51-org.slf4j:slf4j-api@1.7.30","type":"library","name":"org.slf4j:slf4j-api","version":"1.7.30","purl":"pkg:maven/org.slf4j/slf4j-api@1.7.30"},{"bom-ref":"52-org.slf4j:slf4j-api@1.7.30","type":"library","name":"org.slf4j:slf4j-api","version":"1.7.30","purl":"pkg:maven/org.slf4j/slf4j-api@1.7.30"},{"bom-ref":"53-com.zaxxer:HikariCP@3.4.5","type":"library","name":"com.zaxxer:HikariCP","version":"3.4.5","purl":"pkg:maven/com.zaxxer/HikariCP@3.4.5"},{"bom-ref":"54-org.springframework:spring-beans@5.3.3","type":"library","name":"org.springframework:spring-beans","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-beans@5.3.3"},{"bom-ref":"55-org.springframework:spring-beans@5.3.3","type":"library","name":"org.springframework:spring-beans","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-beans@5.3.3"},{"bom-ref":"56-org.springframework:spring-tx@5.3.3","type":"library","name":"org.springframework:spring-tx","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-tx@5.3.3"},{"bom-ref":"57-org.springframework:spring-tx@5.3.3","type":"library","name":"org.springframework:spring-tx","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-tx@5.3.3"},{"bom-ref":"58-org.springframework:spring-jdbc@5.3.3","type":"library","name":"org.springframework:spring-jdbc","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-jdbc@5.3.3"},{"bom-ref":"59-org.springframework:spring-jdbc@5.3.3","type":"library","name":"org.springframework:spring-jdbc","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-jdbc@5.3.3"},{"bom-ref":"60-org.springframework.boot:spring-boot-starter-jdbc@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-jdbc","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-jdbc@2.4.2"},{"bom-ref":"61-org.springframework.data:spring-data-commons@2.4.3","type":"library","name":"org.springframework.data:spring-data-commons","version":"2.4.3","purl":"pkg:maven/org.springframework.data/spring-data-commons@2.4.3"},{"bom-ref":"62-org.springframework:spring-expression@5.3.3","type":"library","name":"org.springframework:spring-expression","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-expression@5.3.3"},{"bom-ref":"63-org.springframework:spring-expression@5.3.3","type":"library","name":"org.springframework:spring-expression","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-expression@5.3.3"},{"bom-ref":"64-org.springframework:spring-jcl@5.3.3","type":"library","name":"org.springframework:spring-jcl","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-jcl@5.3.3"},{"bom-ref":"65-org.springframework:spring-orm@5.3.3","type":"library","name":"org.springframework:spring-orm","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-orm@5.3.3"},{"bom-ref":"66-org.springframework.data:spring-data-jpa@2.4.3","type":"library","name":"org.springframework.data:spring-data-jpa","version":"2.4.3","purl":"pkg:maven/org.springframework.data/spring-data-jpa@2.4.3"},{"bom-ref":"67-org.springframework:spring-aspects@5.3.3","type":"library","name":"org.springframework:spring-aspects","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-aspects@5.3.3"},{"bom-ref":"68-org.springframework.boot:spring-boot-starter-data-jpa@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-data-jpa","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-data-jpa@2.4.2"},{"bom-ref":"69-org.springframework.security:spring-security-core@5.4.2","type":"library","name":"org.springframework.security:spring-security-core","version":"5.4.2","purl":"pkg:maven/org.springframework.security/spring-security-core@5.4.2"},{"bom-ref":"70-org.springframework.security:spring-security-core@5.4.2","type":"library","name":"org.springframework.security:spring-security-core","version":"5.4.2","purl":"pkg:maven/org.springframework.security/spring-security-core@5.4.2"},{"bom-ref":"71-org.springframework.security:spring-security-config@5.4.2","type":"library","name":"org.springframework.security:spring-security-config","version":"5.4.2","purl":"pkg:maven/org.springframework.security/spring-security-config@5.4.2"},{"bom-ref":"72-org.springframework:spring-web@5.3.3","type":"library","name":"org.springframework:spring-web","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-web@5.3.3"},{"bom-ref":"73-org.springframework:spring-web@5.3.3","type":"library","name":"org.springframework:spring-web","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-web@5.3.3"},{"bom-ref":"74-org.springframework.security:spring-security-web@5.4.2","type":"library","name":"org.springframework.security:spring-security-web","version":"5.4.2","purl":"pkg:maven/org.springframework.security/spring-security-web@5.4.2"},{"bom-ref":"75-org.springframework.boot:spring-boot-starter-security@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-security","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-security@2.4.2"},{"bom-ref":"76-jakarta.annotation:jakarta.annotation-api@1.3.5","type":"library","name":"jakarta.annotation:jakarta.annotation-api","version":"1.3.5","purl":"pkg:maven/jakarta.annotation/jakarta.annotation-api@1.3.5"},{"bom-ref":"77-jakarta.annotation:jakarta.annotation-api@1.3.5","type":"library","name":"jakarta.annotation:jakarta.annotation-api","version":"1.3.5","purl":"pkg:maven/jakarta.annotation/jakarta.annotation-api@1.3.5"},{"bom-ref":"78-ch.qos.logback:logback-core@1.2.3","type":"library","name":"ch.qos.logback:logback-core","version":"1.2.3","purl":"pkg:maven/ch.qos.logback/logback-core@1.2.3"},{"bom-ref":"79-ch.qos.logback:logback-classic@1.2.3","type":"library","name":"ch.qos.logback:logback-classic","version":"1.2.3","purl":"pkg:maven/ch.qos.logback/logback-classic@1.2.3"},{"bom-ref":"80-org.apache.logging.log4j:log4j-to-slf4j@2.13.3","type":"library","name":"org.apache.logging.log4j:log4j-to-slf4j","version":"2.13.3","purl":"pkg:maven/org.apache.logging.log4j/log4j-to-slf4j@2.13.3"},{"bom-ref":"81-org.slf4j:jul-to-slf4j@1.7.30","type":"library","name":"org.slf4j:jul-to-slf4j","version":"1.7.30","purl":"pkg:maven/org.slf4j/jul-to-slf4j@1.7.30"},{"bom-ref":"82-org.springframework.boot:spring-boot-starter-logging@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-logging","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-logging@2.4.2"},{"bom-ref":"83-org.yaml:snakeyaml@1.27","type":"library","name":"org.yaml:snakeyaml","version":"1.27","purl":"pkg:maven/org.yaml/snakeyaml@1.27"},{"bom-ref":"84-org.thymeleaf:thymeleaf@3.0.12.RELEASE","type":"library","name":"org.thymeleaf:thymeleaf","version":"3.0.12.RELEASE","purl":"pkg:maven/org.thymeleaf/thymeleaf@3.0.12.RELEASE"},{"bom-ref":"85-org.thymeleaf:thymeleaf@3.0.12.RELEASE","type":"library","name":"org.thymeleaf:thymeleaf","version":"3.0.12.RELEASE","purl":"pkg:maven/org.thymeleaf/thymeleaf@3.0.12.RELEASE"},{"bom-ref":"86-org.thymeleaf.extras:thymeleaf-extras-java8time@3.0.4.RELEASE","type":"library","name":"org.thymeleaf.extras:thymeleaf-extras-java8time","version":"3.0.4.RELEASE","purl":"pkg:maven/org.thymeleaf.extras/thymeleaf-extras-java8time@3.0.4.RELEASE"},{"bom-ref":"87-org.attoparser:attoparser@2.0.5.RELEASE","type":"library","name":"org.attoparser:attoparser","version":"2.0.5.RELEASE","purl":"pkg:maven/org.attoparser/attoparser@2.0.5.RELEASE"},{"bom-ref":"88-org.unbescape:unbescape@1.1.6.RELEASE","type":"library","name":"org.unbescape:unbescape","version":"1.1.6.RELEASE","purl":"pkg:maven/org.unbescape/unbescape@1.1.6.RELEASE"},{"bom-ref":"89-org.thymeleaf:thymeleaf-spring5@3.0.12.RELEASE","type":"library","name":"org.thymeleaf:thymeleaf-spring5","version":"3.0.12.RELEASE","purl":"pkg:maven/org.thymeleaf/thymeleaf-spring5@3.0.12.RELEASE"},{"bom-ref":"90-org.springframework.boot:spring-boot-starter-thymeleaf@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-thymeleaf","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-thymeleaf@2.4.2"},{"bom-ref":"91-com.fasterxml.jackson.core:jackson-annotations@2.11.4","type":"library","name":"com.fasterxml.jackson.core:jackson-annotations","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.core/jackson-annotations@2.11.4"},{"bom-ref":"92-com.fasterxml.jackson.core:jackson-annotations@2.11.4","type":"library","name":"com.fasterxml.jackson.core:jackson-annotations","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.core/jackson-annotations@2.11.4"},{"bom-ref":"93-com.fasterxml.jackson.core:jackson-core@2.11.4","type":"library","name":"com.fasterxml.jackson.core:jackson-core","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.core/jackson-core@2.11.4"},{"bom-ref":"94-com.fasterxml.jackson.core:jackson-core@2.11.4","type":"library","name":"com.fasterxml.jackson.core:jackson-core","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.core/jackson-core@2.11.4"},{"bom-ref":"95-com.fasterxml.jackson.datatype:jackson-datatype-jdk8@2.11.4","type":"library","name":"com.fasterxml.jackson.datatype:jackson-datatype-jdk8","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.datatype/jackson-datatype-jdk8@2.11.4"},{"bom-ref":"96-com.fasterxml.jackson.module:jackson-module-parameter-names@2.11.4","type":"library","name":"com.fasterxml.jackson.module:jackson-module-parameter-names","version":"2.11.4","purl":"pkg:maven/com.fasterxml.jackson.module/jackson-module-parameter-names@2.11.4"},{"bom-ref":"97-org.springframework.boot:spring-boot-starter-json@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-json","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-json@2.4.2"},{"bom-ref":"98-org.apache.tomcat.embed:tomcat-embed-core@9.0.41","type":"library","name":"org.apache.tomcat.embed:tomcat-embed-core","version":"9.0.41","purl":"pkg:maven/org.apache.tomcat.embed/tomcat-embed-core@9.0.41"},{"bom-ref":"99-org.apache.tomcat.embed:tomcat-embed-core@9.0.41","type":"library","name":"org.apache.tomcat.embed:tomcat-embed-core","version":"9.0.41","purl":"pkg:maven/org.apache.tomcat.embed/tomcat-embed-core@9.0.41"},{"bom-ref":"100-org.apache.tomcat.embed:tomcat-embed-websocket@9.0.41","type":"library","name":"org.apache.tomcat.embed:tomcat-embed-websocket","version":"9.0.41","purl":"pkg:maven/org.apache.tomcat.embed/tomcat-embed-websocket@9.0.41"},{"bom-ref":"101-org.glassfish:jakarta.el@3.0.3","type":"library","name":"org.glassfish:jakarta.el","version":"3.0.3","purl":"pkg:maven/org.glassfish/jakarta.el@3.0.3"},{"bom-ref":"102-org.springframework.boot:spring-boot-starter-tomcat@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-tomcat","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-tomcat@2.4.2"},{"bom-ref":"103-org.springframework:spring-webmvc@5.3.3","type":"library","name":"org.springframework:spring-webmvc","version":"5.3.3","purl":"pkg:maven/org.springframework/spring-webmvc@5.3.3"},{"bom-ref":"104-org.springframework.boot:spring-boot-starter-web@2.4.2","type":"library","name":"org.springframework.boot:spring-boot-starter-web","version":"2.4.2","purl":"pkg:maven/org.springframework.boot/spring-boot-starter-web@2.4.2"},{"bom-ref":"105-org.zeroturnaround:zt-zip@1.12","type":"library","name":"org.zeroturnaround:zt-zip","version":"1.12","purl":"pkg:maven/org.zeroturnaround/zt-zip@1.12"}],"dependencies":[{"ref":"1-io.pivotal.sporing:todo-list@0.0.1-SNAPSHOT","dependsOn":["2-com.h2database:h2@1.4.200","3-org.apache.logging.log4j:log4j-api@2.14.0","5-org.apache.logging.log4j:log4j-core@2.14.0","6-org.mariadb.jdbc:mariadb-java-client@1.8.0","7-org.projectlombok:lombok@1.18.20","16-org.springframework.boot:spring-boot-devtools@2.4.2","28-org.springframework.boot:spring-boot-starter-actuator@2.4.2","68-org.springframework.boot:spring-boot-starter-data-jpa@2.4.2","75-org.springframework.boot:spring-boot-starter-security@2.4.2","90-org.springframework.boot:spring-boot-starter-thymeleaf@2.4.2","104-org.springframework.boot:spring-boot-starter-web@2.4.2","105-org.zeroturnaround:zt-zip@1.12"]},{"ref":"2-com.h2database:h2@1.4.200"},{"ref":"3-org.apache.logging.log4j:log4j-api@2.14.0"},{"ref":"4-org.apache.logging.log4j:log4j-api@2.14.0"},{"ref":"5-org.apache.logging.log4j:log4j-core@2.14.0","dependsOn":["4-org.apache.logging.log4j:log4j-api@2.14.0"]},{"ref":"6-org.mariadb.jdbc:mariadb-java-client@1.8.0"},{"ref":"7-org.projectlombok:lombok@1.18.20"},{"ref":"8-org.springframework:spring-context@5.3.3"},{"ref":"9-org.springframework:spring-context@5.3.3","dependsOn":["48-org.springframework:spring-aop@5.3.3","54-org.springframework:spring-beans@5.3.3","10-org.springframework:spring-core@5.3.3","62-org.springframework:spring-expression@5.3.3"]},{"ref":"10-org.springframework:spring-core@5.3.3"},{"ref":"11-org.springframework:spring-core@5.3.3","dependsOn":["64-org.springframework:spring-jcl@5.3.3"]},{"ref":"12-org.springframework.boot:spring-boot@2.4.2","dependsOn":["8-org.springframework:spring-context@5.3.3","10-org.springframework:spring-core@5.3.3"]},{"ref":"13-org.springframework.boot:spring-boot@2.4.2"},{"ref":"14-org.springframework.boot:spring-boot-autoconfigure@2.4.2","dependsOn":["13-org.springframework.boot:spring-boot@2.4.2"]},{"ref":"15-org.springframework.boot:spring-boot-autoconfigure@2.4.2"},{"ref":"16-org.springframework.boot:spring-boot-devtools@2.4.2","dependsOn":["12-org.springframework.boot:spring-boot@2.4.2","14-org.springframework.boot:spring-boot-autoconfigure@2.4.2"]},{"ref":"17-org.hdrhistogram:HdrHistogram@2.1.12"},{"ref":"18-org.latencyutils:LatencyUtils@2.0.3"},{"ref":"19-io.micrometer:micrometer-core@1.6.3","dependsOn":["17-org.hdrhistogram:HdrHistogram@2.1.12","18-org.latencyutils:LatencyUtils@2.0.3"]},{"ref":"20-com.fasterxml.jackson.core:jackson-databind@2.11.4"},{"ref":"21-com.fasterxml.jackson.core:jackson-databind@2.11.4","dependsOn":["91-com.fasterxml.jackson.core:jackson-annotations@2.11.4","93-com.fasterxml.jackson.core:jackson-core@2.11.4"]},{"ref":"22-com.fasterxml.jackson.datatype:jackson-datatype-jsr310@2.11.4"},{"ref":"23-com.fasterxml.jackson.datatype:jackson-datatype-jsr310@2.11.4","dependsOn":["92-com.fasterxml.jackson.core:jackson-annotations@2.11.4","94-com.fasterxml.jackson.core:jackson-core@2.11.4","20-com.fasterxml.jackson.core:jackson-databind@2.11.4"]},{"ref":"24-org.springframework.boot:spring-boot-actuator@2.4.2","dependsOn":["13-org.springframework.boot:spring-boot@2.4.2"]},{"ref":"25-org.springframework.boot:spring-boot-actuator-autoconfigure@2.4.2","dependsOn":["20-com.fasterxml.jackson.core:jackson-databind@2.11.4","22-com.fasterxml.jackson.datatype:jackson-datatype-jsr310@2.11.4","13-org.springframework.boot:spring-boot@2.4.2","24-org.springframework.boot:spring-boot-actuator@2.4.2","15-org.springframework.boot:spring-boot-autoconfigure@2.4.2"]},{"ref":"26-org.springframework.boot:spring-boot-starter@2.4.2"},{"ref":"27-org.springframework.boot:spring-boot-starter@2.4.2","dependsOn":["76-jakarta.annotation:jakarta.annotation-api@1.3.5","13-org.springframework.boot:spring-boot@2.4.2","15-org.springframework.boot:spring-boot-autoconfigure@2.4.2","82-org.springframework.boot:spring-boot-starter-logging@2.4.2","10-org.springframework:spring-core@5.3.3","83-org.yaml:snakeyaml@1.27"]},{"ref":"28-org.springframework.boot:spring-boot-starter-actuator@2.4.2","dependsOn":["19-io.micrometer:micrometer-core@1.6.3","25-org.springframework.boot:spring-boot-actuator-autoconfigure@2.4.2","26-org.springframework.boot:spring-boot-starter@2.4.2"]},{"ref":"29-jakarta.persistence:jakarta.persistence-api@2.2.3"},{"ref":"30-jakarta.transaction:jakarta.transaction-api@1.3.3"},{"ref":"31-antlr:antlr@2.7.7"},{"ref":"32-com.fasterxml:classmate@1.5.1"},{"ref":"33-net.bytebuddy:byte-buddy@1.10.19"},{"ref":"34-org.dom4j:dom4j@2.1.3"},{"ref":"35-com.sun.activation:jakarta.activation@1.2.2"},{"ref":"36-com.sun.istack:istack-commons-runtime@3.0.11"},{"ref":"37-jakarta.xml.bind:jakarta.xml.bind-api@2.3.3"},{"ref":"38-org.glassfish.jaxb:txw2@2.3.3"},{"ref":"39-org.glassfish.jaxb:jaxb-runtime@2.3.3","dependsOn":["35-com.sun.activation:jakarta.activation@1.2.2","36-com.sun.istack:istack-commons-runtime@3.0.11","37-jakarta.xml.bind:jakarta.xml.bind-api@2.3.3","38-org.glassfish.jaxb:txw2@2.3.3"]},{"ref":"40-org.jboss.logging:jboss-logging@3.4.1.Final"},{"ref":"41-org.jboss.logging:jboss-logging@3.4.1.Final"},{"ref":"42-org.hibernate.common:hibernate-commons-annotations@5.1.2.Final","dependsOn":["40-org.jboss.logging:jboss-logging@3.4.1.Final"]},{"ref":"43-org.javassist:javassist@3.27.0-GA"},{"ref":"44-org.jboss:jandex@2.1.3.Final"},{"ref":"45-org.hibernate:hibernate-core@5.4.27.Final","dependsOn":["31-antlr:antlr@2.7.7","32-com.fasterxml:classmate@1.5.1","33-net.bytebuddy:byte-buddy@1.10.19","34-org.dom4j:dom4j@2.1.3","39-org.glassfish.jaxb:jaxb-runtime@2.3.3","42-org.hibernate.common:hibernate-commons-annotations@5.1.2.Final","43-org.javassist:javassist@3.27.0-GA","41-org.jboss.logging:jboss-logging@3.4.1.Final","44-org.jboss:jandex@2.1.3.Final"]},{"ref":"46-org.aspectj:aspectjweaver@1.9.6"},{"ref":"47-org.aspectj:aspectjweaver@1.9.6"},{"ref":"48-org.springframework:spring-aop@5.3.3"},{"ref":"49-org.springframework:spring-aop@5.3.3","dependsOn":["54-org.springframework:spring-beans@5.3.3","10-org.springframework:spring-core@5.3.3"]},{"ref":"50-org.springframework.boot:spring-boot-starter-aop@2.4.2","dependsOn":["46-org.aspectj:aspectjweaver@1.9.6","26-org.springframework.boot:spring-boot-starter@2.4.2","48-org.springframework:spring-aop@5.3.3"]},{"ref":"51-org.slf4j:slf4j-api@1.7.30"},{"ref":"52-org.slf4j:slf4j-api@1.7.30"},{"ref":"53-com.zaxxer:HikariCP@3.4.5","dependsOn":["51-org.slf4j:slf4j-api@1.7.30"]},{"ref":"54-org.springframework:spring-beans@5.3.3"},{"ref":"55-org.springframework:spring-beans@5.3.3","dependsOn":["10-org.springframework:spring-core@5.3.3"]},{"ref":"56-org.springframework:spring-tx@5.3.3"},{"ref":"57-org.springframework:spring-tx@5.3.3","dependsOn":["54-org.springframework:spring-beans@5.3.3","10-org.springframework:spring-core@5.3.3"]},{"ref":"58-org.springframework:spring-jdbc@5.3.3","dependsOn":["54-org.springframework:spring-beans@5.3.3","10-org.springframework:spring-core@5.3.3","56-org.springframework:spring-tx@5.3.3"]},{"ref":"59-org.springframework:spring-jdbc@5.3.3"},{"ref":"60-org.springframework.boot:spring-boot-starter-jdbc@2.4.2","dependsOn":["53-com.zaxxer:HikariCP@3.4.5","26-org.springframework.boot:spring-boot-starter@2.4.2","58-org.springframework:spring-jdbc@5.3.3"]},{"ref":"61-org.springframework.data:spring-data-commons@2.4.3","dependsOn":["51-org.slf4j:slf4j-api@1.7.30","54-org.springframework:spring-beans@5.3.3","10-org.springframework:spring-core@5.3.3"]},{"ref":"62-org.springframework:spring-expression@5.3.3"},{"ref":"63-org.springframework:spring-expression@5.3.3","dependsOn":["10-org.springframework:spring-core@5.3.3"]},{"ref":"64-org.springframework:spring-jcl@5.3.3"},{"ref":"65-org.springframework:spring-orm@5.3.3","dependsOn":["54-org.springframework:spring-beans@5.3.3","10-org.springframework:spring-core@5.3.3","59-org.springframework:spring-jdbc@5.3.3","56-org.springframework:spring-tx@5.3.3"]},{"ref":"66-org.springframework.data:spring-data-jpa@2.4.3","dependsOn":["51-org.slf4j:slf4j-api@1.7.30","61-org.springframework.data:spring-data-commons@2.4.3","48-org.springframework:spring-aop@5.3.3","55-org.springframework:spring-beans@5.3.3","9-org.springframework:spring-context@5.3.3","11-org.springframework:spring-core@5.3.3","65-org.springframework:spring-orm@5.3.3","57-org.springframework:spring-tx@5.3.3"]},{"ref":"67-org.springframework:spring-aspects@5.3.3","dependsOn":["47-org.aspectj:aspectjweaver@1.9.6"]},{"ref":"68-org.springframework.boot:spring-boot-starter-data-jpa@2.4.2","dependsOn":["29-jakarta.persistence:jakarta.persistence-api@2.2.3","30-jakarta.transaction:jakarta.transaction-api@1.3.3","45-org.hibernate:hibernate-core@5.4.27.Final","50-org.springframework.boot:spring-boot-starter-aop@2.4.2","60-org.springframework.boot:spring-boot-starter-jdbc@2.4.2","66-org.springframework.data:spring-data-jpa@2.4.3","67-org.springframework:spring-aspects@5.3.3"]},{"ref":"69-org.springframework.security:spring-security-core@5.4.2","dependsOn":["48-org.springframework:spring-aop@5.3.3","54-org.springframework:spring-beans@5.3.3","8-org.springframework:spring-context@5.3.3","10-org.springframework:spring-core@5.3.3","62-org.springframework:spring-expression@5.3.3"]},{"ref":"70-org.springframework.security:spring-security-core@5.4.2"},{"ref":"71-org.springframework.security:spring-security-config@5.4.2","dependsOn":["69-org.springframework.security:spring-security-core@5.4.2","48-org.springframework:spring-aop@5.3.3","54-org.springframework:spring-beans@5.3.3","8-org.springframework:spring-context@5.3.3","10-org.springframework:spring-core@5.3.3"]},{"ref":"72-org.springframework:spring-web@5.3.3"},{"ref":"73-org.springframework:spring-web@5.3.3","dependsOn":["54-org.springframework:spring-beans@5.3.3","10-org.springframework:spring-core@5.3.3"]},{"ref":"74-org.springframework.security:spring-security-web@5.4.2","dependsOn":["70-org.springframework.security:spring-security-core@5.4.2","48-org.springframework:spring-aop@5.3.3","54-org.springframework:spring-beans@5.3.3","8-org.springframework:spring-context@5.3.3","10-org.springframework:spring-core@5.3.3","63-org.springframework:spring-expression@5.3.3","72-org.springframework:spring-web@5.3.3"]},{"ref":"75-org.springframework.boot:spring-boot-starter-security@2.4.2","dependsOn":["26-org.springframework.boot:spring-boot-starter@2.4.2","71-org.springframework.security:spring-security-config@5.4.2","74-org.springframework.security:spring-security-web@5.4.2","49-org.springframework:spring-aop@5.3.3"]},{"ref":"76-jakarta.annotation:jakarta.annotation-api@1.3.5"},{"ref":"77-jakarta.annotation:jakarta.annotation-api@1.3.5"},{"ref":"78-ch.qos.logback:logback-core@1.2.3"},{"ref":"79-ch.qos.logback:logback-classic@1.2.3","dependsOn":["78-ch.qos.logback:logback-core@1.2.3","51-org.slf4j:slf4j-api@1.7.30"]},{"ref":"80-org.apache.logging.log4j:log4j-to-slf4j@2.13.3","dependsOn":["4-org.apache.logging.log4j:log4j-api@2.14.0","51-org.slf4j:slf4j-api@1.7.30"]},{"ref":"81-org.slf4j:jul-to-slf4j@1.7.30","dependsOn":["51-org.slf4j:slf4j-api@1.7.30"]},{"ref":"82-org.springframework.boot:spring-boot-starter-logging@2.4.2","dependsOn":["79-ch.qos.logback:logback-classic@1.2.3","80-org.apache.logging.log4j:log4j-to-slf4j@2.13.3","81-org.slf4j:jul-to-slf4j@1.7.30"]},{"ref":"83-org.yaml:snakeyaml@1.27"},{"ref":"84-org.thymeleaf:thymeleaf@3.0.12.RELEASE"},{"ref":"85-org.thymeleaf:thymeleaf@3.0.12.RELEASE","dependsOn":["87-org.attoparser:attoparser@2.0.5.RELEASE","51-org.slf4j:slf4j-api@1.7.30","88-org.unbescape:unbescape@1.1.6.RELEASE"]},{"ref":"86-org.thymeleaf.extras:thymeleaf-extras-java8time@3.0.4.RELEASE","dependsOn":["51-org.slf4j:slf4j-api@1.7.30","84-org.thymeleaf:thymeleaf@3.0.12.RELEASE"]},{"ref":"87-org.attoparser:attoparser@2.0.5.RELEASE"},{"ref":"88-org.unbescape:unbescape@1.1.6.RELEASE"},{"ref":"89-org.thymeleaf:thymeleaf-spring5@3.0.12.RELEASE","dependsOn":["51-org.slf4j:slf4j-api@1.7.30","85-org.thymeleaf:thymeleaf@3.0.12.RELEASE"]},{"ref":"90-org.springframework.boot:spring-boot-starter-thymeleaf@2.4.2","dependsOn":["27-org.springframework.boot:spring-boot-starter@2.4.2","86-org.thymeleaf.extras:thymeleaf-extras-java8time@3.0.4.RELEASE","89-org.thymeleaf:thymeleaf-spring5@3.0.12.RELEASE"]},{"ref":"91-com.fasterxml.jackson.core:jackson-annotations@2.11.4"},{"ref":"92-com.fasterxml.jackson.core:jackson-annotations@2.11.4"},{"ref":"93-com.fasterxml.jackson.core:jackson-core@2.11.4"},{"ref":"94-com.fasterxml.jackson.core:jackson-core@2.11.4"},{"ref":"95-com.fasterxml.jackson.datatype:jackson-datatype-jdk8@2.11.4","dependsOn":["94-com.fasterxml.jackson.core:jackson-core@2.11.4","20-com.fasterxml.jackson.core:jackson-databind@2.11.4"]},{"ref":"96-com.fasterxml.jackson.module:jackson-module-parameter-names@2.11.4","dependsOn":["94-com.fasterxml.jackson.core:jackson-core@2.11.4","20-com.fasterxml.jackson.core:jackson-databind@2.11.4"]},{"ref":"97-org.springframework.boot:spring-boot-starter-json@2.4.2","dependsOn":["21-com.fasterxml.jackson.core:jackson-databind@2.11.4","95-com.fasterxml.jackson.datatype:jackson-datatype-jdk8@2.11.4","23-com.fasterxml.jackson.datatype:jackson-datatype-jsr310@2.11.4","96-com.fasterxml.jackson.module:jackson-module-parameter-names@2.11.4","26-org.springframework.boot:spring-boot-starter@2.4.2","72-org.springframework:spring-web@5.3.3"]},{"ref":"98-org.apache.tomcat.embed:tomcat-embed-core@9.0.41"},{"ref":"99-org.apache.tomcat.embed:tomcat-embed-core@9.0.41"},{"ref":"100-org.apache.tomcat.embed:tomcat-embed-websocket@9.0.41","dependsOn":["99-org.apache.tomcat.embed:tomcat-embed-core@9.0.41"]},{"ref":"101-org.glassfish:jakarta.el@3.0.3"},{"ref":"102-org.springframework.boot:spring-boot-starter-tomcat@2.4.2","dependsOn":["77-jakarta.annotation:jakarta.annotation-api@1.3.5","98-org.apache.tomcat.embed:tomcat-embed-core@9.0.41","100-org.apache.tomcat.embed:tomcat-embed-websocket@9.0.41","101-org.glassfish:jakarta.el@3.0.3"]},{"ref":"103-org.springframework:spring-webmvc@5.3.3","dependsOn":["48-org.springframework:spring-aop@5.3.3","54-org.springframework:spring-beans@5.3.3","8-org.springframework:spring-context@5.3.3","10-org.springframework:spring-core@5.3.3","62-org.springframework:spring-expression@5.3.3","72-org.springframework:spring-web@5.3.3"]},{"ref":"104-org.springframework.boot:spring-boot-starter-web@2.4.2","dependsOn":["26-org.springframework.boot:spring-boot-starter@2.4.2","97-org.springframework.boot:spring-boot-starter-json@2.4.2","102-org.springframework.boot:spring-boot-starter-tomcat@2.4.2","73-org.springframework:spring-web@5.3.3","103-org.springframework:spring-webmvc@5.3.3"]},{"ref":"105-org.zeroturnaround:zt-zip@1.12","dependsOn":["52-org.slf4j:slf4j-api@1.7.30"]}]} ================================================ FILE: testing/sbom3.cyclonedx.json ================================================ { "bomFormat": "CycloneDX", "specVersion": "1.4", "serialNumber": "urn:uuid:d4847fa1-34f0-4b59-803c-380702f6405f", "version": 1, "metadata": { "timestamp": "2023-05-09T10:39:25+01:00", "tools": [ { "vendor": "anchore", "name": "syft", "version": "0.52.0" } ], "component": { "bom-ref": "a4d8d3249909e2fc", "type": "container", "name": "nginx", "version": "sha256:3f01b0094e21f7d55b9eb7179d01c49fdf9c3e1e3419d315b81a9e0bae1b6a90" } }, "components": [ { "bom-ref": "pkg:deb/debian/adduser@3.118?arch=all\u0026distro=debian-11\u0026package-id=a124711c55c5b5ec", "type": "library", "publisher": "Debian Adduser Developers \u003cadduser@packages.debian.org\u003e", "name": "adduser", "version": "3.118", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:adduser:adduser:3.118:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/adduser@3.118?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/adduser/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/adduser.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/adduser.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "849" } ] }, { "bom-ref": "pkg:deb/debian/apt@2.2.4?arch=amd64\u0026distro=debian-11\u0026package-id=aa414cb26ab3bbca", "type": "library", "publisher": "APT Development Team \u003cdeity@lists.debian.org\u003e", "name": "apt", "version": "2.2.4", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:apt:apt:2.2.4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/apt@2.2.4?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/apt/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/apt.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/apt.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "4337" } ] }, { "bom-ref": "pkg:deb/debian/base-files@11.1+deb11u7?arch=amd64\u0026distro=debian-11\u0026package-id=aaa37f36bac4c7fc", "type": "library", "publisher": "Santiago Vila \u003csanvila@debian.org\u003e", "name": "base-files", "version": "11.1+deb11u7", "cpe": "cpe:2.3:a:base-files:base-files:11.1\\+deb11u7:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/base-files@11.1+deb11u7?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base-files:base_files:11.1\\+deb11u7:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base_files:base-files:11.1\\+deb11u7:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base_files:base_files:11.1\\+deb11u7:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base:base-files:11.1\\+deb11u7:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base:base_files:11.1\\+deb11u7:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/base-files/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/base-files.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/base-files.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "341" } ] }, { "bom-ref": "pkg:deb/debian/base-passwd@3.5.51?arch=amd64\u0026distro=debian-11\u0026package-id=4b06cb374332f86a", "type": "library", "publisher": "Colin Watson \u003ccjwatson@debian.org\u003e", "name": "base-passwd", "version": "3.5.51", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:base-passwd:base-passwd:3.5.51:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/base-passwd@3.5.51?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base-passwd:base_passwd:3.5.51:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base_passwd:base-passwd:3.5.51:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base_passwd:base_passwd:3.5.51:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base:base-passwd:3.5.51:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:base:base_passwd:3.5.51:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/base-passwd/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/base-passwd.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "243" } ] }, { "bom-ref": "pkg:deb/debian/bash@5.1-2+deb11u1?arch=amd64\u0026distro=debian-11\u0026package-id=e489f9fee082a54e", "type": "library", "publisher": "Matthias Klose \u003cdoko@debian.org\u003e", "name": "bash", "version": "5.1-2+deb11u1", "licenses": [ { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:bash:bash:5.1-2\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/bash@5.1-2+deb11u1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/bash/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/bash.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/bash.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "6469" } ] }, { "bom-ref": "pkg:deb/debian/bsdutils@1:2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux%402.36.1-8+deb11u1\u0026distro=debian-11\u0026package-id=f277da72145fb122", "type": "library", "publisher": "util-linux packagers \u003cutil-linux@packages.debian.org\u003e", "name": "bsdutils", "version": "1:2.36.1-8+deb11u1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:bsdutils:bsdutils:1\\:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/bsdutils@1:2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux%402.36.1-8+deb11u1\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/bsdutils/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/bsdutils.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "394" }, { "name": "syft:metadata:source", "value": "util-linux" }, { "name": "syft:metadata:sourceVersion", "value": "2.36.1-8+deb11u1" } ] }, { "bom-ref": "pkg:deb/debian/ca-certificates@20210119?arch=all\u0026distro=debian-11\u0026package-id=4932f34e82ba94bf", "type": "library", "publisher": "Julien Cristau \u003cjcristau@debian.org\u003e", "name": "ca-certificates", "version": "20210119", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "MPL-2.0" } } ], "cpe": "cpe:2.3:a:ca-certificates:ca-certificates:20210119:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/ca-certificates@20210119?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ca-certificates:ca_certificates:20210119:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ca_certificates:ca-certificates:20210119:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ca_certificates:ca_certificates:20210119:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ca:ca-certificates:20210119:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ca:ca_certificates:20210119:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/ca-certificates/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/ca-certificates.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "382" } ] }, { "bom-ref": "pkg:deb/debian/coreutils@8.32-4+b1?arch=amd64\u0026upstream=coreutils%408.32-4\u0026distro=debian-11\u0026package-id=5ea1df19e7f98d54", "type": "library", "publisher": "Michael Stone \u003cmstone@debian.org\u003e", "name": "coreutils", "version": "8.32-4+b1", "licenses": [ { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:coreutils:coreutils:8.32-4\\+b1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/coreutils@8.32-4+b1?arch=amd64\u0026upstream=coreutils%408.32-4\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/coreutils/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/coreutils.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "17478" }, { "name": "syft:metadata:source", "value": "coreutils" }, { "name": "syft:metadata:sourceVersion", "value": "8.32-4" } ] }, { "bom-ref": "pkg:deb/debian/curl@7.74.0-1.3+deb11u7?arch=amd64\u0026distro=debian-11\u0026package-id=bb9c37a6495e7923", "type": "library", "publisher": "Alessandro Ghedini \u003cghedo@debian.org\u003e", "name": "curl", "version": "7.74.0-1.3+deb11u7", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "ISC" } }, { "license": { "id": "curl" } } ], "cpe": "cpe:2.3:a:curl:curl:7.74.0-1.3\\+deb11u7:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/curl@7.74.0-1.3+deb11u7?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/curl/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/curl.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "430" } ] }, { "bom-ref": "pkg:deb/debian/dash@0.5.11+git20200708+dd9ef66-5?arch=amd64\u0026distro=debian-11\u0026package-id=f1bb94f1de148c52", "type": "library", "publisher": "Andrej Shadura \u003candrewsh@debian.org\u003e", "name": "dash", "version": "0.5.11+git20200708+dd9ef66-5", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "FSFUL" } }, { "license": { "id": "FSFULLR" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } } ], "cpe": "cpe:2.3:a:dash:dash:0.5.11\\+git20200708\\+dd9ef66-5:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/dash@0.5.11+git20200708+dd9ef66-5?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/dash/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/dash.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "221" } ] }, { "bom-ref": "pkg:deb/debian/debconf@1.5.77?arch=all\u0026distro=debian-11\u0026package-id=bbadd8ec8c7191de", "type": "library", "publisher": "Debconf Developers \u003cdebconf-devel@lists.alioth.debian.org\u003e", "name": "debconf", "version": "1.5.77", "licenses": [ { "license": { "id": "BSD-2-Clause" } } ], "cpe": "cpe:2.3:a:debconf:debconf:1.5.77:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/debconf@1.5.77?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/debconf/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/debconf.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/debconf.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "517" } ] }, { "bom-ref": "pkg:deb/debian/debian-archive-keyring@2021.1.1+deb11u1?arch=all\u0026distro=debian-11\u0026package-id=ff841a2ac4660d27", "type": "library", "publisher": "Debian Release Team \u003cpackages@release.debian.org\u003e", "name": "debian-archive-keyring", "version": "2021.1.1+deb11u1", "cpe": "cpe:2.3:a:debian-archive-keyring:debian-archive-keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/debian-archive-keyring@2021.1.1+deb11u1?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian-archive-keyring:debian_archive_keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian_archive_keyring:debian-archive-keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian_archive_keyring:debian_archive_keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian-archive:debian-archive-keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian-archive:debian_archive_keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian_archive:debian-archive-keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian_archive:debian_archive_keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian:debian-archive-keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:debian:debian_archive_keyring:2021.1.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/debian-archive-keyring/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/debian-archive-keyring.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/debian-archive-keyring.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "253" } ] }, { "bom-ref": "pkg:deb/debian/debianutils@4.11.2?arch=amd64\u0026distro=debian-11\u0026package-id=8f8ec2bbbfdd75a3", "type": "library", "publisher": "Clint Adams \u003cclint@debian.org\u003e", "name": "debianutils", "version": "4.11.2", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:debianutils:debianutils:4.11.2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/debianutils@4.11.2?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/debianutils/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/debianutils.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "230" } ] }, { "bom-ref": "pkg:deb/debian/diffutils@1:3.7-5?arch=amd64\u0026distro=debian-11\u0026package-id=3396b2091eb738df", "type": "library", "publisher": "Santiago Vila \u003csanvila@debian.org\u003e", "name": "diffutils", "version": "1:3.7-5", "cpe": "cpe:2.3:a:diffutils:diffutils:1\\:3.7-5:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/diffutils@1:3.7-5?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/diffutils/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/diffutils.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1598" } ] }, { "bom-ref": "pkg:deb/debian/dpkg@1.20.12?arch=amd64\u0026distro=debian-11\u0026package-id=6b9e71388b820e5e", "type": "library", "publisher": "Dpkg Developers \u003cdebian-dpkg@lists.debian.org\u003e", "name": "dpkg", "version": "1.20.12", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } } ], "cpe": "cpe:2.3:a:dpkg:dpkg:1.20.12:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/dpkg@1.20.12?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/dpkg/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/dpkg.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/dpkg.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "6980" } ] }, { "bom-ref": "pkg:deb/debian/e2fsprogs@1.46.2-2?arch=amd64\u0026distro=debian-11\u0026package-id=529fb29c48e0a3a0", "type": "library", "publisher": "Theodore Y. Ts'o \u003ctytso@mit.edu\u003e", "name": "e2fsprogs", "version": "1.46.2-2", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.0" } } ], "cpe": "cpe:2.3:a:e2fsprogs:e2fsprogs:1.46.2-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/e2fsprogs@1.46.2-2?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/e2fsprogs/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/e2fsprogs.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/e2fsprogs.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1511" } ] }, { "bom-ref": "pkg:deb/debian/findutils@4.8.0-1?arch=amd64\u0026distro=debian-11\u0026package-id=f32a2bdab270e8bf", "type": "library", "publisher": "Andreas Metzler \u003cametzler@debian.org\u003e", "name": "findutils", "version": "4.8.0-1", "licenses": [ { "license": { "id": "GFDL-1.3" } }, { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:findutils:findutils:4.8.0-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/findutils@4.8.0-1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/findutils/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/findutils.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1959" } ] }, { "bom-ref": "pkg:deb/debian/fontconfig-config@2.13.1-4.2?arch=all\u0026upstream=fontconfig\u0026distro=debian-11\u0026package-id=4476174070b15d88", "type": "library", "publisher": "Debian freedesktop.org maintainers \u003cpkg-freedesktop-maintainers@lists.alioth.debian.org\u003e", "name": "fontconfig-config", "version": "2.13.1-4.2", "cpe": "cpe:2.3:a:fontconfig-config:fontconfig-config:2.13.1-4.2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/fontconfig-config@2.13.1-4.2?arch=all\u0026upstream=fontconfig\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fontconfig-config:fontconfig_config:2.13.1-4.2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fontconfig_config:fontconfig-config:2.13.1-4.2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fontconfig_config:fontconfig_config:2.13.1-4.2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fontconfig:fontconfig-config:2.13.1-4.2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fontconfig:fontconfig_config:2.13.1-4.2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/fontconfig-config/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/fontconfig-config.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/fontconfig-config.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "442" }, { "name": "syft:metadata:source", "value": "fontconfig" } ] }, { "bom-ref": "pkg:deb/debian/fonts-dejavu-core@2.37-2?arch=all\u0026upstream=fonts-dejavu\u0026distro=debian-11\u0026package-id=16c100737263f237", "type": "library", "publisher": "Debian Fonts Task Force \u003cdebian-fonts@lists.debian.org\u003e", "name": "fonts-dejavu-core", "version": "2.37-2", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "Bitstream-Vera" } } ], "cpe": "cpe:2.3:a:fonts-dejavu-core:fonts-dejavu-core:2.37-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/fonts-dejavu-core@2.37-2?arch=all\u0026upstream=fonts-dejavu\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts-dejavu-core:fonts_dejavu_core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts_dejavu_core:fonts-dejavu-core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts_dejavu_core:fonts_dejavu_core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts-dejavu:fonts-dejavu-core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts-dejavu:fonts_dejavu_core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts_dejavu:fonts-dejavu-core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts_dejavu:fonts_dejavu_core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts:fonts-dejavu-core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:fonts:fonts_dejavu_core:2.37-2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/fonts-dejavu-core/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/fonts-dejavu-core.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/fonts-dejavu-core.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "2954" }, { "name": "syft:metadata:source", "value": "fonts-dejavu" } ] }, { "bom-ref": "pkg:deb/debian/gcc-10-base@10.2.1-6?arch=amd64\u0026upstream=gcc-10\u0026distro=debian-11\u0026package-id=3cdf11976de03f14", "type": "library", "publisher": "Debian GCC Maintainers \u003cdebian-gcc@lists.debian.org\u003e", "name": "gcc-10-base", "version": "10.2.1-6", "licenses": [ { "license": { "id": "GFDL-1.2" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:gcc-10-base:gcc-10-base:10.2.1-6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/gcc-10-base@10.2.1-6?arch=amd64\u0026upstream=gcc-10\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc-10-base:gcc_10_base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_10_base:gcc-10-base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_10_base:gcc_10_base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc-10:gcc-10-base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc-10:gcc_10_base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_10:gcc-10-base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_10:gcc_10_base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc:gcc-10-base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc:gcc_10_base:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/gcc-10-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/gcc-10-base:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "261" }, { "name": "syft:metadata:source", "value": "gcc-10" } ] }, { "bom-ref": "pkg:deb/debian/gcc-9-base@9.3.0-22?arch=amd64\u0026upstream=gcc-9\u0026distro=debian-11\u0026package-id=fa0987b9eb161d04", "type": "library", "publisher": "Debian GCC Maintainers \u003cdebian-gcc@lists.debian.org\u003e", "name": "gcc-9-base", "version": "9.3.0-22", "licenses": [ { "license": { "id": "GFDL-1.2" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "LGPL-2.1+" } } ], "cpe": "cpe:2.3:a:gcc-9-base:gcc-9-base:9.3.0-22:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/gcc-9-base@9.3.0-22?arch=amd64\u0026upstream=gcc-9\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc-9-base:gcc_9_base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_9_base:gcc-9-base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_9_base:gcc_9_base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc-9:gcc-9-base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc-9:gcc_9_base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_9:gcc-9-base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc_9:gcc_9_base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc:gcc-9-base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gcc:gcc_9_base:9.3.0-22:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/gcc-9-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/gcc-9-base:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "262" }, { "name": "syft:metadata:source", "value": "gcc-9" } ] }, { "bom-ref": "pkg:deb/debian/gettext-base@0.21-4?arch=amd64\u0026upstream=gettext\u0026distro=debian-11\u0026package-id=c93a10c9a8f0dd4a", "type": "library", "publisher": "Santiago Vila \u003csanvila@debian.org\u003e", "name": "gettext-base", "version": "0.21-4", "cpe": "cpe:2.3:a:gettext-base:gettext-base:0.21-4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/gettext-base@0.21-4?arch=amd64\u0026upstream=gettext\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gettext-base:gettext_base:0.21-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gettext_base:gettext-base:0.21-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gettext_base:gettext_base:0.21-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gettext:gettext-base:0.21-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:gettext:gettext_base:0.21-4:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/gettext-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/gettext-base.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "659" }, { "name": "syft:metadata:source", "value": "gettext" } ] }, { "bom-ref": "pkg:deb/debian/gpgv@2.2.27-2+deb11u2?arch=amd64\u0026upstream=gnupg2\u0026distro=debian-11\u0026package-id=33f6b18dc5e35288", "type": "library", "publisher": "Debian GnuPG Maintainers \u003cpkg-gnupg-maint@lists.alioth.debian.org\u003e", "name": "gpgv", "version": "2.2.27-2+deb11u2", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "CC0-1.0" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } } ], "cpe": "cpe:2.3:a:gpgv:gpgv:2.2.27-2\\+deb11u2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/gpgv@2.2.27-2+deb11u2?arch=amd64\u0026upstream=gnupg2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/gpgv/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/gpgv.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "882" }, { "name": "syft:metadata:source", "value": "gnupg2" } ] }, { "bom-ref": "pkg:deb/debian/grep@3.6-1+deb11u1?arch=amd64\u0026distro=debian-11\u0026package-id=d9d5b23d586315bc", "type": "library", "publisher": "Anibal Monsalve Salazar \u003canibal@debian.org\u003e", "name": "grep", "version": "3.6-1+deb11u1", "licenses": [ { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } } ], "cpe": "cpe:2.3:a:grep:grep:3.6-1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/grep@3.6-1+deb11u1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/grep/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/grep.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1091" } ] }, { "bom-ref": "pkg:deb/debian/gzip@1.10-4+deb11u1?arch=amd64\u0026distro=debian-11\u0026package-id=eb25aff794b4961c", "type": "library", "publisher": "Milan Kupcevic \u003cmilan@debian.org\u003e", "name": "gzip", "version": "1.10-4+deb11u1", "licenses": [ { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } } ], "cpe": "cpe:2.3:a:gzip:gzip:1.10-4\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/gzip@1.10-4+deb11u1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/gzip/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/gzip.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "242" } ] }, { "bom-ref": "pkg:deb/debian/hostname@3.23?arch=amd64\u0026distro=debian-11\u0026package-id=7a0895692bf8e5c4", "type": "library", "publisher": "Michael Meskes \u003cmeskes@debian.org\u003e", "name": "hostname", "version": "3.23", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:hostname:hostname:3.23:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/hostname@3.23?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/hostname/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/hostname.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "50" } ] }, { "bom-ref": "pkg:deb/debian/init-system-helpers@1.60?arch=all\u0026distro=debian-11\u0026package-id=fd4f5e16fb283f4", "type": "library", "publisher": "Debian systemd Maintainers \u003cpkg-systemd-maintainers@lists.alioth.debian.org\u003e", "name": "init-system-helpers", "version": "1.60", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } } ], "cpe": "cpe:2.3:a:init-system-helpers:init-system-helpers:1.60:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/init-system-helpers@1.60?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init-system-helpers:init_system_helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init_system_helpers:init-system-helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init_system_helpers:init_system_helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init-system:init-system-helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init-system:init_system_helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init_system:init-system-helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init_system:init_system_helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init:init-system-helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:init:init_system_helpers:1.60:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/init-system-helpers/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/init-system-helpers.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "131" } ] }, { "bom-ref": "pkg:deb/debian/libacl1@2.2.53-10?arch=amd64\u0026upstream=acl\u0026distro=debian-11\u0026package-id=e0a83b52220f81d5", "type": "library", "publisher": "Guillem Jover \u003cguillem@debian.org\u003e", "name": "libacl1", "version": "2.2.53-10", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libacl1:libacl1:2.2.53-10:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libacl1@2.2.53-10?arch=amd64\u0026upstream=acl\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libacl1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libacl1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "71" }, { "name": "syft:metadata:source", "value": "acl" } ] }, { "bom-ref": "pkg:deb/debian/libapt-pkg6.0@2.2.4?arch=amd64\u0026upstream=apt\u0026distro=debian-11\u0026package-id=c9f0db5ec0cd299a", "type": "library", "publisher": "APT Development Team \u003cdeity@lists.debian.org\u003e", "name": "libapt-pkg6.0", "version": "2.2.4", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libapt-pkg6.0:libapt-pkg6.0:2.2.4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libapt-pkg6.0@2.2.4?arch=amd64\u0026upstream=apt\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libapt-pkg6.0:libapt_pkg6.0:2.2.4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libapt_pkg6.0:libapt-pkg6.0:2.2.4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libapt_pkg6.0:libapt_pkg6.0:2.2.4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libapt:libapt-pkg6.0:2.2.4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libapt:libapt_pkg6.0:2.2.4:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libapt-pkg6.0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libapt-pkg6.0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "3373" }, { "name": "syft:metadata:source", "value": "apt" } ] }, { "bom-ref": "pkg:deb/debian/libattr1@1:2.4.48-6?arch=amd64\u0026upstream=attr\u0026distro=debian-11\u0026package-id=2e9da59fcfb0bc5", "type": "library", "publisher": "Guillem Jover \u003cguillem@debian.org\u003e", "name": "libattr1", "version": "1:2.4.48-6", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libattr1:libattr1:1\\:2.4.48-6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libattr1@1:2.4.48-6?arch=amd64\u0026upstream=attr\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libattr1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libattr1:amd64.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libattr1:amd64.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "56" }, { "name": "syft:metadata:source", "value": "attr" } ] }, { "bom-ref": "pkg:deb/debian/libaudit-common@1:3.0-2?arch=all\u0026upstream=audit\u0026distro=debian-11\u0026package-id=125cb964c8647790", "type": "library", "publisher": "Laurent Bigonville \u003cbigon@debian.org\u003e", "name": "libaudit-common", "version": "1:3.0-2", "licenses": [ { "license": { "id": "GPL-1.0" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libaudit-common:libaudit-common:1\\:3.0-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libaudit-common@1:3.0-2?arch=all\u0026upstream=audit\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libaudit-common:libaudit_common:1\\:3.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libaudit_common:libaudit-common:1\\:3.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libaudit_common:libaudit_common:1\\:3.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libaudit:libaudit-common:1\\:3.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libaudit:libaudit_common:1\\:3.0-2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libaudit-common/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libaudit-common.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libaudit-common.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "26" }, { "name": "syft:metadata:source", "value": "audit" } ] }, { "bom-ref": "pkg:deb/debian/libaudit1@1:3.0-2?arch=amd64\u0026upstream=audit\u0026distro=debian-11\u0026package-id=da1eb1a6ba858ec9", "type": "library", "publisher": "Laurent Bigonville \u003cbigon@debian.org\u003e", "name": "libaudit1", "version": "1:3.0-2", "licenses": [ { "license": { "id": "GPL-1.0" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libaudit1:libaudit1:1\\:3.0-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libaudit1@1:3.0-2?arch=amd64\u0026upstream=audit\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libaudit1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libaudit1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "154" }, { "name": "syft:metadata:source", "value": "audit" } ] }, { "bom-ref": "pkg:deb/debian/libblkid1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11\u0026package-id=a73a7e87322fd73a", "type": "library", "publisher": "util-linux packagers \u003cutil-linux@packages.debian.org\u003e", "name": "libblkid1", "version": "2.36.1-8+deb11u1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libblkid1:libblkid1:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libblkid1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libblkid1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libblkid1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "421" }, { "name": "syft:metadata:source", "value": "util-linux" } ] }, { "bom-ref": "pkg:deb/debian/libbrotli1@1.0.9-2+b2?arch=amd64\u0026upstream=brotli%401.0.9-2\u0026distro=debian-11\u0026package-id=a8a8c3e14200d4b7", "type": "library", "publisher": "Tomasz Buchert \u003ctomasz@debian.org\u003e", "name": "libbrotli1", "version": "1.0.9-2+b2", "licenses": [ { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libbrotli1:libbrotli1:1.0.9-2\\+b2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libbrotli1@1.0.9-2+b2?arch=amd64\u0026upstream=brotli%401.0.9-2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libbrotli1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libbrotli1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "784" }, { "name": "syft:metadata:source", "value": "brotli" }, { "name": "syft:metadata:sourceVersion", "value": "1.0.9-2" } ] }, { "bom-ref": "pkg:deb/debian/libbsd0@0.11.3-1?arch=amd64\u0026upstream=libbsd\u0026distro=debian-11\u0026package-id=737dc091651c6d2c", "type": "library", "publisher": "Guillem Jover \u003cguillem@debian.org\u003e", "name": "libbsd0", "version": "0.11.3-1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-2-Clause-NetBSD" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "Beerware" } }, { "license": { "id": "ISC" } } ], "cpe": "cpe:2.3:a:libbsd0:libbsd0:0.11.3-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libbsd0@0.11.3-1?arch=amd64\u0026upstream=libbsd\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libbsd0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libbsd0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "191" }, { "name": "syft:metadata:source", "value": "libbsd" } ] }, { "bom-ref": "pkg:deb/debian/libbz2-1.0@1.0.8-4?arch=amd64\u0026upstream=bzip2\u0026distro=debian-11\u0026package-id=6c83d71086c360b5", "type": "library", "publisher": "Anibal Monsalve Salazar \u003canibal@debian.org\u003e", "name": "libbz2-1.0", "version": "1.0.8-4", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libbz2-1.0:libbz2-1.0:1.0.8-4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libbz2-1.0@1.0.8-4?arch=amd64\u0026upstream=bzip2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libbz2-1.0:libbz2_1.0:1.0.8-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libbz2_1.0:libbz2-1.0:1.0.8-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libbz2_1.0:libbz2_1.0:1.0.8-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libbz2:libbz2-1.0:1.0.8-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libbz2:libbz2_1.0:1.0.8-4:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libbz2-1.0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libbz2-1.0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "104" }, { "name": "syft:metadata:source", "value": "bzip2" } ] }, { "bom-ref": "pkg:deb/debian/libc-bin@2.31-13+deb11u6?arch=amd64\u0026upstream=glibc\u0026distro=debian-11\u0026package-id=7bc5652ff8cccde7", "type": "library", "publisher": "GNU Libc Maintainers \u003cdebian-glibc@lists.debian.org\u003e", "name": "libc-bin", "version": "2.31-13+deb11u6", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libc-bin:libc-bin:2.31-13\\+deb11u6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libc-bin@2.31-13+deb11u6?arch=amd64\u0026upstream=glibc\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libc-bin:libc_bin:2.31-13\\+deb11u6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libc_bin:libc-bin:2.31-13\\+deb11u6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libc_bin:libc_bin:2.31-13\\+deb11u6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libc:libc-bin:2.31-13\\+deb11u6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libc:libc_bin:2.31-13\\+deb11u6:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libc-bin/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libc-bin.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libc-bin.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "3732" }, { "name": "syft:metadata:source", "value": "glibc" } ] }, { "bom-ref": "pkg:deb/debian/libc6@2.31-13+deb11u6?arch=amd64\u0026upstream=glibc\u0026distro=debian-11\u0026package-id=61b0e8b1252c7ad3", "type": "library", "publisher": "GNU Libc Maintainers \u003cdebian-glibc@lists.debian.org\u003e", "name": "libc6", "version": "2.31-13+deb11u6", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libc6:libc6:2.31-13\\+deb11u6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libc6@2.31-13+deb11u6?arch=amd64\u0026upstream=glibc\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libc6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libc6:amd64.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libc6:amd64.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "12833" }, { "name": "syft:metadata:source", "value": "glibc" } ] }, { "bom-ref": "pkg:deb/debian/libcap-ng0@0.7.9-2.2+b1?arch=amd64\u0026upstream=libcap-ng%400.7.9-2.2\u0026distro=debian-11\u0026package-id=d96dcd0201234163", "type": "library", "publisher": "Pierre Chifflier \u003cpollux@debian.org\u003e", "name": "libcap-ng0", "version": "0.7.9-2.2+b1", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libcap-ng0:libcap-ng0:0.7.9-2.2\\+b1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libcap-ng0@0.7.9-2.2+b1?arch=amd64\u0026upstream=libcap-ng%400.7.9-2.2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcap-ng0:libcap_ng0:0.7.9-2.2\\+b1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcap_ng0:libcap-ng0:0.7.9-2.2\\+b1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcap_ng0:libcap_ng0:0.7.9-2.2\\+b1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcap:libcap-ng0:0.7.9-2.2\\+b1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcap:libcap_ng0:0.7.9-2.2\\+b1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libcap-ng0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libcap-ng0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "48" }, { "name": "syft:metadata:source", "value": "libcap-ng" }, { "name": "syft:metadata:sourceVersion", "value": "0.7.9-2.2" } ] }, { "bom-ref": "pkg:deb/debian/libcom-err2@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11\u0026package-id=baa17fa24974defd", "type": "library", "publisher": "Theodore Y. Ts'o \u003ctytso@mit.edu\u003e", "name": "libcom-err2", "version": "1.46.2-2", "cpe": "cpe:2.3:a:libcom-err2:libcom-err2:1.46.2-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libcom-err2@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcom-err2:libcom_err2:1.46.2-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcom_err2:libcom-err2:1.46.2-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcom_err2:libcom_err2:1.46.2-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcom:libcom-err2:1.46.2-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libcom:libcom_err2:1.46.2-2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libcom-err2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libcom-err2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "97" }, { "name": "syft:metadata:source", "value": "e2fsprogs" } ] }, { "bom-ref": "pkg:deb/debian/libcrypt1@1:4.4.18-4?arch=amd64\u0026upstream=libxcrypt\u0026distro=debian-11\u0026package-id=99995fa478d99713", "type": "library", "publisher": "Marco d'Itri \u003cmd@linux.it\u003e", "name": "libcrypt1", "version": "1:4.4.18-4", "cpe": "cpe:2.3:a:libcrypt1:libcrypt1:1\\:4.4.18-4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libcrypt1@1:4.4.18-4?arch=amd64\u0026upstream=libxcrypt\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libcrypt1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libcrypt1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "226" }, { "name": "syft:metadata:source", "value": "libxcrypt" } ] }, { "bom-ref": "pkg:deb/debian/libcurl4@7.74.0-1.3+deb11u7?arch=amd64\u0026upstream=curl\u0026distro=debian-11\u0026package-id=e74701de2a38fd93", "type": "library", "publisher": "Alessandro Ghedini \u003cghedo@debian.org\u003e", "name": "libcurl4", "version": "7.74.0-1.3+deb11u7", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "ISC" } }, { "license": { "id": "curl" } } ], "cpe": "cpe:2.3:a:libcurl4:libcurl4:7.74.0-1.3\\+deb11u7:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libcurl4@7.74.0-1.3+deb11u7?arch=amd64\u0026upstream=curl\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libcurl4/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libcurl4:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "740" }, { "name": "syft:metadata:source", "value": "curl" } ] }, { "bom-ref": "pkg:deb/debian/libdb5.3@5.3.28+dfsg1-0.8?arch=amd64\u0026upstream=db5.3\u0026distro=debian-11\u0026package-id=8bfc69ad307dcdcd", "type": "library", "publisher": "Debian Berkeley DB Team \u003cteam+bdb@tracker.debian.org\u003e", "name": "libdb5.3", "version": "5.3.28+dfsg1-0.8", "cpe": "cpe:2.3:a:libdb5.3:libdb5.3:5.3.28\\+dfsg1-0.8:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libdb5.3@5.3.28+dfsg1-0.8?arch=amd64\u0026upstream=db5.3\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libdb5.3/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libdb5.3:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1818" }, { "name": "syft:metadata:source", "value": "db5.3" } ] }, { "bom-ref": "pkg:deb/debian/libdebconfclient0@0.260?arch=amd64\u0026upstream=cdebconf\u0026distro=debian-11\u0026package-id=c56a3b6958349ec4", "type": "library", "publisher": "Debian Install System Team \u003cdebian-boot@lists.debian.org\u003e", "name": "libdebconfclient0", "version": "0.260", "cpe": "cpe:2.3:a:libdebconfclient0:libdebconfclient0:0.260:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libdebconfclient0@0.260?arch=amd64\u0026upstream=cdebconf\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libdebconfclient0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libdebconfclient0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "74" }, { "name": "syft:metadata:source", "value": "cdebconf" } ] }, { "bom-ref": "pkg:deb/debian/libdeflate0@1.7-1?arch=amd64\u0026upstream=libdeflate\u0026distro=debian-11\u0026package-id=15fd424a98e8c78a", "type": "library", "publisher": "Debian Med Packaging Team \u003cdebian-med-packaging@lists.alioth.debian.org\u003e", "name": "libdeflate0", "version": "1.7-1", "cpe": "cpe:2.3:a:libdeflate0:libdeflate0:1.7-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libdeflate0@1.7-1?arch=amd64\u0026upstream=libdeflate\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libdeflate0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libdeflate0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "121" }, { "name": "syft:metadata:source", "value": "libdeflate" } ] }, { "bom-ref": "pkg:deb/debian/libexpat1@2.2.10-2+deb11u5?arch=amd64\u0026upstream=expat\u0026distro=debian-11\u0026package-id=8f53b066ebaca336", "type": "library", "publisher": "Laszlo Boszormenyi (GCS) \u003cgcs@debian.org\u003e", "name": "libexpat1", "version": "2.2.10-2+deb11u5", "licenses": [ { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libexpat1:libexpat1:2.2.10-2\\+deb11u5:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libexpat1@2.2.10-2+deb11u5?arch=amd64\u0026upstream=expat\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libexpat1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libexpat1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "411" }, { "name": "syft:metadata:source", "value": "expat" } ] }, { "bom-ref": "pkg:deb/debian/libext2fs2@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11\u0026package-id=69de4a92ec80854d", "type": "library", "publisher": "Theodore Y. Ts'o \u003ctytso@mit.edu\u003e", "name": "libext2fs2", "version": "1.46.2-2", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.0" } } ], "cpe": "cpe:2.3:a:libext2fs2:libext2fs2:1.46.2-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libext2fs2@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libext2fs2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libext2fs2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "578" }, { "name": "syft:metadata:source", "value": "e2fsprogs" } ] }, { "bom-ref": "pkg:deb/debian/libffi7@3.3-6?arch=amd64\u0026upstream=libffi\u0026distro=debian-11\u0026package-id=389fc122d555059f", "type": "library", "publisher": "Debian GCC Maintainers \u003cdebian-gcc@lists.debian.org\u003e", "name": "libffi7", "version": "3.3-6", "cpe": "cpe:2.3:a:libffi7:libffi7:3.3-6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libffi7@3.3-6?arch=amd64\u0026upstream=libffi\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libffi7/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libffi7:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "66" }, { "name": "syft:metadata:source", "value": "libffi" } ] }, { "bom-ref": "pkg:deb/debian/libfontconfig1@2.13.1-4.2?arch=amd64\u0026upstream=fontconfig\u0026distro=debian-11\u0026package-id=889f9d0caf1f5222", "type": "library", "publisher": "Debian freedesktop.org maintainers \u003cpkg-freedesktop-maintainers@lists.alioth.debian.org\u003e", "name": "libfontconfig1", "version": "2.13.1-4.2", "cpe": "cpe:2.3:a:libfontconfig1:libfontconfig1:2.13.1-4.2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libfontconfig1@2.13.1-4.2?arch=amd64\u0026upstream=fontconfig\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libfontconfig1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libfontconfig1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "526" }, { "name": "syft:metadata:source", "value": "fontconfig" } ] }, { "bom-ref": "pkg:deb/debian/libfreetype6@2.10.4+dfsg-1+deb11u1?arch=amd64\u0026upstream=freetype\u0026distro=debian-11\u0026package-id=7ba2061e1be5baf", "type": "library", "publisher": "Hugh McMaster \u003chugh.mcmaster@outlook.com\u003e", "name": "libfreetype6", "version": "2.10.4+dfsg-1+deb11u1", "licenses": [ { "license": { "id": "Apache-2.0" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "FSFAP" } }, { "license": { "id": "FSFUL" } }, { "license": { "id": "FSFULLR" } }, { "license": { "id": "FTL" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "MIT" } }, { "license": { "id": "OFL-1.1" } }, { "license": { "id": "Zlib" } } ], "cpe": "cpe:2.3:a:libfreetype6:libfreetype6:2.10.4\\+dfsg-1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libfreetype6@2.10.4+dfsg-1+deb11u1?arch=amd64\u0026upstream=freetype\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libfreetype6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libfreetype6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "896" }, { "name": "syft:metadata:source", "value": "freetype" } ] }, { "bom-ref": "pkg:deb/debian/libgcc-s1@10.2.1-6?arch=amd64\u0026upstream=gcc-10\u0026distro=debian-11\u0026package-id=352e69adb0683b92", "type": "library", "publisher": "Debian GCC Maintainers \u003cdebian-gcc@lists.debian.org\u003e", "name": "libgcc-s1", "version": "10.2.1-6", "licenses": [ { "license": { "id": "GFDL-1.2" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:libgcc-s1:libgcc-s1:10.2.1-6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgcc-s1@10.2.1-6?arch=amd64\u0026upstream=gcc-10\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgcc-s1:libgcc_s1:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgcc_s1:libgcc-s1:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgcc_s1:libgcc_s1:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgcc:libgcc-s1:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgcc:libgcc_s1:10.2.1-6:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/gcc-10-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgcc-s1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "116" }, { "name": "syft:metadata:source", "value": "gcc-10" } ] }, { "bom-ref": "pkg:deb/debian/libgcrypt20@1.8.7-6?arch=amd64\u0026distro=debian-11\u0026package-id=e3ab61bc63d33d56", "type": "library", "publisher": "Debian GnuTLS Maintainers \u003cpkg-gnutls-maint@lists.alioth.debian.org\u003e", "name": "libgcrypt20", "version": "1.8.7-6", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libgcrypt20:libgcrypt20:1.8.7-6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgcrypt20@1.8.7-6?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libgcrypt20/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgcrypt20:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1355" } ] }, { "bom-ref": "pkg:deb/debian/libgd3@2.3.0-2?arch=amd64\u0026upstream=libgd2\u0026distro=debian-11\u0026package-id=5b4feba98e2fbc55", "type": "library", "publisher": "GD Team \u003cteam+gd@tracker.debian.org\u003e", "name": "libgd3", "version": "2.3.0-2", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GD" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "HPND" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libgd3:libgd3:2.3.0-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgd3@2.3.0-2?arch=amd64\u0026upstream=libgd2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libgd3/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgd3:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "463" }, { "name": "syft:metadata:source", "value": "libgd2" } ] }, { "bom-ref": "pkg:deb/debian/libgeoip1@1.6.12-7?arch=amd64\u0026upstream=geoip\u0026distro=debian-11\u0026package-id=9002a34773325a1c", "type": "library", "publisher": "Patrick Matthäi \u003cpmatthaei@debian.org\u003e", "name": "libgeoip1", "version": "1.6.12-7", "licenses": [ { "license": { "id": "ISC" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } } ], "cpe": "cpe:2.3:a:libgeoip1:libgeoip1:1.6.12-7:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgeoip1@1.6.12-7?arch=amd64\u0026upstream=geoip\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libgeoip1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgeoip1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "286" }, { "name": "syft:metadata:source", "value": "geoip" } ] }, { "bom-ref": "pkg:deb/debian/libgmp10@2:6.2.1+dfsg-1+deb11u1?arch=amd64\u0026upstream=gmp\u0026distro=debian-11\u0026package-id=57115b2699bb339", "type": "library", "publisher": "Debian Science Team \u003cdebian-science-maintainers@lists.alioth.debian.org\u003e", "name": "libgmp10", "version": "2:6.2.1+dfsg-1+deb11u1", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "LGPL-3.0" } } ], "cpe": "cpe:2.3:a:libgmp10:libgmp10:2\\:6.2.1\\+dfsg-1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgmp10@2:6.2.1+dfsg-1+deb11u1?arch=amd64\u0026upstream=gmp\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libgmp10/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgmp10:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "863" }, { "name": "syft:metadata:source", "value": "gmp" } ] }, { "bom-ref": "pkg:deb/debian/libgnutls30@3.7.1-5+deb11u3?arch=amd64\u0026upstream=gnutls28\u0026distro=debian-11\u0026package-id=bf66536720b4dcfe", "type": "library", "publisher": "Debian GnuTLS Maintainers \u003cpkg-gnutls-maint@lists.alioth.debian.org\u003e", "name": "libgnutls30", "version": "3.7.1-5+deb11u3", "licenses": [ { "license": { "id": "Apache-2.0" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GFDL-1.3" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "LGPL-3.0" } } ], "cpe": "cpe:2.3:a:libgnutls30:libgnutls30:3.7.1-5\\+deb11u3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgnutls30@3.7.1-5+deb11u3?arch=amd64\u0026upstream=gnutls28\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libgnutls30/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgnutls30:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "3143" }, { "name": "syft:metadata:source", "value": "gnutls28" } ] }, { "bom-ref": "pkg:deb/debian/libgpg-error0@1.38-2?arch=amd64\u0026upstream=libgpg-error\u0026distro=debian-11\u0026package-id=677aef193106482b", "type": "library", "publisher": "Debian GnuPG Maintainers \u003cpkg-gnupg-maint@lists.alioth.debian.org\u003e", "name": "libgpg-error0", "version": "1.38-2", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } } ], "cpe": "cpe:2.3:a:libgpg-error0:libgpg-error0:1.38-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgpg-error0@1.38-2?arch=amd64\u0026upstream=libgpg-error\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgpg-error0:libgpg_error0:1.38-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgpg_error0:libgpg-error0:1.38-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgpg_error0:libgpg_error0:1.38-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgpg:libgpg-error0:1.38-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgpg:libgpg_error0:1.38-2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libgpg-error0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgpg-error0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "188" }, { "name": "syft:metadata:source", "value": "libgpg-error" } ] }, { "bom-ref": "pkg:deb/debian/libgssapi-krb5-2@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11\u0026package-id=9a954f4678ff1512", "type": "library", "publisher": "Sam Hartman \u003chartmans@debian.org\u003e", "name": "libgssapi-krb5-2", "version": "1.18.3-6+deb11u3", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libgssapi-krb5-2:libgssapi-krb5-2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libgssapi-krb5-2@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi-krb5-2:libgssapi_krb5_2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi_krb5_2:libgssapi-krb5-2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi_krb5_2:libgssapi_krb5_2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi-krb5:libgssapi-krb5-2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi-krb5:libgssapi_krb5_2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi_krb5:libgssapi-krb5-2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi_krb5:libgssapi_krb5_2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi:libgssapi-krb5-2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libgssapi:libgssapi_krb5_2:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libgssapi-krb5-2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libgssapi-krb5-2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "451" }, { "name": "syft:metadata:source", "value": "krb5" } ] }, { "bom-ref": "pkg:deb/debian/libhogweed6@3.7.3-1?arch=amd64\u0026upstream=nettle\u0026distro=debian-11\u0026package-id=d1c80e04153ae86f", "type": "library", "publisher": "Magnus Holmgren \u003cholmgren@debian.org\u003e", "name": "libhogweed6", "version": "3.7.3-1", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-3.0+" } } ], "cpe": "cpe:2.3:a:libhogweed6:libhogweed6:3.7.3-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libhogweed6@3.7.3-1?arch=amd64\u0026upstream=nettle\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libhogweed6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libhogweed6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "455" }, { "name": "syft:metadata:source", "value": "nettle" } ] }, { "bom-ref": "pkg:deb/debian/libicu67@67.1-7?arch=amd64\u0026upstream=icu\u0026distro=debian-11\u0026package-id=865912b631767102", "type": "library", "publisher": "Laszlo Boszormenyi (GCS) \u003cgcs@debian.org\u003e", "name": "libicu67", "version": "67.1-7", "cpe": "cpe:2.3:a:libicu67:libicu67:67.1-7:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libicu67@67.1-7?arch=amd64\u0026upstream=icu\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libicu67/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libicu67:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "33152" }, { "name": "syft:metadata:source", "value": "icu" } ] }, { "bom-ref": "pkg:deb/debian/libidn2-0@2.3.0-5?arch=amd64\u0026upstream=libidn2\u0026distro=debian-11\u0026package-id=a8db53ebfc253c16", "type": "library", "publisher": "Debian Libidn team \u003chelp-libidn@gnu.org\u003e", "name": "libidn2-0", "version": "2.3.0-5", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } } ], "cpe": "cpe:2.3:a:libidn2-0:libidn2-0:2.3.0-5:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libidn2-0@2.3.0-5?arch=amd64\u0026upstream=libidn2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libidn2-0:libidn2_0:2.3.0-5:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libidn2_0:libidn2-0:2.3.0-5:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libidn2_0:libidn2_0:2.3.0-5:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libidn2:libidn2-0:2.3.0-5:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libidn2:libidn2_0:2.3.0-5:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libidn2-0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libidn2-0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "300" }, { "name": "syft:metadata:source", "value": "libidn2" } ] }, { "bom-ref": "pkg:maven/libintl/libintl@0.21?package-id=f24853b33867d342", "type": "library", "name": "libintl", "version": "0.21", "cpe": "cpe:2.3:a:libintl:libintl:0.21:*:*:*:*:*:*:*", "purl": "pkg:maven/libintl/libintl@0.21", "externalReferences": [ { "url": "", "hashes": [ { "alg": "SHA-1", "content": "568f3f90c3d6aced58de033a3547ccd2e4e088e8" } ], "type": "build-meta" } ], "properties": [ { "name": "syft:package:foundBy", "value": "java-cataloger" }, { "name": "syft:package:language", "value": "java" }, { "name": "syft:package:metadataType", "value": "JavaMetadata" }, { "name": "syft:package:type", "value": "java-archive" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/java/libintl-0.21.jar" }, { "name": "syft:metadata:virtualPath", "value": "/usr/share/java/libintl-0.21.jar" } ] }, { "bom-ref": "pkg:deb/debian/libjbig0@2.1-3.1+b2?arch=amd64\u0026upstream=jbigkit%402.1-3.1\u0026distro=debian-11\u0026package-id=a9f622da54ffe9f0", "type": "library", "publisher": "Michael van der Kolff \u003cmvanderkolff@gmail.com\u003e", "name": "libjbig0", "version": "2.1-3.1+b2", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } } ], "cpe": "cpe:2.3:a:libjbig0:libjbig0:2.1-3.1\\+b2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libjbig0@2.1-3.1+b2?arch=amd64\u0026upstream=jbigkit%402.1-3.1\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libjbig0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libjbig0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "78" }, { "name": "syft:metadata:source", "value": "jbigkit" }, { "name": "syft:metadata:sourceVersion", "value": "2.1-3.1" } ] }, { "bom-ref": "pkg:deb/debian/libjpeg62-turbo@1:2.0.6-4?arch=amd64\u0026upstream=libjpeg-turbo\u0026distro=debian-11\u0026package-id=72a51f62b0e29fa9", "type": "library", "publisher": "Ondřej Surý \u003condrej@debian.org\u003e", "name": "libjpeg62-turbo", "version": "1:2.0.6-4", "licenses": [ { "license": { "id": "NTP" } }, { "license": { "id": "Zlib" } } ], "cpe": "cpe:2.3:a:libjpeg62-turbo:libjpeg62-turbo:1\\:2.0.6-4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libjpeg62-turbo@1:2.0.6-4?arch=amd64\u0026upstream=libjpeg-turbo\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libjpeg62-turbo:libjpeg62_turbo:1\\:2.0.6-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libjpeg62_turbo:libjpeg62-turbo:1\\:2.0.6-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libjpeg62_turbo:libjpeg62_turbo:1\\:2.0.6-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libjpeg62:libjpeg62-turbo:1\\:2.0.6-4:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libjpeg62:libjpeg62_turbo:1\\:2.0.6-4:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libjpeg62-turbo/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libjpeg62-turbo:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "586" }, { "name": "syft:metadata:source", "value": "libjpeg-turbo" } ] }, { "bom-ref": "pkg:deb/debian/libk5crypto3@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11\u0026package-id=a89daeddeedc1916", "type": "library", "publisher": "Sam Hartman \u003chartmans@debian.org\u003e", "name": "libk5crypto3", "version": "1.18.3-6+deb11u3", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libk5crypto3:libk5crypto3:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libk5crypto3@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libk5crypto3/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libk5crypto3:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "296" }, { "name": "syft:metadata:source", "value": "krb5" } ] }, { "bom-ref": "pkg:deb/debian/libkeyutils1@1.6.1-2?arch=amd64\u0026upstream=keyutils\u0026distro=debian-11\u0026package-id=bbf061999ae08758", "type": "library", "publisher": "Christian Kastner \u003cckk@debian.org\u003e", "name": "libkeyutils1", "version": "1.6.1-2", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } } ], "cpe": "cpe:2.3:a:libkeyutils1:libkeyutils1:1.6.1-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libkeyutils1@1.6.1-2?arch=amd64\u0026upstream=keyutils\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libkeyutils1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libkeyutils1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "46" }, { "name": "syft:metadata:source", "value": "keyutils" } ] }, { "bom-ref": "pkg:deb/debian/libkrb5-3@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11\u0026package-id=ac9319908ea9ef26", "type": "library", "publisher": "Sam Hartman \u003chartmans@debian.org\u003e", "name": "libkrb5-3", "version": "1.18.3-6+deb11u3", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libkrb5-3:libkrb5-3:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libkrb5-3@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libkrb5-3:libkrb5_3:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libkrb5_3:libkrb5-3:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libkrb5_3:libkrb5_3:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libkrb5:libkrb5-3:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libkrb5:libkrb5_3:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libkrb5-3/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libkrb5-3:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1108" }, { "name": "syft:metadata:source", "value": "krb5" } ] }, { "bom-ref": "pkg:deb/debian/libkrb5support0@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11\u0026package-id=40eecc99b71ae26", "type": "library", "publisher": "Sam Hartman \u003chartmans@debian.org\u003e", "name": "libkrb5support0", "version": "1.18.3-6+deb11u3", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libkrb5support0:libkrb5support0:1.18.3-6\\+deb11u3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libkrb5support0@1.18.3-6+deb11u3?arch=amd64\u0026upstream=krb5\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libkrb5support0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libkrb5support0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "169" }, { "name": "syft:metadata:source", "value": "krb5" } ] }, { "bom-ref": "pkg:deb/debian/libldap-2.4-2@2.4.57+dfsg-3+deb11u1?arch=amd64\u0026upstream=openldap\u0026distro=debian-11\u0026package-id=9e27bcd1ae116ee8", "type": "library", "publisher": "Debian OpenLDAP Maintainers \u003cpkg-openldap-devel@lists.alioth.debian.org\u003e", "name": "libldap-2.4-2", "version": "2.4.57+dfsg-3+deb11u1", "cpe": "cpe:2.3:a:libldap-2.4-2:libldap-2.4-2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libldap-2.4-2@2.4.57+dfsg-3+deb11u1?arch=amd64\u0026upstream=openldap\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap-2.4-2:libldap_2.4_2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap_2.4_2:libldap-2.4-2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap_2.4_2:libldap_2.4_2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap-2.4:libldap-2.4-2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap-2.4:libldap_2.4_2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap_2.4:libldap-2.4-2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap_2.4:libldap_2.4_2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap:libldap-2.4-2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libldap:libldap_2.4_2:2.4.57\\+dfsg-3\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libldap-2.4-2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libldap-2.4-2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "539" }, { "name": "syft:metadata:source", "value": "openldap" } ] }, { "bom-ref": "pkg:deb/debian/liblz4-1@1.9.3-2?arch=amd64\u0026upstream=lz4\u0026distro=debian-11\u0026package-id=6372d748473ab2a2", "type": "library", "publisher": "Nobuhiro Iwamatsu \u003ciwamatsu@debian.org\u003e", "name": "liblz4-1", "version": "1.9.3-2", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } } ], "cpe": "cpe:2.3:a:liblz4-1:liblz4-1:1.9.3-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/liblz4-1@1.9.3-2?arch=amd64\u0026upstream=lz4\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:liblz4-1:liblz4_1:1.9.3-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:liblz4_1:liblz4-1:1.9.3-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:liblz4_1:liblz4_1:1.9.3-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:liblz4:liblz4-1:1.9.3-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:liblz4:liblz4_1:1.9.3-2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/liblz4-1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/liblz4-1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "157" }, { "name": "syft:metadata:source", "value": "lz4" } ] }, { "bom-ref": "pkg:deb/debian/liblzma5@5.2.5-2.1~deb11u1?arch=amd64\u0026upstream=xz-utils\u0026distro=debian-11\u0026package-id=da0416f52e605d88", "type": "library", "publisher": "Jonathan Nieder \u003cjrnieder@gmail.com\u003e", "name": "liblzma5", "version": "5.2.5-2.1~deb11u1", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } } ], "cpe": "cpe:2.3:a:liblzma5:liblzma5:5.2.5-2.1\\~deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/liblzma5@5.2.5-2.1~deb11u1?arch=amd64\u0026upstream=xz-utils\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/liblzma5/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/liblzma5:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "277" }, { "name": "syft:metadata:source", "value": "xz-utils" } ] }, { "bom-ref": "pkg:deb/debian/libmd0@1.0.3-3?arch=amd64\u0026upstream=libmd\u0026distro=debian-11\u0026package-id=7baddf842fccc6ac", "type": "library", "publisher": "Guillem Jover \u003cguillem@debian.org\u003e", "name": "libmd0", "version": "1.0.3-3", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-2-Clause-NetBSD" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "Beerware" } }, { "license": { "id": "ISC" } } ], "cpe": "cpe:2.3:a:libmd0:libmd0:1.0.3-3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libmd0@1.0.3-3?arch=amd64\u0026upstream=libmd\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libmd0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libmd0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "77" }, { "name": "syft:metadata:source", "value": "libmd" } ] }, { "bom-ref": "pkg:deb/debian/libmount1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11\u0026package-id=8d0189ae4d84d16", "type": "library", "publisher": "util-linux packagers \u003cutil-linux@packages.debian.org\u003e", "name": "libmount1", "version": "2.36.1-8+deb11u1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libmount1:libmount1:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libmount1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libmount1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libmount1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "477" }, { "name": "syft:metadata:source", "value": "util-linux" } ] }, { "bom-ref": "pkg:deb/debian/libnettle8@3.7.3-1?arch=amd64\u0026upstream=nettle\u0026distro=debian-11\u0026package-id=bda9c00ca69e11a8", "type": "library", "publisher": "Magnus Holmgren \u003cholmgren@debian.org\u003e", "name": "libnettle8", "version": "3.7.3-1", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-3.0+" } } ], "cpe": "cpe:2.3:a:libnettle8:libnettle8:3.7.3-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libnettle8@3.7.3-1?arch=amd64\u0026upstream=nettle\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libnettle8/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libnettle8:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "480" }, { "name": "syft:metadata:source", "value": "nettle" } ] }, { "bom-ref": "pkg:deb/debian/libnghttp2-14@1.43.0-1?arch=amd64\u0026upstream=nghttp2\u0026distro=debian-11\u0026package-id=706d0b055b41596b", "type": "library", "publisher": "Tomasz Buchert \u003ctomasz@debian.org\u003e", "name": "libnghttp2-14", "version": "1.43.0-1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libnghttp2-14:libnghttp2-14:1.43.0-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libnghttp2-14@1.43.0-1?arch=amd64\u0026upstream=nghttp2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libnghttp2-14:libnghttp2_14:1.43.0-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libnghttp2_14:libnghttp2-14:1.43.0-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libnghttp2_14:libnghttp2_14:1.43.0-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libnghttp2:libnghttp2-14:1.43.0-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libnghttp2:libnghttp2_14:1.43.0-1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libnghttp2-14/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libnghttp2-14:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "217" }, { "name": "syft:metadata:source", "value": "nghttp2" } ] }, { "bom-ref": "pkg:deb/debian/libnsl2@1.3.0-2?arch=amd64\u0026upstream=libnsl\u0026distro=debian-11\u0026package-id=b3ecde50c64e6f4d", "type": "library", "publisher": "GNU Libc Maintainers \u003cdebian-glibc@lists.debian.org\u003e", "name": "libnsl2", "version": "1.3.0-2", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libnsl2:libnsl2:1.3.0-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libnsl2@1.3.0-2?arch=amd64\u0026upstream=libnsl\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libnsl2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libnsl2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "127" }, { "name": "syft:metadata:source", "value": "libnsl" } ] }, { "bom-ref": "pkg:deb/debian/libp11-kit0@0.23.22-1?arch=amd64\u0026upstream=p11-kit\u0026distro=debian-11\u0026package-id=addea27288da0292", "type": "library", "publisher": "Debian GnuTLS Maintainers \u003cpkg-gnutls-maint@lists.alioth.debian.org\u003e", "name": "libp11-kit0", "version": "0.23.22-1", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "ISC" } } ], "cpe": "cpe:2.3:a:libp11-kit0:libp11-kit0:0.23.22-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libp11-kit0@0.23.22-1?arch=amd64\u0026upstream=p11-kit\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libp11-kit0:libp11_kit0:0.23.22-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libp11_kit0:libp11-kit0:0.23.22-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libp11_kit0:libp11_kit0:0.23.22-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libp11:libp11-kit0:0.23.22-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libp11:libp11_kit0:0.23.22-1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libp11-kit0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libp11-kit0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1401" }, { "name": "syft:metadata:source", "value": "p11-kit" } ] }, { "bom-ref": "pkg:deb/debian/libpam-modules@1.4.0-9+deb11u1?arch=amd64\u0026upstream=pam\u0026distro=debian-11\u0026package-id=dbf0d9a6d8661817", "type": "library", "publisher": "Steve Langasek \u003cvorlon@debian.org\u003e", "name": "libpam-modules", "version": "1.4.0-9+deb11u1", "cpe": "cpe:2.3:a:libpam-modules:libpam-modules:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpam-modules@1.4.0-9+deb11u1?arch=amd64\u0026upstream=pam\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam-modules:libpam_modules:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_modules:libpam-modules:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_modules:libpam_modules:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam:libpam-modules:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam:libpam_modules:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpam-modules/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpam-modules:amd64.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libpam-modules:amd64.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1048" }, { "name": "syft:metadata:source", "value": "pam" } ] }, { "bom-ref": "pkg:deb/debian/libpam-modules-bin@1.4.0-9+deb11u1?arch=amd64\u0026upstream=pam\u0026distro=debian-11\u0026package-id=6196393100a266d5", "type": "library", "publisher": "Steve Langasek \u003cvorlon@debian.org\u003e", "name": "libpam-modules-bin", "version": "1.4.0-9+deb11u1", "cpe": "cpe:2.3:a:libpam-modules-bin:libpam-modules-bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpam-modules-bin@1.4.0-9+deb11u1?arch=amd64\u0026upstream=pam\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam-modules-bin:libpam_modules_bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_modules_bin:libpam-modules-bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_modules_bin:libpam_modules_bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam-modules:libpam-modules-bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam-modules:libpam_modules_bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_modules:libpam-modules-bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_modules:libpam_modules_bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam:libpam-modules-bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam:libpam_modules_bin:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpam-modules-bin/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpam-modules-bin.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "227" }, { "name": "syft:metadata:source", "value": "pam" } ] }, { "bom-ref": "pkg:deb/debian/libpam-runtime@1.4.0-9+deb11u1?arch=all\u0026upstream=pam\u0026distro=debian-11\u0026package-id=62db6ed4651db63c", "type": "library", "publisher": "Steve Langasek \u003cvorlon@debian.org\u003e", "name": "libpam-runtime", "version": "1.4.0-9+deb11u1", "cpe": "cpe:2.3:a:libpam-runtime:libpam-runtime:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpam-runtime@1.4.0-9+deb11u1?arch=all\u0026upstream=pam\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam-runtime:libpam_runtime:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_runtime:libpam-runtime:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam_runtime:libpam_runtime:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam:libpam-runtime:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpam:libpam_runtime:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpam-runtime/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpam-runtime.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libpam-runtime.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "965" }, { "name": "syft:metadata:source", "value": "pam" } ] }, { "bom-ref": "pkg:deb/debian/libpam0g@1.4.0-9+deb11u1?arch=amd64\u0026upstream=pam\u0026distro=debian-11\u0026package-id=4e92ce4a0cadd805", "type": "library", "publisher": "Steve Langasek \u003cvorlon@debian.org\u003e", "name": "libpam0g", "version": "1.4.0-9+deb11u1", "cpe": "cpe:2.3:a:libpam0g:libpam0g:1.4.0-9\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpam0g@1.4.0-9+deb11u1?arch=amd64\u0026upstream=pam\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpam0g/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpam0g:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "244" }, { "name": "syft:metadata:source", "value": "pam" } ] }, { "bom-ref": "pkg:deb/debian/libpcre2-8-0@10.36-2+deb11u1?arch=amd64\u0026upstream=pcre2\u0026distro=debian-11\u0026package-id=854e0b1f08c7dad8", "type": "library", "publisher": "Matthew Vernon \u003cmatthew@debian.org\u003e", "name": "libpcre2-8-0", "version": "10.36-2+deb11u1", "cpe": "cpe:2.3:a:libpcre2-8-0:libpcre2-8-0:10.36-2\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpcre2-8-0@10.36-2+deb11u1?arch=amd64\u0026upstream=pcre2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2-8-0:libpcre2_8_0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2_8_0:libpcre2-8-0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2_8_0:libpcre2_8_0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2-8:libpcre2-8-0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2-8:libpcre2_8_0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2_8:libpcre2-8-0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2_8:libpcre2_8_0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2:libpcre2-8-0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpcre2:libpcre2_8_0:10.36-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpcre2-8-0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpcre2-8-0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "664" }, { "name": "syft:metadata:source", "value": "pcre2" } ] }, { "bom-ref": "pkg:deb/debian/libpcre3@2:8.39-13?arch=amd64\u0026upstream=pcre3\u0026distro=debian-11\u0026package-id=9bfc1facaf92a9e8", "type": "library", "publisher": "Matthew Vernon \u003cmatthew@debian.org\u003e", "name": "libpcre3", "version": "2:8.39-13", "cpe": "cpe:2.3:a:libpcre3:libpcre3:2\\:8.39-13:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpcre3@2:8.39-13?arch=amd64\u0026upstream=pcre3\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpcre3/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpcre3:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "669" }, { "name": "syft:metadata:source", "value": "pcre3" } ] }, { "bom-ref": "pkg:deb/debian/libpng16-16@1.6.37-3?arch=amd64\u0026upstream=libpng1.6\u0026distro=debian-11\u0026package-id=f867a818b899a809", "type": "library", "publisher": "Maintainers of libpng1.6 packages \u003clibpng1.6@packages.debian.org\u003e", "name": "libpng16-16", "version": "1.6.37-3", "licenses": [ { "license": { "id": "Apache-2.0" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "Libpng" } } ], "cpe": "cpe:2.3:a:libpng16-16:libpng16-16:1.6.37-3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpng16-16@1.6.37-3?arch=amd64\u0026upstream=libpng1.6\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpng16-16:libpng16_16:1.6.37-3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpng16_16:libpng16-16:1.6.37-3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpng16_16:libpng16_16:1.6.37-3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpng16:libpng16-16:1.6.37-3:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libpng16:libpng16_16:1.6.37-3:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpng16-16/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpng16-16:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "444" }, { "name": "syft:metadata:source", "value": "libpng1.6" } ] }, { "bom-ref": "pkg:deb/debian/libpsl5@0.21.0-1.2?arch=amd64\u0026upstream=libpsl\u0026distro=debian-11\u0026package-id=765ef20aed5ddd31", "type": "library", "publisher": "Tim Rühsen \u003ctim.ruehsen@gmx.de\u003e", "name": "libpsl5", "version": "0.21.0-1.2", "licenses": [ { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libpsl5:libpsl5:0.21.0-1.2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libpsl5@0.21.0-1.2?arch=amd64\u0026upstream=libpsl\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libpsl5/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libpsl5:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "95" }, { "name": "syft:metadata:source", "value": "libpsl" } ] }, { "bom-ref": "pkg:deb/debian/libreadline8@8.1-1?arch=amd64\u0026upstream=readline\u0026distro=debian-11\u0026package-id=a1ba6d0f43e9c188", "type": "library", "publisher": "Matthias Klose \u003cdoko@debian.org\u003e", "name": "libreadline8", "version": "8.1-1", "licenses": [ { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:libreadline8:libreadline8:8.1-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libreadline8@8.1-1?arch=amd64\u0026upstream=readline\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libreadline8/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libreadline8:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "471" }, { "name": "syft:metadata:source", "value": "readline" } ] }, { "bom-ref": "pkg:deb/debian/librtmp1@2.4+20151223.gitfa8646d.1-2+b2?arch=amd64\u0026upstream=rtmpdump%402.4+20151223.gitfa8646d.1-2\u0026distro=debian-11\u0026package-id=cfa17bca9fc30d68", "type": "library", "publisher": "Debian Multimedia Maintainers \u003cdebian-multimedia@lists.debian.org\u003e", "name": "librtmp1", "version": "2.4+20151223.gitfa8646d.1-2+b2", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:librtmp1:librtmp1:2.4\\+20151223.gitfa8646d.1-2\\+b2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/librtmp1@2.4+20151223.gitfa8646d.1-2+b2?arch=amd64\u0026upstream=rtmpdump%402.4+20151223.gitfa8646d.1-2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/librtmp1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/librtmp1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "146" }, { "name": "syft:metadata:source", "value": "rtmpdump" }, { "name": "syft:metadata:sourceVersion", "value": "2.4+20151223.gitfa8646d.1-2" } ] }, { "bom-ref": "pkg:deb/debian/libsasl2-2@2.1.27+dfsg-2.1+deb11u1?arch=amd64\u0026upstream=cyrus-sasl2\u0026distro=debian-11\u0026package-id=a5871793ccc698d8", "type": "library", "publisher": "Debian Cyrus Team \u003cteam+cyrus@tracker.debian.org\u003e", "name": "libsasl2-2", "version": "2.1.27+dfsg-2.1+deb11u1", "licenses": [ { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } } ], "cpe": "cpe:2.3:a:libsasl2-2:libsasl2-2:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libsasl2-2@2.1.27+dfsg-2.1+deb11u1?arch=amd64\u0026upstream=cyrus-sasl2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2-2:libsasl2_2:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2_2:libsasl2-2:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2_2:libsasl2_2:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2:libsasl2-2:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2:libsasl2_2:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libsasl2-2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libsasl2-2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "188" }, { "name": "syft:metadata:source", "value": "cyrus-sasl2" } ] }, { "bom-ref": "pkg:deb/debian/libsasl2-modules-db@2.1.27+dfsg-2.1+deb11u1?arch=amd64\u0026upstream=cyrus-sasl2\u0026distro=debian-11\u0026package-id=f92fc6781e322081", "type": "library", "publisher": "Debian Cyrus Team \u003cteam+cyrus@tracker.debian.org\u003e", "name": "libsasl2-modules-db", "version": "2.1.27+dfsg-2.1+deb11u1", "licenses": [ { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } } ], "cpe": "cpe:2.3:a:libsasl2-modules-db:libsasl2-modules-db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libsasl2-modules-db@2.1.27+dfsg-2.1+deb11u1?arch=amd64\u0026upstream=cyrus-sasl2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2-modules-db:libsasl2_modules_db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2_modules_db:libsasl2-modules-db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2_modules_db:libsasl2_modules_db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2-modules:libsasl2-modules-db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2-modules:libsasl2_modules_db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2_modules:libsasl2-modules-db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2_modules:libsasl2_modules_db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2:libsasl2-modules-db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsasl2:libsasl2_modules_db:2.1.27\\+dfsg-2.1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libsasl2-modules-db/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libsasl2-modules-db:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "101" }, { "name": "syft:metadata:source", "value": "cyrus-sasl2" } ] }, { "bom-ref": "pkg:deb/debian/libseccomp2@2.5.1-1+deb11u1?arch=amd64\u0026upstream=libseccomp\u0026distro=debian-11\u0026package-id=dc08faabe8c53d70", "type": "library", "publisher": "Kees Cook \u003ckees@debian.org\u003e", "name": "libseccomp2", "version": "2.5.1-1+deb11u1", "licenses": [ { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libseccomp2:libseccomp2:2.5.1-1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libseccomp2@2.5.1-1+deb11u1?arch=amd64\u0026upstream=libseccomp\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libseccomp2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libseccomp2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "158" }, { "name": "syft:metadata:source", "value": "libseccomp" } ] }, { "bom-ref": "pkg:deb/debian/libselinux1@3.1-3?arch=amd64\u0026upstream=libselinux\u0026distro=debian-11\u0026package-id=c22e716b79ae3091", "type": "library", "publisher": "Debian SELinux maintainers \u003cselinux-devel@lists.alioth.debian.org\u003e", "name": "libselinux1", "version": "3.1-3", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libselinux1:libselinux1:3.1-3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libselinux1@3.1-3?arch=amd64\u0026upstream=libselinux\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libselinux1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libselinux1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "207" }, { "name": "syft:metadata:source", "value": "libselinux" } ] }, { "bom-ref": "pkg:deb/debian/libsemanage-common@3.1-1?arch=all\u0026upstream=libsemanage\u0026distro=debian-11\u0026package-id=69e74fba97dd00a1", "type": "library", "publisher": "Debian SELinux maintainers \u003cselinux-devel@lists.alioth.debian.org\u003e", "name": "libsemanage-common", "version": "3.1-1", "cpe": "cpe:2.3:a:libsemanage-common:libsemanage-common:3.1-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libsemanage-common@3.1-1?arch=all\u0026upstream=libsemanage\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsemanage-common:libsemanage_common:3.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsemanage_common:libsemanage-common:3.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsemanage_common:libsemanage_common:3.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsemanage:libsemanage-common:3.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libsemanage:libsemanage_common:3.1-1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libsemanage-common/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libsemanage-common.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libsemanage-common.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "36" }, { "name": "syft:metadata:source", "value": "libsemanage" } ] }, { "bom-ref": "pkg:deb/debian/libsemanage1@3.1-1+b2?arch=amd64\u0026upstream=libsemanage%403.1-1\u0026distro=debian-11\u0026package-id=3ceab259adb7a79e", "type": "library", "publisher": "Debian SELinux maintainers \u003cselinux-devel@lists.alioth.debian.org\u003e", "name": "libsemanage1", "version": "3.1-1+b2", "cpe": "cpe:2.3:a:libsemanage1:libsemanage1:3.1-1\\+b2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libsemanage1@3.1-1+b2?arch=amd64\u0026upstream=libsemanage%403.1-1\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libsemanage1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libsemanage1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "307" }, { "name": "syft:metadata:source", "value": "libsemanage" }, { "name": "syft:metadata:sourceVersion", "value": "3.1-1" } ] }, { "bom-ref": "pkg:deb/debian/libsepol1@3.1-1?arch=amd64\u0026upstream=libsepol\u0026distro=debian-11\u0026package-id=e9dd9e853016e5ac", "type": "library", "publisher": "Debian SELinux maintainers \u003cselinux-devel@lists.alioth.debian.org\u003e", "name": "libsepol1", "version": "3.1-1", "cpe": "cpe:2.3:a:libsepol1:libsepol1:3.1-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libsepol1@3.1-1?arch=amd64\u0026upstream=libsepol\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libsepol1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libsepol1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "743" }, { "name": "syft:metadata:source", "value": "libsepol" } ] }, { "bom-ref": "pkg:deb/debian/libsmartcols1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11\u0026package-id=7665905243694a74", "type": "library", "publisher": "util-linux packagers \u003cutil-linux@packages.debian.org\u003e", "name": "libsmartcols1", "version": "2.36.1-8+deb11u1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libsmartcols1:libsmartcols1:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libsmartcols1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libsmartcols1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libsmartcols1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "328" }, { "name": "syft:metadata:source", "value": "util-linux" } ] }, { "bom-ref": "pkg:deb/debian/libss2@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11\u0026package-id=f23e5139ba9365a3", "type": "library", "publisher": "Theodore Y. Ts'o \u003ctytso@mit.edu\u003e", "name": "libss2", "version": "1.46.2-2", "cpe": "cpe:2.3:a:libss2:libss2:1.46.2-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libss2@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libss2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libss2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "113" }, { "name": "syft:metadata:source", "value": "e2fsprogs" } ] }, { "bom-ref": "pkg:deb/debian/libssh2-1@1.9.0-2?arch=amd64\u0026upstream=libssh2\u0026distro=debian-11\u0026package-id=5a655866eefe5378", "type": "library", "publisher": "Nicolas Mora \u003cbabelouest@debian.org\u003e", "name": "libssh2-1", "version": "1.9.0-2", "cpe": "cpe:2.3:a:libssh2-1:libssh2-1:1.9.0-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libssh2-1@1.9.0-2?arch=amd64\u0026upstream=libssh2\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libssh2-1:libssh2_1:1.9.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libssh2_1:libssh2-1:1.9.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libssh2_1:libssh2_1:1.9.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libssh2:libssh2-1:1.9.0-2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libssh2:libssh2_1:1.9.0-2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libssh2-1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libssh2-1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "298" }, { "name": "syft:metadata:source", "value": "libssh2" } ] }, { "bom-ref": "pkg:deb/debian/libssl1.1@1.1.1n-0+deb11u4?arch=amd64\u0026upstream=openssl\u0026distro=debian-11\u0026package-id=fc9ec2c4e21109e9", "type": "library", "publisher": "Debian OpenSSL Team \u003cpkg-openssl-devel@lists.alioth.debian.org\u003e", "name": "libssl1.1", "version": "1.1.1n-0+deb11u4", "cpe": "cpe:2.3:a:libssl1.1:libssl1.1:1.1.1n-0\\+deb11u4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libssl1.1@1.1.1n-0+deb11u4?arch=amd64\u0026upstream=openssl\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libssl1.1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libssl1.1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "4124" }, { "name": "syft:metadata:source", "value": "openssl" } ] }, { "bom-ref": "pkg:deb/debian/libstdc++6@10.2.1-6?arch=amd64\u0026upstream=gcc-10\u0026distro=debian-11\u0026package-id=d513aaad772e74ad", "type": "library", "publisher": "Debian GCC Maintainers \u003cdebian-gcc@lists.debian.org\u003e", "name": "libstdc++6", "version": "10.2.1-6", "licenses": [ { "license": { "id": "GFDL-1.2" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:libstdc\\+\\+6:libstdc\\+\\+6:10.2.1-6:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libstdc++6@10.2.1-6?arch=amd64\u0026upstream=gcc-10\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/gcc-10-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libstdc++6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "2351" }, { "name": "syft:metadata:source", "value": "gcc-10" } ] }, { "bom-ref": "pkg:deb/debian/libsystemd0@247.3-7+deb11u2?arch=amd64\u0026upstream=systemd\u0026distro=debian-11\u0026package-id=46fd2f7cfd5479a8", "type": "library", "publisher": "Debian systemd Maintainers \u003cpkg-systemd-maintainers@lists.alioth.debian.org\u003e", "name": "libsystemd0", "version": "247.3-7+deb11u2", "licenses": [ { "license": { "id": "CC0-1.0" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } } ], "cpe": "cpe:2.3:a:libsystemd0:libsystemd0:247.3-7\\+deb11u2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libsystemd0@247.3-7+deb11u2?arch=amd64\u0026upstream=systemd\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libsystemd0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libsystemd0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "865" }, { "name": "syft:metadata:source", "value": "systemd" } ] }, { "bom-ref": "pkg:deb/debian/libtasn1-6@4.16.0-2+deb11u1?arch=amd64\u0026distro=debian-11\u0026package-id=6f9c9efbcf897d04", "type": "library", "publisher": "Debian GnuTLS Maintainers \u003cpkg-gnutls-maint@lists.alioth.debian.org\u003e", "name": "libtasn1-6", "version": "4.16.0-2+deb11u1", "licenses": [ { "license": { "id": "GFDL-1.3" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libtasn1-6:libtasn1-6:4.16.0-2\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libtasn1-6@4.16.0-2+deb11u1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtasn1-6:libtasn1_6:4.16.0-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtasn1_6:libtasn1-6:4.16.0-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtasn1_6:libtasn1_6:4.16.0-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtasn1:libtasn1-6:4.16.0-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtasn1:libtasn1_6:4.16.0-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libtasn1-6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libtasn1-6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "124" } ] }, { "bom-ref": "pkg:deb/debian/libtiff5@4.2.0-1+deb11u4?arch=amd64\u0026upstream=tiff\u0026distro=debian-11\u0026package-id=5e423e6099c788bf", "type": "library", "publisher": "Laszlo Boszormenyi (GCS) \u003cgcs@debian.org\u003e", "name": "libtiff5", "version": "4.2.0-1+deb11u4", "cpe": "cpe:2.3:a:libtiff5:libtiff5:4.2.0-1\\+deb11u4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libtiff5@4.2.0-1+deb11u4?arch=amd64\u0026upstream=tiff\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libtiff5/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libtiff5:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "677" }, { "name": "syft:metadata:source", "value": "tiff" } ] }, { "bom-ref": "pkg:deb/debian/libtinfo6@6.2+20201114-2+deb11u1?arch=amd64\u0026upstream=ncurses\u0026distro=debian-11\u0026package-id=465d0c6b1eb5724e", "type": "library", "publisher": "Craig Small \u003ccsmall@debian.org\u003e", "name": "libtinfo6", "version": "6.2+20201114-2+deb11u1", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "X11" } } ], "cpe": "cpe:2.3:a:libtinfo6:libtinfo6:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libtinfo6@6.2+20201114-2+deb11u1?arch=amd64\u0026upstream=ncurses\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libtinfo6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libtinfo6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "537" }, { "name": "syft:metadata:source", "value": "ncurses" } ] }, { "bom-ref": "pkg:deb/debian/libtirpc-common@1.3.1-1+deb11u1?arch=all\u0026upstream=libtirpc\u0026distro=debian-11\u0026package-id=534c91dc2f9aac4f", "type": "library", "publisher": "Josue Ortega \u003cjosue@debian.org\u003e", "name": "libtirpc-common", "version": "1.3.1-1+deb11u1", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libtirpc-common:libtirpc-common:1.3.1-1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libtirpc-common@1.3.1-1+deb11u1?arch=all\u0026upstream=libtirpc\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtirpc-common:libtirpc_common:1.3.1-1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtirpc_common:libtirpc-common:1.3.1-1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtirpc_common:libtirpc_common:1.3.1-1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtirpc:libtirpc-common:1.3.1-1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libtirpc:libtirpc_common:1.3.1-1\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libtirpc-common/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libtirpc-common.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/libtirpc-common.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "34" }, { "name": "syft:metadata:source", "value": "libtirpc" } ] }, { "bom-ref": "pkg:deb/debian/libtirpc3@1.3.1-1+deb11u1?arch=amd64\u0026upstream=libtirpc\u0026distro=debian-11\u0026package-id=b5f5cbb0307461aa", "type": "library", "publisher": "Josue Ortega \u003cjosue@debian.org\u003e", "name": "libtirpc3", "version": "1.3.1-1+deb11u1", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.1" } } ], "cpe": "cpe:2.3:a:libtirpc3:libtirpc3:1.3.1-1\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libtirpc3@1.3.1-1+deb11u1?arch=amd64\u0026upstream=libtirpc\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libtirpc3/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libtirpc3:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "229" }, { "name": "syft:metadata:source", "value": "libtirpc" } ] }, { "bom-ref": "pkg:deb/debian/libudev1@247.3-7+deb11u2?arch=amd64\u0026upstream=systemd\u0026distro=debian-11\u0026package-id=93385f3d9c9c393f", "type": "library", "publisher": "Debian systemd Maintainers \u003cpkg-systemd-maintainers@lists.alioth.debian.org\u003e", "name": "libudev1", "version": "247.3-7+deb11u2", "licenses": [ { "license": { "id": "CC0-1.0" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } } ], "cpe": "cpe:2.3:a:libudev1:libudev1:247.3-7\\+deb11u2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libudev1@247.3-7+deb11u2?arch=amd64\u0026upstream=systemd\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libudev1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libudev1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "282" }, { "name": "syft:metadata:source", "value": "systemd" } ] }, { "bom-ref": "pkg:deb/debian/libunistring2@0.9.10-4?arch=amd64\u0026upstream=libunistring\u0026distro=debian-11\u0026package-id=4dbb87951d2cf1f5", "type": "library", "publisher": "Jörg Frings-Fürst \u003cdebian@jff.email\u003e", "name": "libunistring2", "version": "0.9.10-4", "licenses": [ { "license": { "id": "GFDL-1.2" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libunistring2:libunistring2:0.9.10-4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libunistring2@0.9.10-4?arch=amd64\u0026upstream=libunistring\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libunistring2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libunistring2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1592" }, { "name": "syft:metadata:source", "value": "libunistring" } ] }, { "bom-ref": "pkg:deb/debian/libuuid1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11\u0026package-id=1d48540a3383b13", "type": "library", "publisher": "util-linux packagers \u003cutil-linux@packages.debian.org\u003e", "name": "libuuid1", "version": "2.36.1-8+deb11u1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:libuuid1:libuuid1:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libuuid1@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libuuid1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libuuid1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "129" }, { "name": "syft:metadata:source", "value": "util-linux" } ] }, { "bom-ref": "pkg:deb/debian/libwebp6@0.6.1-2.1?arch=amd64\u0026upstream=libwebp\u0026distro=debian-11\u0026package-id=b3f7d1fc4a69eced", "type": "library", "publisher": "Jeff Breidenbach \u003cjab@debian.org\u003e", "name": "libwebp6", "version": "0.6.1-2.1", "licenses": [ { "license": { "id": "Apache-2.0" } } ], "cpe": "cpe:2.3:a:libwebp6:libwebp6:0.6.1-2.1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libwebp6@0.6.1-2.1?arch=amd64\u0026upstream=libwebp\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libwebp6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libwebp6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "499" }, { "name": "syft:metadata:source", "value": "libwebp" } ] }, { "bom-ref": "pkg:deb/debian/libx11-6@2:1.7.2-1?arch=amd64\u0026upstream=libx11\u0026distro=debian-11\u0026package-id=3da10439a87ea980", "type": "library", "publisher": "Debian X Strike Force \u003cdebian-x@lists.debian.org\u003e", "name": "libx11-6", "version": "2:1.7.2-1", "cpe": "cpe:2.3:a:libx11-6:libx11-6:2\\:1.7.2-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libx11-6@2:1.7.2-1?arch=amd64\u0026upstream=libx11\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11-6:libx11_6:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11_6:libx11-6:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11_6:libx11_6:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11:libx11-6:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11:libx11_6:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libx11-6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libx11-6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1576" }, { "name": "syft:metadata:source", "value": "libx11" } ] }, { "bom-ref": "pkg:deb/debian/libx11-data@2:1.7.2-1?arch=all\u0026upstream=libx11\u0026distro=debian-11\u0026package-id=a2318ae0a252fe5", "type": "library", "publisher": "Debian X Strike Force \u003cdebian-x@lists.debian.org\u003e", "name": "libx11-data", "version": "2:1.7.2-1", "cpe": "cpe:2.3:a:libx11-data:libx11-data:2\\:1.7.2-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libx11-data@2:1.7.2-1?arch=all\u0026upstream=libx11\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11-data:libx11_data:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11_data:libx11-data:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11_data:libx11_data:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11:libx11-data:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:libx11:libx11_data:2\\:1.7.2-1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libx11-data/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libx11-data.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1665" }, { "name": "syft:metadata:source", "value": "libx11" } ] }, { "bom-ref": "pkg:deb/debian/libxau6@1:1.0.9-1?arch=amd64\u0026upstream=libxau\u0026distro=debian-11\u0026package-id=1edad5568198edbf", "type": "library", "publisher": "Debian X Strike Force \u003cdebian-x@lists.debian.org\u003e", "name": "libxau6", "version": "1:1.0.9-1", "cpe": "cpe:2.3:a:libxau6:libxau6:1\\:1.0.9-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libxau6@1:1.0.9-1?arch=amd64\u0026upstream=libxau\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libxau6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libxau6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "42" }, { "name": "syft:metadata:source", "value": "libxau" } ] }, { "bom-ref": "pkg:deb/debian/libxcb1@1.14-3?arch=amd64\u0026upstream=libxcb\u0026distro=debian-11\u0026package-id=49dbf89d961347d7", "type": "library", "publisher": "Debian X Strike Force \u003cdebian-x@lists.debian.org\u003e", "name": "libxcb1", "version": "1.14-3", "cpe": "cpe:2.3:a:libxcb1:libxcb1:1.14-3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libxcb1@1.14-3?arch=amd64\u0026upstream=libxcb\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libxcb1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libxcb1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "296" }, { "name": "syft:metadata:source", "value": "libxcb" } ] }, { "bom-ref": "pkg:deb/debian/libxdmcp6@1:1.1.2-3?arch=amd64\u0026upstream=libxdmcp\u0026distro=debian-11\u0026package-id=1651698e63c5dd0a", "type": "library", "publisher": "Debian X Strike Force \u003cdebian-x@lists.debian.org\u003e", "name": "libxdmcp6", "version": "1:1.1.2-3", "cpe": "cpe:2.3:a:libxdmcp6:libxdmcp6:1\\:1.1.2-3:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libxdmcp6@1:1.1.2-3?arch=amd64\u0026upstream=libxdmcp\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libxdmcp6/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libxdmcp6:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "53" }, { "name": "syft:metadata:source", "value": "libxdmcp" } ] }, { "bom-ref": "pkg:deb/debian/libxml2@2.9.10+dfsg-6.7+deb11u4?arch=amd64\u0026distro=debian-11\u0026package-id=fd71937c2b115b8e", "type": "library", "publisher": "Debian XML/SGML Group \u003cdebian-xml-sgml-pkgs@lists.alioth.debian.org\u003e", "name": "libxml2", "version": "2.9.10+dfsg-6.7+deb11u4", "licenses": [ { "license": { "id": "ISC" } } ], "cpe": "cpe:2.3:a:libxml2:libxml2:2.9.10\\+dfsg-6.7\\+deb11u4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libxml2@2.9.10+dfsg-6.7+deb11u4?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libxml2/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libxml2:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1876" } ] }, { "bom-ref": "pkg:deb/debian/libxpm4@1:3.5.12-1.1~deb11u1?arch=amd64\u0026upstream=libxpm\u0026distro=debian-11\u0026package-id=363ccc0923fbafc0", "type": "library", "publisher": "Debian X Strike Force \u003cdebian-x@lists.debian.org\u003e", "name": "libxpm4", "version": "1:3.5.12-1.1~deb11u1", "cpe": "cpe:2.3:a:libxpm4:libxpm4:1\\:3.5.12-1.1\\~deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libxpm4@1:3.5.12-1.1~deb11u1?arch=amd64\u0026upstream=libxpm\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libxpm4/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libxpm4:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "109" }, { "name": "syft:metadata:source", "value": "libxpm" } ] }, { "bom-ref": "pkg:deb/debian/libxslt1.1@1.1.34-4+deb11u1?arch=amd64\u0026upstream=libxslt\u0026distro=debian-11\u0026package-id=c2029cfb402a358", "type": "library", "publisher": "Debian XML/SGML Group \u003cdebian-xml-sgml-pkgs@lists.alioth.debian.org\u003e", "name": "libxslt1.1", "version": "1.1.34-4+deb11u1", "cpe": "cpe:2.3:a:libxslt1.1:libxslt1.1:1.1.34-4\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libxslt1.1@1.1.34-4+deb11u1?arch=amd64\u0026upstream=libxslt\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libxslt1.1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libxslt1.1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "502" }, { "name": "syft:metadata:source", "value": "libxslt" } ] }, { "bom-ref": "pkg:deb/debian/libxxhash0@0.8.0-2?arch=amd64\u0026upstream=xxhash\u0026distro=debian-11\u0026package-id=5dbfd774c60b62b7", "type": "library", "publisher": "Norbert Preining \u003cnorbert@preining.info\u003e", "name": "libxxhash0", "version": "0.8.0-2", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:libxxhash0:libxxhash0:0.8.0-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libxxhash0@0.8.0-2?arch=amd64\u0026upstream=xxhash\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libxxhash0/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libxxhash0:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "114" }, { "name": "syft:metadata:source", "value": "xxhash" } ] }, { "bom-ref": "pkg:deb/debian/libzstd1@1.4.8+dfsg-2.1?arch=amd64\u0026upstream=libzstd\u0026distro=debian-11\u0026package-id=ebcdac604e89e227", "type": "library", "publisher": "Debian Med Packaging Team \u003cdebian-med-packaging@lists.alioth.debian.org\u003e", "name": "libzstd1", "version": "1.4.8+dfsg-2.1", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "Zlib" } } ], "cpe": "cpe:2.3:a:libzstd1:libzstd1:1.4.8\\+dfsg-2.1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/libzstd1@1.4.8+dfsg-2.1?arch=amd64\u0026upstream=libzstd\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/libzstd1/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/libzstd1:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "904" }, { "name": "syft:metadata:source", "value": "libzstd" } ] }, { "bom-ref": "pkg:deb/debian/login@1:4.8.1-1?arch=amd64\u0026upstream=shadow\u0026distro=debian-11\u0026package-id=b6673a35736c938f", "type": "library", "publisher": "Shadow package maintainers \u003cpkg-shadow-devel@lists.alioth.debian.org\u003e", "name": "login", "version": "1:4.8.1-1", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:login:login:1\\:4.8.1-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/login@1:4.8.1-1?arch=amd64\u0026upstream=shadow\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/login/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/login.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/login.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "2335" }, { "name": "syft:metadata:source", "value": "shadow" } ] }, { "bom-ref": "pkg:deb/debian/logsave@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11\u0026package-id=785d3365eb8d1fd1", "type": "library", "publisher": "Theodore Y. Ts'o \u003ctytso@mit.edu\u003e", "name": "logsave", "version": "1.46.2-2", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "LGPL-2.0" } } ], "cpe": "cpe:2.3:a:logsave:logsave:1.46.2-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/logsave@1.46.2-2?arch=amd64\u0026upstream=e2fsprogs\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/logsave/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/logsave.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "93" }, { "name": "syft:metadata:source", "value": "e2fsprogs" } ] }, { "bom-ref": "pkg:deb/debian/lsb-base@11.1.0?arch=all\u0026upstream=lsb\u0026distro=debian-11\u0026package-id=df87d50c1cf551b9", "type": "library", "publisher": "Debian sysvinit maintainers \u003cdebian-init-diversity@chiark.greenend.org.uk\u003e", "name": "lsb-base", "version": "11.1.0", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:lsb-base:lsb-base:11.1.0:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/lsb-base@11.1.0?arch=all\u0026upstream=lsb\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:lsb-base:lsb_base:11.1.0:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:lsb_base:lsb-base:11.1.0:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:lsb_base:lsb_base:11.1.0:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:lsb:lsb-base:11.1.0:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:lsb:lsb_base:11.1.0:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/lsb-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/lsb-base.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "49" }, { "name": "syft:metadata:source", "value": "lsb" } ] }, { "bom-ref": "pkg:deb/debian/mawk@1.3.4.20200120-2?arch=amd64\u0026distro=debian-11\u0026package-id=86913dec0f0c000d", "type": "library", "publisher": "Boyuan Yang \u003cbyang@debian.org\u003e", "name": "mawk", "version": "1.3.4.20200120-2", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:mawk:mawk:1.3.4.20200120-2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/mawk@1.3.4.20200120-2?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/mawk/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/mawk.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "242" } ] }, { "bom-ref": "pkg:deb/debian/mount@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11\u0026package-id=16d02d85542621d3", "type": "library", "publisher": "util-linux packagers \u003cutil-linux@packages.debian.org\u003e", "name": "mount", "version": "2.36.1-8+deb11u1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:mount:mount:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/mount@2.36.1-8+deb11u1?arch=amd64\u0026upstream=util-linux\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/mount/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/mount.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "438" }, { "name": "syft:metadata:source", "value": "util-linux" } ] }, { "bom-ref": "pkg:deb/debian/ncurses-base@6.2+20201114-2+deb11u1?arch=all\u0026upstream=ncurses\u0026distro=debian-11\u0026package-id=c2bed0a7ce6a4f13", "type": "library", "publisher": "Craig Small \u003ccsmall@debian.org\u003e", "name": "ncurses-base", "version": "6.2+20201114-2+deb11u1", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "X11" } } ], "cpe": "cpe:2.3:a:ncurses-base:ncurses-base:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/ncurses-base@6.2+20201114-2+deb11u1?arch=all\u0026upstream=ncurses\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses-base:ncurses_base:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses_base:ncurses-base:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses_base:ncurses_base:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses:ncurses-base:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses:ncurses_base:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/ncurses-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/ncurses-base.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/ncurses-base.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "386" }, { "name": "syft:metadata:source", "value": "ncurses" } ] }, { "bom-ref": "pkg:deb/debian/ncurses-bin@6.2+20201114-2+deb11u1?arch=amd64\u0026upstream=ncurses\u0026distro=debian-11\u0026package-id=d291ad69a1420303", "type": "library", "publisher": "Craig Small \u003ccsmall@debian.org\u003e", "name": "ncurses-bin", "version": "6.2+20201114-2+deb11u1", "licenses": [ { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "X11" } } ], "cpe": "cpe:2.3:a:ncurses-bin:ncurses-bin:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/ncurses-bin@6.2+20201114-2+deb11u1?arch=amd64\u0026upstream=ncurses\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses-bin:ncurses_bin:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses_bin:ncurses-bin:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses_bin:ncurses_bin:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses:ncurses-bin:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:ncurses:ncurses_bin:6.2\\+20201114-2\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/ncurses-bin/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/ncurses-bin.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "646" }, { "name": "syft:metadata:source", "value": "ncurses" } ] }, { "bom-ref": "pkg:deb/debian/nginx@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11\u0026package-id=78d79c2dca21c964", "type": "library", "publisher": "NGINX Packaging \u003cnginx-packaging@f5.com\u003e", "name": "nginx", "version": "1.23.4-1~bullseye", "cpe": "cpe:2.3:a:nginx:nginx:1.23.4-1\\~bullseye:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/nginx@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/nginx/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/nginx.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/nginx.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "3082" } ] }, { "bom-ref": "pkg:deb/debian/nginx-module-geoip@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11\u0026package-id=cfe96d5da997b16d", "type": "library", "publisher": "NGINX Packaging \u003cnginx-packaging@f5.com\u003e", "name": "nginx-module-geoip", "version": "1.23.4-1~bullseye", "cpe": "cpe:2.3:a:nginx-module-geoip:nginx-module-geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/nginx-module-geoip@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module-geoip:nginx_module_geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_geoip:nginx-module-geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_geoip:nginx_module_geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx-module-geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx_module_geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx-module-geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx_module_geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx-module-geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx_module_geoip:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/nginx-module-geoip/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/nginx-module-geoip.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "162" } ] }, { "bom-ref": "pkg:deb/debian/nginx-module-image-filter@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11\u0026package-id=dfe3971f1d005d39", "type": "library", "publisher": "NGINX Packaging \u003cnginx-packaging@f5.com\u003e", "name": "nginx-module-image-filter", "version": "1.23.4-1~bullseye", "cpe": "cpe:2.3:a:nginx-module-image-filter:nginx-module-image-filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/nginx-module-image-filter@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module-image-filter:nginx_module_image_filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_image_filter:nginx-module-image-filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_image_filter:nginx_module_image_filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module-image:nginx-module-image-filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module-image:nginx_module_image_filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_image:nginx-module-image-filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_image:nginx_module_image_filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx-module-image-filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx_module_image_filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx-module-image-filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx_module_image_filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx-module-image-filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx_module_image_filter:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/nginx-module-image-filter/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/nginx-module-image-filter.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "136" } ] }, { "bom-ref": "pkg:deb/debian/nginx-module-njs@1.23.4+0.7.11-1~bullseye?arch=amd64\u0026distro=debian-11\u0026package-id=9d04ac4d6bac916d", "type": "library", "publisher": "NGINX Packaging \u003cnginx-packaging@f5.com\u003e", "name": "nginx-module-njs", "version": "1.23.4+0.7.11-1~bullseye", "cpe": "cpe:2.3:a:nginx-module-njs:nginx-module-njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/nginx-module-njs@1.23.4+0.7.11-1~bullseye?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module-njs:nginx_module_njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_njs:nginx-module-njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_njs:nginx_module_njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx-module-njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx_module_njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx-module-njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx_module_njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx-module-njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx_module_njs:1.23.4\\+0.7.11-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/nginx-module-njs/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/nginx-module-njs.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "4738" } ] }, { "bom-ref": "pkg:deb/debian/nginx-module-xslt@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11\u0026package-id=9ebbfd9adbd25b3b", "type": "library", "publisher": "NGINX Packaging \u003cnginx-packaging@f5.com\u003e", "name": "nginx-module-xslt", "version": "1.23.4-1~bullseye", "cpe": "cpe:2.3:a:nginx-module-xslt:nginx-module-xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/nginx-module-xslt@1.23.4-1~bullseye?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module-xslt:nginx_module_xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_xslt:nginx-module-xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module_xslt:nginx_module_xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx-module-xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx-module:nginx_module_xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx-module-xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx_module:nginx_module_xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx-module-xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:nginx:nginx_module_xslt:1.23.4-1\\~bullseye:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/nginx-module-xslt/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/nginx-module-xslt.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "128" } ] }, { "bom-ref": "pkg:deb/debian/openssl@1.1.1n-0+deb11u4?arch=amd64\u0026distro=debian-11\u0026package-id=b4a6dec3598d93f7", "type": "library", "publisher": "Debian OpenSSL Team \u003cpkg-openssl-devel@lists.alioth.debian.org\u003e", "name": "openssl", "version": "1.1.1n-0+deb11u4", "cpe": "cpe:2.3:a:openssl:openssl:1.1.1n-0\\+deb11u4:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/openssl@1.1.1n-0+deb11u4?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/openssl/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/openssl.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/openssl.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "1466" } ] }, { "bom-ref": "pkg:deb/debian/passwd@1:4.8.1-1?arch=amd64\u0026upstream=shadow\u0026distro=debian-11\u0026package-id=c0f87faa100a3ce7", "type": "library", "publisher": "Shadow package maintainers \u003cpkg-shadow-devel@lists.alioth.debian.org\u003e", "name": "passwd", "version": "1:4.8.1-1", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:passwd:passwd:1\\:4.8.1-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/passwd@1:4.8.1-1?arch=amd64\u0026upstream=shadow\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/passwd/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/passwd.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/passwd.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "2736" }, { "name": "syft:metadata:source", "value": "shadow" } ] }, { "bom-ref": "pkg:deb/debian/perl-base@5.32.1-4+deb11u2?arch=amd64\u0026upstream=perl\u0026distro=debian-11\u0026package-id=abcb5b1412cd9c08", "type": "library", "publisher": "Niko Tyni \u003cntyni@debian.org\u003e", "name": "perl-base", "version": "5.32.1-4+deb11u2", "licenses": [ { "license": { "id": "Artistic-2.0" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "GPL-1.0" } }, { "license": { "id": "GPL-1.0+" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "Zlib" } } ], "cpe": "cpe:2.3:a:perl-base:perl-base:5.32.1-4\\+deb11u2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/perl-base@5.32.1-4+deb11u2?arch=amd64\u0026upstream=perl\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:perl-base:perl_base:5.32.1-4\\+deb11u2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:perl_base:perl-base:5.32.1-4\\+deb11u2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:perl_base:perl_base:5.32.1-4\\+deb11u2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:perl:perl-base:5.32.1-4\\+deb11u2:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:perl:perl_base:5.32.1-4\\+deb11u2:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/perl-base/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/perl-base.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "7664" }, { "name": "syft:metadata:source", "value": "perl" } ] }, { "bom-ref": "pkg:deb/debian/readline-common@8.1-1?arch=all\u0026upstream=readline\u0026distro=debian-11\u0026package-id=1ac22947adacf3be", "type": "library", "publisher": "Matthias Klose \u003cdoko@debian.org\u003e", "name": "readline-common", "version": "8.1-1", "licenses": [ { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:readline-common:readline-common:8.1-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/readline-common@8.1-1?arch=all\u0026upstream=readline\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:readline-common:readline_common:8.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:readline_common:readline-common:8.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:readline_common:readline_common:8.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:readline:readline-common:8.1-1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:readline:readline_common:8.1-1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/readline-common/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/readline-common.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "92" }, { "name": "syft:metadata:source", "value": "readline" } ] }, { "bom-ref": "pkg:deb/debian/sed@4.7-1?arch=amd64\u0026distro=debian-11\u0026package-id=60af338a72e539c1", "type": "library", "publisher": "Clint Adams \u003cclint@debian.org\u003e", "name": "sed", "version": "4.7-1", "licenses": [ { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:sed:sed:4.7-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/sed@4.7-1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/sed/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/sed.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "883" } ] }, { "bom-ref": "pkg:deb/debian/sensible-utils@0.0.14?arch=all\u0026distro=debian-11\u0026package-id=ef4c689f97f3d29f", "type": "library", "publisher": "Anibal Monsalve Salazar \u003canibal@debian.org\u003e", "name": "sensible-utils", "version": "0.0.14", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } } ], "cpe": "cpe:2.3:a:sensible-utils:sensible-utils:0.0.14:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/sensible-utils@0.0.14?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sensible-utils:sensible_utils:0.0.14:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sensible_utils:sensible-utils:0.0.14:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sensible_utils:sensible_utils:0.0.14:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sensible:sensible-utils:0.0.14:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sensible:sensible_utils:0.0.14:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/sensible-utils/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/sensible-utils.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "44" } ] }, { "bom-ref": "pkg:deb/debian/sysvinit-utils@2.96-7+deb11u1?arch=amd64\u0026upstream=sysvinit\u0026distro=debian-11\u0026package-id=fe0ee7268a410c4a", "type": "library", "publisher": "Debian sysvinit maintainers \u003cdebian-init-diversity@chiark.greenend.org.uk\u003e", "name": "sysvinit-utils", "version": "2.96-7+deb11u1", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } } ], "cpe": "cpe:2.3:a:sysvinit-utils:sysvinit-utils:2.96-7\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/sysvinit-utils@2.96-7+deb11u1?arch=amd64\u0026upstream=sysvinit\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sysvinit-utils:sysvinit_utils:2.96-7\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sysvinit_utils:sysvinit-utils:2.96-7\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sysvinit_utils:sysvinit_utils:2.96-7\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sysvinit:sysvinit-utils:2.96-7\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:sysvinit:sysvinit_utils:2.96-7\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/sysvinit-utils/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/sysvinit-utils.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "79" }, { "name": "syft:metadata:source", "value": "sysvinit" } ] }, { "bom-ref": "pkg:deb/debian/tar@1.34+dfsg-1?arch=amd64\u0026distro=debian-11\u0026package-id=2c804797b124e34", "type": "library", "publisher": "Janos Lenart \u003cocsi@debian.org\u003e", "name": "tar", "version": "1.34+dfsg-1", "licenses": [ { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-3.0" } } ], "cpe": "cpe:2.3:a:tar:tar:1.34\\+dfsg-1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/tar@1.34+dfsg-1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/tar/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/tar.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "3152" } ] }, { "bom-ref": "pkg:deb/debian/tzdata@2021a-1+deb11u10?arch=all\u0026distro=debian-11\u0026package-id=dd56b9f0275df6b1", "type": "library", "publisher": "GNU Libc Maintainers \u003cdebian-glibc@lists.debian.org\u003e", "name": "tzdata", "version": "2021a-1+deb11u10", "cpe": "cpe:2.3:a:tzdata:tzdata:2021a-1\\+deb11u10:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/tzdata@2021a-1+deb11u10?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/tzdata/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/tzdata.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "3413" } ] }, { "bom-ref": "pkg:deb/debian/ucf@3.0043?arch=all\u0026distro=debian-11\u0026package-id=ae51a29db35a57ed", "type": "library", "publisher": "Manoj Srivastava \u003csrivasta@debian.org\u003e", "name": "ucf", "version": "3.0043", "licenses": [ { "license": { "id": "GPL-2.0" } } ], "cpe": "cpe:2.3:a:ucf:ucf:3.0043:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/ucf@3.0043?arch=all\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/ucf/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/ucf.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/ucf.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "232" } ] }, { "bom-ref": "pkg:deb/debian/util-linux@2.36.1-8+deb11u1?arch=amd64\u0026distro=debian-11\u0026package-id=ba5bb3d6ca7609c5", "type": "library", "publisher": "util-linux packagers \u003cutil-linux@packages.debian.org\u003e", "name": "util-linux", "version": "2.36.1-8+deb11u1", "licenses": [ { "license": { "id": "BSD-2-Clause" } }, { "license": { "id": "BSD-3-Clause" } }, { "license": { "id": "BSD-4-Clause" } }, { "license": { "id": "GPL-2.0" } }, { "license": { "id": "GPL-2.0+" } }, { "license": { "id": "GPL-3.0" } }, { "license": { "id": "GPL-3.0+" } }, { "license": { "id": "LGPL-2.0" } }, { "license": { "id": "LGPL-2.0+" } }, { "license": { "id": "LGPL-2.1" } }, { "license": { "id": "LGPL-2.1+" } }, { "license": { "id": "LGPL-3.0" } }, { "license": { "id": "LGPL-3.0+" } }, { "license": { "id": "MIT" } } ], "cpe": "cpe:2.3:a:util-linux:util-linux:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/util-linux@2.36.1-8+deb11u1?arch=amd64\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:util-linux:util_linux:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:util_linux:util-linux:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:util_linux:util_linux:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:util:util-linux:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:cpe23", "value": "cpe:2.3:a:util:util_linux:2.36.1-8\\+deb11u1:*:*:*:*:*:*:*" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/util-linux/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/util-linux.conffiles" }, { "name": "syft:location:2:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/info/util-linux.md5sums" }, { "name": "syft:location:3:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:3:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "4615" } ] }, { "bom-ref": "pkg:deb/debian/zlib1g@1:1.2.11.dfsg-2+deb11u2?arch=amd64\u0026upstream=zlib\u0026distro=debian-11\u0026package-id=960deeb414b4778b", "type": "library", "publisher": "Mark Brown \u003cbroonie@debian.org\u003e", "name": "zlib1g", "version": "1:1.2.11.dfsg-2+deb11u2", "licenses": [ { "license": { "id": "Zlib" } } ], "cpe": "cpe:2.3:a:zlib1g:zlib1g:1\\:1.2.11.dfsg-2\\+deb11u2:*:*:*:*:*:*:*", "purl": "pkg:deb/debian/zlib1g@1:1.2.11.dfsg-2+deb11u2?arch=amd64\u0026upstream=zlib\u0026distro=debian-11", "properties": [ { "name": "syft:package:foundBy", "value": "dpkgdb-cataloger" }, { "name": "syft:package:metadataType", "value": "DpkgMetadata" }, { "name": "syft:package:type", "value": "deb" }, { "name": "syft:location:0:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:0:path", "value": "/usr/share/doc/zlib1g/copyright" }, { "name": "syft:location:1:layerID", "value": "sha256:8553b91047dad45bedc292812586f1621e0a464a09a7a7c2ce6ac5f8ba2535d7" }, { "name": "syft:location:1:path", "value": "/var/lib/dpkg/info/zlib1g:amd64.md5sums" }, { "name": "syft:location:2:layerID", "value": "sha256:a29cc9587af6488ae0cbb962ecbe023d347908cc62ca5d715af06e54ccaa9e36" }, { "name": "syft:location:2:path", "value": "/var/lib/dpkg/status" }, { "name": "syft:metadata:installedSize", "value": "167" }, { "name": "syft:metadata:source", "value": "zlib" } ] }, { "type": "operating-system", "name": "debian", "version": "11", "description": "Debian GNU/Linux 11 (bullseye)", "swid": { "tagId": "debian", "name": "debian", "version": "11" }, "externalReferences": [ { "url": "https://bugs.debian.org/", "type": "issue-tracker" }, { "url": "https://www.debian.org/", "type": "website" }, { "url": "https://www.debian.org/support", "comment": "support", "type": "other" } ], "properties": [ { "name": "syft:distro:id", "value": "debian" }, { "name": "syft:distro:prettyName", "value": "Debian GNU/Linux 11 (bullseye)" }, { "name": "syft:distro:versionCodename", "value": "bullseye" }, { "name": "syft:distro:versionID", "value": "11" } ] } ] }