diff --git a/Makefile b/Makefile index 6859764..8fb1356 100644 --- a/Makefile +++ b/Makefile @@ -17,13 +17,17 @@ cover: 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/2023-04-28~experimental -o specs/snyk-experimental.json + @curl --silent https://api.snyk.io/rest/openapi/2023-04-28 -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 clients fmt +.PHONY: build test acceptance lint cover specs patch clients fmt diff --git a/README.md b/README.md index aae7146..bcc0c9a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ $ cat testing/sbom.cyclonedx.json "purl": "pkg:npm/subtext@6.0.12" } ... -$ cat testing/sbom.cyclonedx.json | parlay enrich - | jq +$ cat testing/sbom.cyclonedx.json | parlay e enrich - | jq ... { "bom-ref": "68-subtext@6.0.12", diff --git a/go.mod b/go.mod index 1be8f8b..c4202a9 100644 --- a/go.mod +++ b/go.mod @@ -5,6 +5,7 @@ go 1.20 require ( github.com/CycloneDX/cyclonedx-go v0.7.1 github.com/deepmap/oapi-codegen v1.12.4 + github.com/google/uuid v1.3.0 github.com/jarcoal/httpmock v1.3.0 github.com/package-url/packageurl-go v0.1.0 github.com/remeh/sizedwaitgroup v1.0.0 @@ -15,7 +16,6 @@ require ( require ( github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect github.com/davecgh/go-spew v1.1.1 // indirect - github.com/google/uuid v1.3.0 // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/spf13/pflag v1.0.5 // indirect diff --git a/internal/commands/default.go b/internal/commands/default.go index 4c43186..1cc1c82 100644 --- a/internal/commands/default.go +++ b/internal/commands/default.go @@ -1,29 +1,26 @@ package commands import ( - "log" - "os" - "github.com/snyk/parlay/internal/commands/ecosystems" + "github.com/snyk/parlay/internal/commands/snyk" "github.com/spf13/cobra" ) func NewDefaultCommand() *cobra.Command { cmd := cobra.Command{ - Use: "parlay", - Short: "", - Long: ``, - SilenceUsage: true, + Use: "parlay", + Short: "", + Long: ``, + SilenceUsage: true, + DisableFlagsInUseLine: true, Run: func(cmd *cobra.Command, args []string) { _ = cmd.Help() }, } - logger := log.New(os.Stdout, "", log.LstdFlags) - - cmd.AddCommand(NewEnrichCommand(logger)) cmd.AddCommand(ecosystems.NewEcosystemsRootCommand()) + cmd.AddCommand(snyk.NewSnykRootCommand()) return &cmd } diff --git a/internal/commands/enrich.go b/internal/commands/ecosystems/enrich.go similarity index 98% rename from internal/commands/enrich.go rename to internal/commands/ecosystems/enrich.go index a7c777a..f35e0e7 100644 --- a/internal/commands/enrich.go +++ b/internal/commands/ecosystems/enrich.go @@ -1,4 +1,4 @@ -package commands +package ecosystems import ( "bufio" diff --git a/internal/commands/ecosystems/root.go b/internal/commands/ecosystems/root.go index 6bfd591..2ddbdda 100644 --- a/internal/commands/ecosystems/root.go +++ b/internal/commands/ecosystems/root.go @@ -1,21 +1,29 @@ package ecosystems import ( + "log" + "os" + "github.com/spf13/cobra" ) func NewEcosystemsRootCommand() *cobra.Command { cmd := cobra.Command{ - Use: "ecosystems", - Short: "", - Long: ``, - SilenceUsage: true, + Use: "ecosystems", + Short: "", + Long: ``, + Aliases: []string{"e"}, + DisableFlagsInUseLine: true, + SilenceUsage: true, Run: func(cmd *cobra.Command, args []string) { _ = cmd.Help() }, } + logger := log.New(os.Stdout, "", log.LstdFlags) + cmd.AddCommand(NewPackageCommand()) cmd.AddCommand(NewRepoCommand()) + cmd.AddCommand(NewEnrichCommand(logger)) return &cmd } diff --git a/internal/commands/snyk/packages.go b/internal/commands/snyk/packages.go new file mode 100644 index 0000000..f223efb --- /dev/null +++ b/internal/commands/snyk/packages.go @@ -0,0 +1,31 @@ +package snyk + +import ( + "fmt" + "log" + + "github.com/snyk/parlay/lib" + + "github.com/package-url/packageurl-go" + "github.com/spf13/cobra" +) + +func NewPackageCommand() *cobra.Command { + cmd := cobra.Command{ + Use: "package ", + Short: "Return package vulnerabilities from Snyk", + Args: cobra.ExactArgs(1), + Run: func(cmd *cobra.Command, args []string) { + purl, err := packageurl.FromString(args[0]) + if err != nil { + log.Fatal(err) + } + resp, err := lib.GetPackageVulnerabilities(purl) + if err != nil { + log.Fatal(err) + } + fmt.Print(string(resp.Body)) + }, + } + return &cmd +} diff --git a/internal/commands/snyk/root.go b/internal/commands/snyk/root.go new file mode 100644 index 0000000..9a555b2 --- /dev/null +++ b/internal/commands/snyk/root.go @@ -0,0 +1,20 @@ +package snyk + +import ( + "github.com/spf13/cobra" +) + +func NewSnykRootCommand() *cobra.Command { + cmd := cobra.Command{ + Use: "snyk", + Short: "", + Long: ``, + SilenceUsage: true, + Run: func(cmd *cobra.Command, args []string) { + _ = cmd.Help() + }, + } + cmd.AddCommand(NewPackageCommand()) + + return &cmd +} diff --git a/lib/package.go b/lib/package.go index 2fc8c58..a0a8b2d 100644 --- a/lib/package.go +++ b/lib/package.go @@ -2,15 +2,51 @@ package lib import ( "context" + "errors" "fmt" "net/url" + "os" "github.com/snyk/parlay/ecosystems/packages" + "github.com/snyk/parlay/snyk/issues" + "github.com/deepmap/oapi-codegen/pkg/securityprovider" "github.com/package-url/packageurl-go" ) const server = "https://packages.ecosyste.ms/api/v1" +const snykServer = "https://api.snyk.io/rest" +const version = "2023-04-28" + +func GetPackageVulnerabilities(purl packageurl.PackageURL) (*issues.FetchIssuesPerPurlResponse, error) { + token := os.Getenv("SNYK_TOKEN") + 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 + } + + org, err := getSnykOrg(auth) + if err != nil { + return nil, err + } + + client, err := issues.NewClientWithResponses(snykServer, issues.WithRequestEditorFn(auth.Intercept)) + if err != nil { + return nil, err + } + + params := issues.FetchIssuesPerPurlParams{Version: version} + resp, err := client.FetchIssuesPerPurlWithResponse(context.Background(), *org, purl.ToString(), ¶ms) + if err != nil { + return nil, err + } + + return resp, nil +} func GetPackageData(purl packageurl.PackageURL) (*packages.GetRegistryPackageResponse, error) { client, err := packages.NewClientWithResponses(server) diff --git a/lib/self.go b/lib/self.go new file mode 100644 index 0000000..4f37af3 --- /dev/null +++ b/lib/self.go @@ -0,0 +1,53 @@ +package lib + +import ( + "context" + "encoding/json" + + "github.com/snyk/parlay/snyk/users" + + "github.com/deepmap/oapi-codegen/pkg/securityprovider" + "github.com/google/uuid" +) + +const experimentalVersion = "2023-04-28~experimental" + +type selfDocument struct { + Data struct { + Attributes struct { + AvatarURL string `json:"avatar_url,omitempty"` + DefaultOrgContext string `json:"default_org_context,omitempty"` + Name string `json:"name,omitempty"` + Username string `json:"username,omitempty"` + } `json:"attributes,omitempty"` + ID string `json:"id,omitempty"` + Type string `json:"type,omitempty"` + } + Jsonapi interface{} `json:"jsonapi,omitempty"` + Links interface{} `json:"links,omitempty"` +} + +func getSnykOrg(auth *securityprovider.SecurityProviderApiKey) (*uuid.UUID, error) { + experimental, err := users.NewClientWithResponses(snykServer, users.WithRequestEditorFn(auth.Intercept)) + if err != nil { + return nil, err + } + + userParams := users.GetSelfParams{Version: experimentalVersion} + self, err := experimental.GetSelfWithResponse(context.Background(), &userParams) + if err != nil { + return nil, err + } + + var userInfo selfDocument + if err = json.Unmarshal(self.Body, &userInfo); err != nil { + return nil, err + } + + orgId := userInfo.Data.Attributes.DefaultOrgContext + org, err := uuid.Parse(orgId) + if err != nil { + return nil, err + } + return &org, nil +} diff --git a/snyk/issues/issues.go b/snyk/issues/issues.go new file mode 100644 index 0000000..242c665 --- /dev/null +++ b/snyk/issues/issues.go @@ -0,0 +1,925 @@ +// Package issues provides primitives to interact with the openapi HTTP API. +// +// Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT. +package issues + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "net/url" + "strings" + "time" + + "github.com/deepmap/oapi-codegen/pkg/runtime" + openapi_types "github.com/deepmap/oapi-codegen/pkg/types" +) + +const ( + APITokenScopes = "APIToken.Scopes" + BearerAuthScopes = "BearerAuth.Scopes" +) + +// Defines values for CommonIssueModelAttributesEffectiveSeverityLevel. +const ( + CommonIssueModelAttributesEffectiveSeverityLevelCritical CommonIssueModelAttributesEffectiveSeverityLevel = "critical" + CommonIssueModelAttributesEffectiveSeverityLevelHigh CommonIssueModelAttributesEffectiveSeverityLevel = "high" + CommonIssueModelAttributesEffectiveSeverityLevelInfo CommonIssueModelAttributesEffectiveSeverityLevel = "info" + CommonIssueModelAttributesEffectiveSeverityLevelLow CommonIssueModelAttributesEffectiveSeverityLevel = "low" + CommonIssueModelAttributesEffectiveSeverityLevelMedium CommonIssueModelAttributesEffectiveSeverityLevel = "medium" +) + +// Defines values for CommonIssueModelVTwoAttributesEffectiveSeverityLevel. +const ( + CommonIssueModelVTwoAttributesEffectiveSeverityLevelCritical CommonIssueModelVTwoAttributesEffectiveSeverityLevel = "critical" + CommonIssueModelVTwoAttributesEffectiveSeverityLevelHigh CommonIssueModelVTwoAttributesEffectiveSeverityLevel = "high" + CommonIssueModelVTwoAttributesEffectiveSeverityLevelInfo CommonIssueModelVTwoAttributesEffectiveSeverityLevel = "info" + CommonIssueModelVTwoAttributesEffectiveSeverityLevelLow CommonIssueModelVTwoAttributesEffectiveSeverityLevel = "low" + CommonIssueModelVTwoAttributesEffectiveSeverityLevelMedium CommonIssueModelVTwoAttributesEffectiveSeverityLevel = "medium" +) + +// 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, hex, maven, npm, nuget, 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"` +} + +// CommonIssueModel defines model for CommonIssueModel. +type CommonIssueModel 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 *CommonIssueModelAttributesEffectiveSeverityLevel `json:"effective_severity_level,omitempty"` + + // Key The Snyk vulnerability ID. + Key *string `json:"key,omitempty"` + Problems *[]Problem `json:"problems,omitempty"` + + // Severities The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’. + Severities *[]Severity `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"` +} + +// CommonIssueModelAttributesEffectiveSeverityLevel 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 CommonIssueModelAttributesEffectiveSeverityLevel string + +// CommonIssueModelVTwo defines model for CommonIssueModelVTwo. +type CommonIssueModelVTwo struct { + Attributes *struct { + Coordinates *[]CoordinateVTwo `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 *CommonIssueModelVTwoAttributesEffectiveSeverityLevel `json:"effective_severity_level,omitempty"` + Problems *[]Problem `json:"problems,omitempty"` + + // Severities The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’. + Severities *[]Severity `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"` +} + +// CommonIssueModelVTwoAttributesEffectiveSeverityLevel 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 CommonIssueModelVTwoAttributesEffectiveSeverityLevel string + +// Coordinate defines model for Coordinate. +type Coordinate struct { + Remedies *[]Remedy `json:"remedies,omitempty"` + + // Representation The affected versions of this vulnerability. + Representation *[]string `json:"representation,omitempty"` +} + +// CoordinateVTwo defines model for CoordinateVTwo. +type CoordinateVTwo struct { + Remedies *[]Remedy `json:"remedies,omitempty"` + + // Representations The affected versions of this vulnerability. + Representations []CoordinateVTwo_Representations_Item `json:"representations"` +} + +// CoordinateVTwo_Representations_Item defines model for CoordinateVTwo.representations.Item. +type CoordinateVTwo_Representations_Item struct { + union json.RawMessage +} + +// 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"` +} + +// IssuesMeta defines model for IssuesMeta. +type IssuesMeta struct { + Package *PackageMeta `json:"package,omitempty"` +} + +// IssuesResponse defines model for IssuesResponse. +type IssuesResponse struct { + Data *[]CommonIssueModel `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 *[]CommonIssueModelVTwo `json:"data,omitempty"` + Jsonapi *JsonApi `json:"jsonapi,omitempty"` + Links *PaginatedLinks `json:"links,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"` +} + +// Meta Free-form object that may contain non-standard information. +type Meta map[string]interface{} + +// 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"` + + // 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"` +} + +// QueryVersion Requested API version +type QueryVersion = string + +// Remedy defines model for Remedy. +type Remedy 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"` +} + +// 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"` +} + +// Severity defines model for Severity. +type Severity struct { + Level *string `json:"level,omitempty"` + + // Score The CVSSv3 value of the vulnerability. + 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"` + + // Vector The CVSSv3 value of the vulnerability. + Vector *string `json:"vector"` +} + +// Slots defines model for Slots. +type Slots struct { + // DisclosureTime The time at which this vulnerability was disclosed. + DisclosureTime *time.Time `json:"disclosure_time,omitempty"` + + // Exploit The exploit maturity. Value of ‘No Data’, ‘Not Defined’, ‘Unproven’, ‘Proof of Concept’, ‘Functional’ or ‘High’. + Exploit *string `json:"exploit,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"` +} + +// Types defines model for Types. +type Types = string + +// OrgId defines model for OrgId. +type OrgId = openapi_types.UUID + +// PackageUrl defines model for PackageUrl. +type PackageUrl = string + +// Version Requested API version +type Version = QueryVersion + +// 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"` +} + +// ListIssuesForManyPurlsJSONRequestBody defines body for ListIssuesForManyPurls for application/vnd.api+json ContentType. +type ListIssuesForManyPurlsJSONRequestBody = BulkPackageUrlsRequestBody + +// AsResourcePathRepresentation returns the union data inside the CoordinateVTwo_Representations_Item as a ResourcePathRepresentation +func (t CoordinateVTwo_Representations_Item) AsResourcePathRepresentation() (ResourcePathRepresentation, error) { + var body ResourcePathRepresentation + err := json.Unmarshal(t.union, &body) + return body, err +} + +// FromResourcePathRepresentation overwrites any union data inside the CoordinateVTwo_Representations_Item as the provided ResourcePathRepresentation +func (t *CoordinateVTwo_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 CoordinateVTwo_Representations_Item, using the provided ResourcePathRepresentation +func (t *CoordinateVTwo_Representations_Item) MergeResourcePathRepresentation(v ResourcePathRepresentation) error { + b, err := json.Marshal(v) + if err != nil { + return err + } + + merged, err := runtime.JsonMerge(b, t.union) + t.union = merged + return err +} + +// AsPackageRepresentation returns the union data inside the CoordinateVTwo_Representations_Item as a PackageRepresentation +func (t CoordinateVTwo_Representations_Item) AsPackageRepresentation() (PackageRepresentation, error) { + var body PackageRepresentation + err := json.Unmarshal(t.union, &body) + return body, err +} + +// FromPackageRepresentation overwrites any union data inside the CoordinateVTwo_Representations_Item as the provided PackageRepresentation +func (t *CoordinateVTwo_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 CoordinateVTwo_Representations_Item, using the provided PackageRepresentation +func (t *CoordinateVTwo_Representations_Item) MergePackageRepresentation(v PackageRepresentation) error { + b, err := json.Marshal(v) + if err != nil { + return err + } + + merged, err := runtime.JsonMerge(b, t.union) + t.union = merged + return err +} + +func (t CoordinateVTwo_Representations_Item) MarshalJSON() ([]byte, error) { + b, err := t.union.MarshalJSON() + return b, err +} + +func (t *CoordinateVTwo_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(b, t.union) + 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(b, t.union) + 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 +} + +// 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 { + // ListIssuesForManyPurls request with any body + ListIssuesForManyPurlsWithBody(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) + + ListIssuesForManyPurls(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsJSONRequestBody, 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) 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) ListIssuesForManyPurls(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) { + req, err := NewListIssuesForManyPurlsRequest(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) +} + +// NewListIssuesForManyPurlsRequest calls the generic ListIssuesForManyPurls builder with application/vnd.api+json body +func NewListIssuesForManyPurlsRequest(server string, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsJSONRequestBody) (*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 + } + + 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 + } + + 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 { + // ListIssuesForManyPurls request with any body + ListIssuesForManyPurlsWithBodyWithResponse(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ListIssuesForManyPurlsResponse, error) + + ListIssuesForManyPurlsWithResponse(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsJSONRequestBody, reqEditors ...RequestEditorFn) (*ListIssuesForManyPurlsResponse, error) + + // FetchIssuesPerPurl request + FetchIssuesPerPurlWithResponse(ctx context.Context, orgId OrgId, purl PackageUrl, params *FetchIssuesPerPurlParams, reqEditors ...RequestEditorFn) (*FetchIssuesPerPurlResponse, error) +} + +type ListIssuesForManyPurlsResponse struct { + Body []byte + HTTPResponse *http.Response +} + +// 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 +} + +// 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 +} + +// 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) ListIssuesForManyPurlsWithResponse(ctx context.Context, orgId OrgId, params *ListIssuesForManyPurlsParams, body ListIssuesForManyPurlsJSONRequestBody, reqEditors ...RequestEditorFn) (*ListIssuesForManyPurlsResponse, error) { + rsp, err := c.ListIssuesForManyPurls(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) +} + +// 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, + } + + 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, + } + + return response, nil +} diff --git a/snyk/users/users.go b/snyk/users/users.go new file mode 100644 index 0000000..93ac2b9 --- /dev/null +++ b/snyk/users/users.go @@ -0,0 +1,1063 @@ +// Package users provides primitives to interact with the openapi HTTP API. +// +// Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT. +package users + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "net/url" + "strings" + + "github.com/deepmap/oapi-codegen/pkg/runtime" + openapi_types "github.com/deepmap/oapi-codegen/pkg/types" +) + +const ( + APITokenScopes = "APIToken.Scopes" + BearerAuthScopes = "BearerAuth.Scopes" +) + +// Defines values for PrincipalType. +const ( + PrincipalTypeAppInstance PrincipalType = "app_instance" + PrincipalTypeServiceAccount PrincipalType = "service_account" + PrincipalTypeUser PrincipalType = "user" +) + +// 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{} + +// Principal defines model for Principal. +type Principal struct { + Attributes Principal_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 PrincipalType `json:"type"` +} + +// PrincipalAttributes0 defines model for . +type PrincipalAttributes0 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"` +} + +// Principal_Attributes defines model for Principal.Attributes. +type Principal_Attributes struct { + union json.RawMessage +} + +// PrincipalType Content type. +type PrincipalType string + +// QueryVersion Requested API version +type QueryVersion = string + +// ServiceAccount defines model for ServiceAccount. +type ServiceAccount 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 { + // 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"` +} + +// 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 + +// UpdateUserJSONBody defines parameters for UpdateUser. +type UpdateUserJSONBody struct { + Data *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"` + } `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"` +} + +// UpdateUserJSONRequestBody defines body for UpdateUser for application/vnd.api+json ContentType. +type UpdateUserJSONRequestBody UpdateUserJSONBody + +// 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(b, t.union) + 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(b, t.union) + 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 +} + +// AsPrincipalAttributes0 returns the union data inside the Principal_Attributes as a PrincipalAttributes0 +func (t Principal_Attributes) AsPrincipalAttributes0() (PrincipalAttributes0, error) { + var body PrincipalAttributes0 + err := json.Unmarshal(t.union, &body) + return body, err +} + +// FromPrincipalAttributes0 overwrites any union data inside the Principal_Attributes as the provided PrincipalAttributes0 +func (t *Principal_Attributes) FromPrincipalAttributes0(v PrincipalAttributes0) error { + b, err := json.Marshal(v) + t.union = b + return err +} + +// MergePrincipalAttributes0 performs a merge with any union data inside the Principal_Attributes, using the provided PrincipalAttributes0 +func (t *Principal_Attributes) MergePrincipalAttributes0(v PrincipalAttributes0) error { + b, err := json.Marshal(v) + if err != nil { + return err + } + + merged, err := runtime.JsonMerge(b, t.union) + t.union = merged + return err +} + +// AsServiceAccount returns the union data inside the Principal_Attributes as a ServiceAccount +func (t Principal_Attributes) AsServiceAccount() (ServiceAccount, error) { + var body ServiceAccount + err := json.Unmarshal(t.union, &body) + return body, err +} + +// FromServiceAccount overwrites any union data inside the Principal_Attributes as the provided ServiceAccount +func (t *Principal_Attributes) FromServiceAccount(v ServiceAccount) error { + b, err := json.Marshal(v) + t.union = b + return err +} + +// MergeServiceAccount performs a merge with any union data inside the Principal_Attributes, using the provided ServiceAccount +func (t *Principal_Attributes) MergeServiceAccount(v ServiceAccount) error { + b, err := json.Marshal(v) + if err != nil { + return err + } + + merged, err := runtime.JsonMerge(b, t.union) + t.union = merged + return err +} + +// AsAppInstance returns the union data inside the Principal_Attributes as a AppInstance +func (t Principal_Attributes) AsAppInstance() (AppInstance, error) { + var body AppInstance + err := json.Unmarshal(t.union, &body) + return body, err +} + +// FromAppInstance overwrites any union data inside the Principal_Attributes as the provided AppInstance +func (t *Principal_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 Principal_Attributes, using the provided AppInstance +func (t *Principal_Attributes) MergeAppInstance(v AppInstance) error { + b, err := json.Marshal(v) + if err != nil { + return err + } + + merged, err := runtime.JsonMerge(b, t.union) + t.union = merged + return err +} + +func (t Principal_Attributes) MarshalJSON() ([]byte, error) { + b, err := t.union.MarshalJSON() + return b, err +} + +func (t *Principal_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(b, t.union) + 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 { + // UpdateUser 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) + + UpdateUser(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserJSONRequestBody, 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) UpdateUser(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) { + req, err := NewUpdateUserRequest(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) +} + +// NewUpdateUserRequest calls the generic UpdateUser builder with application/vnd.api+json body +func NewUpdateUserRequest(server string, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserJSONRequestBody) (*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 + } + + 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 + } + + 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 + } + + 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 + } + + 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 { + // UpdateUser 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) + + UpdateUserWithResponse(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error) + + // GetUser request + GetUserWithResponse(ctx context.Context, orgId openapi_types.UUID, id openapi_types.UUID, params *GetUserParams, reqEditors ...RequestEditorFn) (*GetUserResponse, error) + + // GetSelf request + GetSelfWithResponse(ctx context.Context, params *GetSelfParams, reqEditors ...RequestEditorFn) (*GetSelfResponse, error) + + // GetUserSettings request + GetUserSettingsWithResponse(ctx context.Context, params *GetUserSettingsParams, reqEditors ...RequestEditorFn) (*GetUserSettingsResponse, error) +} + +type UpdateUserResponse struct { + Body []byte + HTTPResponse *http.Response +} + +// 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 +} + +// 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 +} + +// 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 +} + +// 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) UpdateUserWithResponse(ctx context.Context, groupId openapi_types.UUID, id openapi_types.UUID, params *UpdateUserParams, body UpdateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error) { + rsp, err := c.UpdateUser(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, + } + + 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, + } + + 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, + } + + 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, + } + + return response, nil +} diff --git a/specs/snyk-experimental.json b/specs/snyk-experimental.json new file mode 100644 index 0000000..0abae10 --- /dev/null +++ b/specs/snyk-experimental.json @@ -0,0 +1 @@ +{"components":{"examples":{"CloudGetIgnoreResponse":{"summary":"An example of a Cloud ignore.","value":{"data":{"attributes":{"created":"2021-06-01T00:00:00Z","criteria":[{"parameter":"problems[*].id","type":"problem-id","value":"SNYK-CC-TF-123"},{"parameter":"coordinates[*].representations[*].cloudResource.environment.id","type":"coordinate-environment-id","value":"b50f2832-a901-565e-9e06-e4e59e8582b6"},{"parameter":"coordinates[*].representations[*].cloudResource.environment.name","type":"coordinate-environment-name","value":"Staging"},{"parameter":"coordinates[*].representations[*].cloudResource.environment.type","type":"coordinate-environment-type","value":"aws"},{"parameter":"coordinates[*].representations[*].cloudResource.resource.id","type":"coordinate-resource-id","value":"b50f2832-a901-565e-9e06-e4e59e8582b7"},{"parameter":"coordinates[*].representations[*].cloudResource.resource.type","type":"coordinate-resource-type","value":"cloud"},{"parameter":"coordinates[*].representations[*].cloudResource.resource.location","type":"coordinate-resource-location","value":"*"},{"parameter":"coordinates[*].representations[*].cloudResource.resource.tags","type":"coordinate-resource-tags","value":"[{\"State\": \"dev-*\"}]"}],"disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","issue_version":"2022-06-03","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","updated":"2021-06-01T00:00:00Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"ignored_by":{"data":{"id":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"user"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"ignore"},"jsonapi":{"version":"1.0"}}},"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":"synk-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"}}},"CodeGetIgnoreResponse":{"summary":"An example of a Code ignore.","value":{"data":{"attributes":{"created":"2021-06-01T00:00:00Z","criteria":[{"parameter":"problems[*].id","type":"problem-id","value":"npm:qs:20140806-1"},{"parameter":"coordinates[*].representations[*].value","type":"coordinate-resource-path","value":"*"}],"disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","issue_version":"2022-06-03","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","updated":"2021-06-01T00:00:00Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"ignored_by":{"data":{"id":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"user"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"ignore"},"jsonapi":{"version":"1.0"}}},"CodeListIssuesResponse":{"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"}}},"IaCGetIgnoreResponse":{"summary":"An example of an IaC ignore.","value":{"data":{"attributes":{"created":"2021-06-01T00:00:00Z","criteria":[{"parameter":"problems[*].id","type":"problem-id","value":"SNYK-CC-TF-123"},{"parameter":"coordinates[*].representations[*].value","type":"coordinate-resource-path","value":"resource.aws_s3_bucket[terra_ci].versioning.enabled"}],"disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","issue_version":"2022-06-03","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","updated":"2021-06-01T00:00:00Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"ignored_by":{"data":{"id":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"user"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"ignore"},"jsonapi":{"version":"1.0"}}},"IaCListIssuesResponse":{"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"}}},"IntegratedIaCGetIgnoreResponse":{"summary":"An example of an IaC integrated in Cloud ignore.","value":{"data":{"attributes":{"created":"2021-06-01T00:00:00Z","criteria":[{"parameter":"problems[*].id","type":"problem-id","value":"SNYK-CC-TF-123"},{"parameter":"coordinates[*].representations[*].file","type":"coordinate-source-location-file","value":"./terraform/aws_iam_account_public_role.tf"},{"parameter":"coordinates[*].representations[*].region.start.line","type":"coordinate-source-location-region","value":"92"}],"disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","issue_version":"2022-06-03","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","updated":"2021-06-01T00:00:00Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"ignored_by":{"data":{"id":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"user"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"ignore"},"jsonapi":{"version":"1.0"}}},"OpenSourceGetIgnoreResponse":{"summary":"An example of an OpenSource ignore.","value":{"data":{"attributes":{"created":"2021-06-01T00:00:00Z","criteria":[{"parameter":"key","type":"key","value":"da8360e8-6477-47ce-80df-b6247ebec1c8"}],"disregard_if_fixable":false,"expires":"2017-10-31T11:24:45.365Z","issue_version":"2022-06-03","reason":"Not vulnerable via this path","reason_type":"not-vulnerable","updated":"2021-06-01T00:00:00Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"ignored_by":{"data":{"id":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"user"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"ignore"},"jsonapi":{"version":"1.0"}}},"OpenSourceListIssuesResponse":{"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"}}},"SpecificOperationsCreateOneRequestBody":{"summary":"Selecting specific operations on projects","value":{"data":{"attributes":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":["created","deleted"]},"version":"2022-02-01~beta"},"type":"webhook"}}},"SpecificOperationsGetManyResponse":{"summary":"Selecting specific operations on projects","value":{"data":[{"attributes":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":["created","deleted"]},"version":"2022-02-01~beta"},"id":"6024d158-b88b-4122-9744-b661b8c1572e","type":"webhook"}],"jsonapi":{"version":"1.0"},"links":{"next":"/orgs/5c498276-be72-4c3c-9d76-ccc3c318c499/webhooks?starting_after=CURSOR\u0026limit=10\u0026version=2022-05-10~experimental","self":"/orgs/5c498276-be72-4c3c-9d76-ccc3c318c499/webhooks?version=2022-05-10~experimental"}}},"SpecificOperationsGetOrCreateOneResponse":{"summary":"Selecting specific operations on projects","value":{"attributes":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":["created","deleted"]},"version":"2022-02-01~beta"},"data":{"id":"6024d158-b88b-4122-9744-b661b8c1572e","type":"webhook"},"jsonapi":{"version":"1.0"},"links":{"self":"/orgs/5c498276-be72-4c3c-9d76-ccc3c318c499/webhooks/6024d158-b88b-4122-9744-b661b8c1572e?version=2022-05-10~experimental"}}},"WildcardCreateOneRequestBody":{"summary":"Selecting all events on projects with a wildcard","value":{"data":{"attributes":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":"*"},"version":"2022-02-01~beta"},"type":"webhook"}}},"WildcardGetManyResponse":{"summary":"Selecting all events on projects with a wildcard","value":{"data":[{"attributes":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":"*"},"version":"2022-02-01~beta"},"id":"6024d158-b88b-4122-9744-b661b8c1572e","type":"webhook"}],"jsonapi":{"version":"1.0"},"links":{"next":"/orgs/5c498276-be72-4c3c-9d76-ccc3c318c499/webhooks?starting_after=CURSOR\u0026limit=10\u0026version=2022-05-10~experimental","self":"/orgs/5c498276-be72-4c3c-9d76-ccc3c318c499/webhooks?version=2022-05-10~experimental"}}},"WildcardGetOrCreateOneResponse":{"summary":"Selecting all events on projects with a wildcard","value":{"data":{"attributes":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":"*"},"version":"2022-02-01~beta"},"id":"6024d158-b88b-4122-9744-b661b8c1572e","type":"webhook"},"jsonapi":{"version":"1.0"},"links":{"self":"/orgs/5c498276-be72-4c3c-9d76-ccc3c318c499/webhooks/6024d158-b88b-4122-9744-b661b8c1572e?version=2022-05-10~experimental"}}}},"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":{"description":"The location of the processing task","example":"/rest/orgs/2a70869c-7b32-4dfa-8605-199033c6db4c/depgraphs/1234567890","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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}},"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":{"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"}},"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"}},"CreatedAfter":{"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"}},"CreatedBefore":{"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"}},"CustomBaseImageId":{"description":"Unique identifier for custom base image","in":"path","name":"custombaseimage_id","required":true,"schema":{"format":"uuid","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":{"type":"string"},"style":"form"},"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"}},"GroupId":{"description":"Group ID","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"}},"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"}},"ImageId":{"description":"Image ID","in":"path","name":"image_id","required":true,"schema":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256:[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:[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"}},"IssueKey":{"description":"Describes the unique issue the ignore rule applies to.","in":"query","name":"issue_key","schema":{"example":"4c0d41cc-4e9d-5a72-8b63-590c476bdd0f","type":"string"}},"IssueProblemId":{"description":"The problems[*].id field in the CIM for the issue that the ignore rule applies to. This is used by all but Snyk Code","in":"query","name":"issue_problem_id","schema":{"example":"SNYK-CC-00181","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"},"Kind":{"description":"Filter resources by kind (multi-value, comma-separated): cloud","example":"cloud","explode":false,"in":"query","name":"kind","schema":{"type":"string"},"style":"form"},"KindInQuery":{"description":"Filter environments by kind (multi-value, comma-separated): aws","example":"aws","in":"query","name":"kind","schema":{"type":"string"}},"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"},"Name":{"description":"Filter resources by name (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"name","schema":{"type":"string"},"style":"form"},"NameInQuery":{"description":"Filter environments by name (multi-value, comma-separated)","example":"Demo AWS Environment","in":"query","name":"name","schema":{"type":"string"}},"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":"The organization ID of the custom base image","in":"query","name":"org_id","schema":{"format":"uuid","type":"string"}},"OrgRegistrationId":{"description":"Unique org registration identifier","in":"path","name":"org_registration_id","required":true,"schema":{"format":"uuid","type":"string"}},"PackageName":{"description":"Name of package","example":"fortivpn","in":"query","name":"package_name","required":true,"schema":{"type":"string"}},"PackageType":{"description":"Ecosystem that package belongs to","example":"generic","in":"query","name":"package_type","required":true,"schema":{"enum":["generic"],"type":"string"}},"PackageUrl":{"description":"A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, hex, maven, npm, nuget, 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":"Version of package","example":"1.0.0","in":"query","name":"package_version","required":true,"schema":{"pattern":"^[a-zA-Z0-9\\-\\_\\.\\+\\\\\\:\\~]+$","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"}},"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":"Filter resources by resource ID (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"resource_id","schema":{"type":"string"},"style":"form"},"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"},"ScanItemId":{"description":"Scan Item ID - can be either the project ID or the environment ID (for Snyk Cloud)","in":"query","name":"scan_item_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbee","format":"uuid","type":"string"}},"ScanItemType":{"description":"Scan Item Type","in":"query","name":"scan_item_type","required":true,"schema":{"$ref":"#/components/schemas/ScanItemType"}},"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"}},"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"}},"StatusInQuery":{"description":"Filter environments by latest scan status (multi-value, comma-separated): queued, in_progress, success, error","example":"error","in":"query","name":"status","schema":{"type":"string"}},"Tag":{"description":"The image tag","in":"query","name":"tag","schema":{"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"}},"Type":{"description":"An issue type to filter issues.","in":"query","name":"type","schema":{"$ref":"#/components/schemas/TypeDef"},"style":"form"},"UpdatedAfter":{"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"}},"UpdatedBefore":{"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"}},"UriEncode":{"description":"Flag to set if purl returned is encoded","example":true,"in":"query","name":"uri_encode","schema":{"type":"boolean"}},"UserId":{"description":"The ID of the User","in":"path","name":"user_id","required":true,"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"}},"WebhookId":{"description":"Unique identifier for webhook instances.","in":"path","name":"webhook_id","required":true,"schema":{"format":"uuid","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"}}},"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"}}},"CreateIgnore201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Ignore"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"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"}}},"GetIgnore200":{"content":{"application/vnd.api+json":{"examples":{"Cloud":{"$ref":"#/components/examples/CloudGetIgnoreResponse"},"Code":{"$ref":"#/components/examples/CodeGetIgnoreResponse"},"IaC":{"$ref":"#/components/examples/IaCGetIgnoreResponse"},"IntegratedIaC":{"$ref":"#/components/examples/IntegratedIaCGetIgnoreResponse"},"OpenSource":{"$ref":"#/components/examples/OpenSourceGetIgnoreResponse"}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/Ignore"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"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"}}},"ListIgnores200":{"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"}}},"ListIssues200":{"content":{"application/vnd.api+json":{"examples":{"Cloud":{"$ref":"#/components/examples/CloudListIssuesResponse"},"Code":{"$ref":"#/components/examples/CodeListIssuesResponse"},"IaC":{"$ref":"#/components/examples/IaCListIssuesResponse"},"OpenSource":{"$ref":"#/components/examples/OpenSourceListIssuesResponse"}},"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"}}},"UpdateIgnore200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Ignore"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"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"}}}},"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"},"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"},"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":{"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":{"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"},"AppResourceAttributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTTLSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId"},"context":{"$ref":"#/components/schemas/Context"},"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","context"],"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":{"$ref":"#/components/schemas/Context"},"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"],"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"},"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"},"AwsOptions":{"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":{"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"}},"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, hex, maven, npm, nuget, 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"},"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":"my-secret","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":256,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"resource":{"properties":{"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":256,"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":["id","name","input_type","resource_type","type","platform"],"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"},"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"},"CommonIssueModel":{"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"},"key":{"description":"The Snyk vulnerability ID.","example":"SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754","type":"string"},"problems":{"items":{"$ref":"#/components/schemas/Problem"},"type":"array"},"severities":{"description":"The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’.","items":{"$ref":"#/components/schemas/Severity"},"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"},"CommonIssueModelVTwo":{"properties":{"attributes":{"properties":{"coordinates":{"items":{"$ref":"#/components/schemas/CoordinateVTwo"},"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/Problem"},"type":"array"},"severities":{"description":"The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’.","items":{"$ref":"#/components/schemas/Severity"},"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/Remedy"},"type":"array"},"representation":{"description":"The affected versions of this vulnerability.","items":{"example":"5.3.0","type":"string"},"type":"array"}},"type":"object"},"CoordinateVTwo":{"properties":{"remedies":{"items":{"$ref":"#/components/schemas/Remedy"},"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"},"CreatePermissionsAttributes":{"example":{"platform":"aws","type":"cf"},"properties":{"options":{"properties":{"schema":{"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"}},"type":"object"}]}},"type":"object"},"platform":{"enum":["aws","azure","google"],"type":"string"},"type":{"enum":["cf","tf","bash"],"type":"string"}},"required":["type","platform"],"type":"object"},"CriteriaCreate":{"example":{"parameter":"problems[*].id","value":"npm:qs:20140806-1"},"properties":{"parameter":{"description":"The JMESPath representation of the field in the issue that needs to be ignored by","type":"string"},"value":{"type":"string"}},"required":["parameter","value"],"type":"object"},"CriteriaRetrieve":{"example":{"parameter":"problems[*].id","type":"problem-id","value":"npm:qs:20140806-1"},"properties":{"parameter":{"description":"The JMESPath representation of the field in the issue that needs to be ignored by","type":"string"},"type":{"$ref":"#/components/schemas/CriteriaType"},"value":{"type":"string"}},"required":["parameter","type","value"],"type":"object"},"CriteriaType":{"enum":["status","coordinate-environment-id","coordinate-environment-type","coordinate-environment-name","coordinate-resource-id","coordinate-resource-type","coordinate-resource-location","coordinate-resource-tags","problem-id","coordinate-source-location-file","coordinate-source-location-region","coordinate-list","coordinate-resource-path","key"],"type":"string"},"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"}},"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"},"DependencyChain":{"items":{"maxLength":2024,"minLength":1,"type":"string"},"maxItems":25,"minItems":1,"type":"array"},"DeprecatedRelationship":{"example":{"data":{"id":"e661d4ef-5ad5-4cef-ad16-5157cefa83f5","type":"org"},"links":{"self":{"href":"/v3/orgs/e661d4ef-5ad5-4cef-ad16-5157cefa83f5"}}},"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/Links"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data"],"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":256,"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":{"description":"Environment kind: aws","example":"aws","type":"string"},"name":{"description":"Environment name","example":"Demo AWS Environment","type":"string"},"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":{"description":"Environment kind: aws","example":"aws","type":"string"},"name":{"description":"Environment name","example":"Demo AWS Environment","type":"string"},"options":{"properties":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AwsOptions"},{"$ref":"#/components/schemas/GoogleOptions"},{"$ref":"#/components/schemas/AzureOptions"}]}},"type":"object"}},"required":["options"],"type":"object"},"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..."}}},"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":{"type":"string"},"options":{"properties":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AwsOptions"},{"$ref":"#/components/schemas/GoogleOptions"},{"$ref":"#/components/schemas/AzureOptions"}]}},"type":"object"}},"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"},"EventSelector":{"oneOf":[{"items":{"enum":["created","updated","deleted"],"type":"string"},"type":"array"},{"enum":["*"],"type":"string"}]},"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"},"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"},"GoogleOptions":{"description":"Options for creating a Google environment","example":{"project_id":"demo-project","service_account_email":"snyk-demo@demo-project.iam.gserviceaccount.com"},"properties":{"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","type":"string"}},"required":["service_account_email"],"type":"object"},"Group":{"additionalProperties":false,"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":false,"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"},"GroupRegistrationAttributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"}]},"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/RegistrationType"}},"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"},"HelloWorld":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"betaField":{"type":"string"},"message":{"type":"string"},"requestSubject":{"additionalProperties":false,"properties":{"clientId":{"format":"uuid","type":"string"},"publicId":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["publicId","type"],"type":"object"}},"required":["message","betaField","requestSubject"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"Id":{"format":"uuid","type":"string"},"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,"properties":{"created":{"description":"The time that the ignore was created.","example":"2021-06-01T00:00:00Z","format":"date-time","type":"string"},"criteria":{"description":"A combination of criteria which must all be true in order for an ignore to be applied to an issue.","items":{"$ref":"#/components/schemas/CriteriaRetrieve"},"type":"array"},"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"},"issue_version":{"$ref":"#/components/schemas/IssueVersion"},"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"}},"required":["issue_version","criteria","reason_type","reason","disregard_if_fixable","created","updated"],"type":"object"},"IgnoreCreateAttributes":{"additionalProperties":false,"properties":{"criteria":{"description":"A combination of criteria which must all be true in order for an ignore to be applied to an issue.","items":{"$ref":"#/components/schemas/CriteriaCreate"},"type":"array"},"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"},"issue_version":{"$ref":"#/components/schemas/IssueVersion"},"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"}},"required":["issue_version","criteria","reason_type","reason","disregard_if_fixable"],"type":"object"},"IgnoreCreateBody":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/IgnoreCreateAttributes"},"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"},"IgnoreUpdateAttributes":{"additionalProperties":false,"properties":{"criteria":{"description":"A combination of criteria which must all be true in order for an ignore to be applied to an issue.","items":{"$ref":"#/components/schemas/CriteriaCreate"},"type":"array"},"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"},"issue_version":{"$ref":"#/components/schemas/IssueVersion"},"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"}},"required":["issue_version","criteria","reason_type","reason","disregard_if_fixable"],"type":"object"},"IgnoreUpdateBody":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/IgnoreUpdateAttributes"},"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/IgnoreType"}},"required":["id","type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"Image":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ImageAttributes"},"id":{"$ref":"#/components/schemas/ImageDigest"},"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:[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"},"ImageRelationships":{"additionalProperties":false,"type":"object"},"InheritFromParent":{"description":"Which parent to inherit settings from.","enum":["group"],"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.","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":"iss03:73832c6c-19ff-4a92-850c-2e1ff2800c16:SNYK-CC-K8S-9","type":"string"},"links":{"properties":{"self":{"description":"A URL for the location of the issue","example":"https://example.com/issues/asdfb","format":"uri","type":"string"}},"type":"object"},"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":{"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":6,"minItems":1,"type":"array"},"representations":{"description":"A list of precise locations that surface an issue.\nA coordinate may have multiple representations. For example, a package vulnerability may be represented both\nby its package dependency graph traversal, and by the location in a package manifest that introduced the\ndependency.\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":{"dependencyChain":{"items":{"maxLength":2024,"minLength":1,"type":"string"},"maxItems":25,"minItems":1,"type":"array"}},"required":["dependencyChain"],"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":256,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"resource":{"properties":{"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":256,"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":["id","name","input_type","resource_type","type","platform"],"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"}},"required":["representations"],"type":"object"},"maxItems":25,"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"},"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"},"priority":{"$ref":"#/components/schemas/Priority"},"problems":{"description":"A list of details for vulnerability data, policy, etc that are the source of this issue.","items":{"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":{"enum":["rule","vulnerability"],"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","type","source"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"},"resolution":{"$ref":"#/components/schemas/Resolution"},"severities":{"description":"A list of severities given to this issue from associated source.","items":{"additionalProperties":false,"properties":{"level":{"enum":["info","low","medium","high","critical"],"type":"string"},"score":{"description":"A CVSS score for this severity, from 0 to 10 inclusive.\nScores may have a single significant decimal digit. This precision is enforced in the API.\n","maximum":10,"minimum":0,"type":"number"},"source":{"description":"The source of this severity. The value may be the id of a\nreferenced problem or class, in which case that problem or class is\nthe source of this issue.\n\nIf source is omitted, this severity is sourced internally in the Snyk application.\n","example":"CVE-2018-3728","maxLength":64,"minLength":1,"type":"string"},"vector":{"example":"CVSS:3.0/AV:N/AC:L/PR:L/UI:N/S:U/C:H/I:H/A:H","type":"string"}},"required":["level","source"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"},"slots":{"description":"Extension slots for type specific data, populated on issue creation. Limited in size to XX Kb when JSON serialized.","example":{"pkgName":"lodash","pkgVersion":"2.9.3"},"maxProperties":25,"minProperties":1,"type":"object"},"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"},"IssueCounts":{"additionalProperties":false,"properties":{"critical":{"example":1,"type":"number"},"high":{"example":1,"type":"number"},"low":{"example":1,"type":"number"},"medium":{"example":1,"type":"number"}},"required":["critical","high","medium","low"],"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"}},"policies":{"data":[{"id":"83b05679-aa82-45fa-8952-87b4051fc37d","type":"policy"},{"id":"a2054976-f405-4fdc-9535-fc81b79fe1a0","type":"policy"}]},"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"},"policies":{"additionalProperties":false,"properties":{"data":{"description":"An optional list of references to a Policy rule that modified some details\nabout the Issue during processing.\n","items":{"additionalProperties":false,"properties":{"id":{"example":"cd3ca312-e10a-498d-b88a-b9f6f1475c85","type":"string"},"type":{"$ref":"#/components/schemas/PolicyType"}},"required":["type","id"],"type":"object"},"maxItems":25,"type":"array"}},"required":["data"],"type":"object"},"previous":{"description":"A previous resolved occurance of this issue. If present, the issues will have the same key.\nMultiple previous occurances may exist, and can be retrieved by following the \"previous\" chain.\n","properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"string"},"type":{"enum":["issue"],"example":"issue","type":"string"}},"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/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"},"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"},"IssueType":{"description":"Issue type. Implies the existence of a resource /issues/detail/{issue-type}/{id}.\n","enum":["code"],"type":"string"},"IssueVersion":{"description":"The version of the issue API that the ignore targets.","enum":["2022-06-03"],"type":"string"},"IssuesMeta":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta"}},"type":"object"},"IssuesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModel"},"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/CommonIssueModelVTwo"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"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"},"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"},"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"},"Meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"},"MonitorAttributes":{"additionalProperties":false,"properties":{"image_id":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","pattern":"^sha256:[a-f0-9]{64}$","type":"string"},"integration_type":{"enum":["api","cli","kubernetes","container-registry"],"example":"cli","type":"string"},"issue_counts":{"additionalProperties":false,"properties":{"license":{"$ref":"#/components/schemas/IssueCounts"},"vuln":{"$ref":"#/components/schemas/IssueCounts"}},"required":["license","vuln"],"type":"object"},"monitor_id":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"},"project_id":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"},"project_snapshot_id":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"},"project_type":{"example":"maven","type":"string"},"target_id":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"}},"required":["image_id","target_id","project_id","project_snapshot_id","monitor_id","integration_type","project_type","issue_counts"],"type":"object"},"NugetBuildArgs":{"additionalProperties":false,"properties":{"target_framework":{"type":"string"}},"required":["target_framework"],"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"},"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":{"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 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"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","attributes"],"type":"object"},"OrgRegistrationAttributes":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/CloudTrailConfig"},{"$ref":"#/components/schemas/SecurityHubConfig"}]},"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"},"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":"woodstox-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"com.fasterxml.woodstox","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":"5.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"},"PermissionsAttributes":{"properties":{"data":{"type":"string"},"type":{"enum":["cf","tf","bash"],"type":"string"}},"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","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"},"PolicyType":{"enum":["policy"],"example":"policy","type":"string"},"Principal":{"additionalProperties":false,"properties":{"attributes":{"anyOf":[{"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"},{"$ref":"#/components/schemas/ServiceAccount"},{"$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"},"Priority":{"additionalProperties":false,"example":{"factors":[{"description":"Proof of Concept exploit","score":200,"type":"exploit:proof-of-concept"},{"description":"Recently disclosed","score":150,"type":"freshness"},{"description":"Medium severity","score":153,"type":"severity:medium"}],"score":503},"properties":{"factors":{"description":"An array of factors that contributed to scoring.","items":{"$ref":"#/components/schemas/PriorityFactor"},"maxItems":10,"type":"array"},"score":{"description":"A numeric priority score from 0 to 1000 determined by snyk.","maximum":1000,"minimum":0,"type":"integer"}},"required":["score"],"type":"object"},"PriorityFactor":{"additionalProperties":false,"properties":{"description":{"description":"A human readable description of this contributing factor.","maximum":1024,"minimum":1,"type":"string"},"score":{"description":"A numeric priority score contributing to the overall score.","maximum":1000,"minimum":0,"type":"integer"},"type":{"description":"The machine readable type of this factor.","maximum":256,"minimum":1,"type":"string"}},"required":["type","score"],"type":"object"},"Problem":{"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"},"Project":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"business_criticality":{"example":["medium"],"items":{"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":{"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"type":"string"},"type":"array"},"name":{"example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from","example":"github","type":"string"},"status":{"description":"Describes if a project is currently monitored or it is de-activated","example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"target_reference":{"example":"master","nullable":true,"type":"string"},"type":{"description":"The package manager of the project","example":"maven","type":"string"}},"required":["name","created","origin","type","status"],"type":"object"},"id":{"description":"The ID.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"importing_user":{"$ref":"#/components/schemas/Relationship"},"org":{"$ref":"#/components/schemas/Relationship"},"owner":{"$ref":"#/components/schemas/Relationship"},"target":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"description":"Content type.","example":"projects","type":"string"}},"required":["type","id","attributes"],"type":"object"},"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"},"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","settings"],"type":"object"},"ProjectDeprecated":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"businessCriticality":{"example":["medium"],"items":{"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":{"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"type":"string"},"type":"array"},"name":{"example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from","example":"github","type":"string"},"status":{"description":"Describes if a project is currently monitored or it is de-activated","example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"targetReference":{"description":"The identifier for which revision of the resource is scanned by Snyk. For example this may be a branch for SCM project, or a tag for a container image","example":"master","nullable":true,"type":"string"},"type":{"description":"The package manager of the project","example":"maven","type":"string"}},"required":["name","created","origin","type","status"],"type":"object"},"id":{"description":"The ID.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"importingUser":{"$ref":"#/components/schemas/DeprecatedRelationship"},"org":{"$ref":"#/components/schemas/DeprecatedRelationship"},"owner":{"$ref":"#/components/schemas/DeprecatedRelationship"},"target":{"$ref":"#/components/schemas/DeprecatedRelationship"}},"type":"object"},"type":{"description":"Content type.","example":"projects","type":"string"}},"required":["type","id","attributes"],"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/Target"}]}},"required":["target","organization"],"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"},"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"},"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"},"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\").","enum":["all","only_new"],"example":"all","type":"string"},"severity_threshold":{"description":"Only fail for issues greater than or equal to the specified severity.","enum":["low","medium","high","critical"],"example":"high","type":"string"}},"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"},"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"},"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":{"enum":["aws-cloudtrail","aws-securityhub"],"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":{"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":{"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":256,"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":["id","name","input_type","resource_type","type","platform"],"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-01-26Z12:34:56Z"},"properties":{"created_at":{"description":"When the resource was first recorded","example":"2022-08-10T17:19:33.14749Z","type":"string"},"deleted_at":{"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":{"description":"Kind of resource: cloud","example":"cloud","type":"string"},"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":{"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","nullable":true,"type":"string"}},"required":["created_at","updated_at","revision","kind","hash","platform","resource_type","resource_id"],"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"},"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"},"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"},"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"},"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"},"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"},"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"},"SecurityHubConfig":{"description":"A registration config for AWS Security Hub","example":{"account_id":"123456789012"},"properties":{"account_id":{"example":"123456789012","type":"string"}},"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":{"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"},"Severity":{"properties":{"level":{"example":"medium","type":"string"},"score":{"description":"The CVSSv3 value of the vulnerability.","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"},"vector":{"description":"The CVSSv3 value of the 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"}},"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"}},"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":{"description":"The exploit maturity. Value of ‘No Data’, ‘Not Defined’, ‘Unproven’, ‘Proof of Concept’, ‘Functional’ or ‘High’.","example":"Not Defined","type":"string"},"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"},"Tag":{"additionalProperties":false,"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"required":["key","value"],"type":"object"},"Target":{"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"},"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"},"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"},"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"},"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":{"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":{"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"},"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"},"VersioningSchema":{"allOf":[{"oneOf":[{"$ref":"#/components/schemas/VersioningSchemaSemverType"},{"$ref":"#/components/schemas/VersioningSchemaCustomType"},{"$ref":"#/components/schemas/VersioningSchemaDateType"}]}],"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"},"VersioningSchemaAttributes":{"additionalProperties":false,"properties":{"properties":{"allOf":[{"$ref":"#/components/schemas/VersioningSchemaRequiredFields"},{"oneOf":[{"$ref":"#/components/schemas/VersioningSchemaSemverType"},{"$ref":"#/components/schemas/VersioningSchemaCustomType"},{"$ref":"#/components/schemas/VersioningSchemaDateType"}]}]}},"required":["properties"],"type":"object"},"VersioningSchemaCustomType":{"additionalProperties":false,"description":"A fully customizable versioning scheme","properties":{"expression":{"description":"The regular expression used to describe the format of tags.\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"},"VersioningSchemaDateType":{"additionalProperties":false,"properties":{"type":{"enum":["date"],"example":"date","type":"string"}},"required":["type"],"type":"object"},"VersioningSchemaPostRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/VersioningSchemaAttributes"},"type":{"description":"This should always be \"versioning_schema\"","example":"versioning_schema","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"VersioningSchemaRequiredFields":{"additionalProperties":false,"properties":{"org_id":{"description":"The org ID that the versioning schema will be a part of.\nThis will be used for authorizing usage of the versioning schema resource.\n","example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"}},"required":["org_id"],"type":"object"},"VersioningSchemaResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/VersioningSchemaAttributes"},"id":{"example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"},"type":{"example":"versioning_schema","type":"string"}},"required":["id","type","attributes"],"type":"object"},"VersioningSchemaResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/VersioningSchemaResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi"],"type":"object"},"VersioningSchemaSemverType":{"additionalProperties":false,"properties":{"type":{"enum":["semver"],"example":"semver","type":"string"}},"required":["type"],"type":"object"},"WebhookAttributes":{"example":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":"*"},"version":"2022-02-01~beta"},"properties":{"callback_url":{"description":"URL to send webhook notification to","format":"url","type":"string"},"selector":{"description":"The events the webhook is subscribed to","properties":{"projects":{"$ref":"#/components/schemas/EventSelector"}},"type":"object"},"signed":{"description":"Indicates whether or not the webhook has been set up to be HMAC signed","type":"boolean"},"version":{"$ref":"#/components/schemas/ActualVersion"}},"required":["callback_url","version"],"type":"object"},"WebhookCreateAttributes":{"example":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":["created","deleted"]},"signing_secret":"XFqEviZeb4pX/xuhV/aXwZj+gciw72GG","version":"2022-02-01~beta"},"properties":{"callback_url":{"description":"URL to send webhook notification to","format":"url","type":"string"},"selector":{"description":"The events the webhook is subscribed to","properties":{"projects":{"$ref":"#/components/schemas/EventSelector"}},"type":"object"},"signing_secret":{"description":"HMAC signature of the webhook","maxLength":64,"minLength":32,"type":"string"},"version":{"$ref":"#/components/schemas/ActualVersion"}},"required":["callback_url","version","selector"],"type":"object"},"WebhookRelationships":{"additionalProperties":false,"type":"object"},"WebhookUpdateAttributes":{"example":{"callback_url":"https://example.com/my-webhook-handler","selector":{"projects":"*","targets":"*","users":["created","deleted"]},"signing_secret":"XFqEviZeb4pX/xuhV/aXwZj+gciw72GG","version":"2022-02-01~beta"},"properties":{"callback_url":{"description":"URL to send webhook notification to","format":"url","type":"string"},"selector":{"description":"The events the webhook is subscribed to","properties":{"projects":{"$ref":"#/components/schemas/EventSelector"}},"type":"object"},"signing_secret":{"description":"HMAC signature of the webhook","maxLength":64,"minLength":32,"type":"string"}},"type":"object"},"YarnBuildArgs":{"additionalProperties":false,"properties":{"root_workspace":{"type":"string"}},"required":["rootWorkspace"],"type":"object"}},"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.\n","operationId":"getCustomBaseImages","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/OrgId"},{"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"},{"$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":["2022-08-21~experimental","2023-04-18~beta"],"x-snyk-api-version":"2023-04-18~beta"},"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":["2022-08-21~experimental","2023-04-18~beta"],"x-snyk-api-version":"2023-04-18~beta"},"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":["2022-08-21~experimental","2023-04-18~beta"],"x-snyk-api-version":"2023-04-18~beta"},"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":["2022-08-21~experimental","2023-04-18~beta"],"x-snyk-api-version":"2023-04-18~beta"},"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":["2022-08-21~experimental","2023-04-18~beta"],"x-snyk-api-version":"2023-04-18~beta"},"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}/cloud_events/group_registrations":{"get":{"description":"List all group registrations for the given group.","operationId":"listGroupRegistrations","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/GroupId"},{"$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":["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"},{"$ref":"#/components/parameters/GroupId"}],"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"},"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/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":["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"},{"$ref":"#/components/parameters/GroupId"},{"$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":["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"},{"$ref":"#/components/parameters/GroupId"},{"$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":["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"},{"$ref":"#/components/parameters/GroupId"},{"$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"}]},"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":["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"},{"$ref":"#/components/parameters/GroupId"},{"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"},{"description":"A scan item types to filter issues through their scan item relationship.","in":"query","name":"scan_item.type","schema":{"enum":["project","environment"],"example":"project","type":"string"},"style":"form"},{"$ref":"#/components/parameters/Type"},{"$ref":"#/components/parameters/UpdatedAfter"}],"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get issues by group ID","tags":["Issues"],"x-snyk-api-releases":["2023-03-10~experimental"],"x-snyk-api-version":"2023-03-10~experimental"},"x-snyk-api-resource":"issues"},"/groups/{group_id}/service_accounts":{"post":{"description":"Create a service account for a group. The service account can be used to generate access tokens. Currently, we only allow group service accounts using default group roles.","operationId":"createGroupServiceAccount","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 oauth_private_key_jwt.","maximum":86400,"minimum":3600,"type":"number"},"auth_type":{"description":"Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\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_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_name":{"description":"The name of the role which the created service account should use. Available roles include 'Group Admin', 'Group Member' and 'Group Viewer'.","example":"Group Viewer","type":"string"}},"required":["name","auth_type","role_name"],"type":"object"},"type":{"description":"Content type.","example":"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":{"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_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_private_key_jwt"],"type":"string"},"client_id":{"description":"The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.","type":"string"},"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"},"name":{"description":"A human-friendly name of the service account.","type":"string"},"role_id":{"description":"The ID of the role which the Service Account is associated with.","format":"uuid","type":"string"}},"required":["name","auth_type","role_id"],"type":"object"},"id":{"format":"uuid","type":"string"},"links":{"additionalProperties":false,"properties":{"first":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"last":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"next":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"prev":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"related":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"self":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"type":{"type":"string"}},"required":["type","id","attributes","links"],"type":"object"},"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":["2022-07-08~experimental"],"x-snyk-api-version":"2022-07-08~experimental"},"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"},"/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/UserId"},{"$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":"updateUser","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/SsoId"},{"$ref":"#/components/parameters/UserId"},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserPatchRequestBody"}},"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":"Patch a user","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":{"schema":{"properties":{"data":{"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"}},"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":"Patch user by ID","tags":["Users"],"x-snyk-api-releases":["2022-10-06~beta"],"x-snyk-api-version":"2022-10-06~beta"},"x-snyk-api-resource":"users"},"/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"}},"security":[],"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"}},"security":[],"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"},"x-snyk-api-resource":"orgs"},"/orgs/{org_id}/app_bots":{"get":{"description":"Get a list of app bots authorized to an organization.","operationId":"getAppBots","parameters":[{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["app"],"type":"string"},"type":"array"},"style":"form"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppBot"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of app bots authorized to the specified organization","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get a list of app bots authorized to an organization.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"app_bots"},"/orgs/{org_id}/app_bots/{bot_id}":{"delete":{"description":"Revoke app bot authorization","operationId":"deleteAppBot","parameters":[{"description":"The ID of the app bot","in":"path","name":"bot_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"The app bot has been deauthorized","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Revoke app bot authorization","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"app_bots"},"/orgs/{org_id}/apps":{"get":{"description":"Get a list of apps created by an organization.","operationId":"getApps","parameters":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of apps created by the specified organization","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get a list of apps created by an organization.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"post":{"description":"Create a new app for an organization.","operationId":"createApp","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostRequest"}}},"description":"app to be created"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostResponse"}}},"description":"Created Snyk App successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Create a new app for an organization.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"apps"},"/orgs/{org_id}/apps/{client_id}":{"delete":{"description":"Delete an app by app id","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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Delete an app","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"get":{"description":"Get an App by client id","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/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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get an app by client id","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"patch":{"description":"Update app attributes","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/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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Update 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-api-resource":"apps"},"/orgs/{org_id}/apps/{client_id}/secrets":{"post":{"description":"Manage client secrets for an app.","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/AppDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Secrets have been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Manage client secrets for an app.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"apps"},"/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"}},{"$ref":"#/components/parameters/CreatedAfter"},{"$ref":"#/components/parameters/CreatedBefore"},{"$ref":"#/components/parameters/UpdatedAfter"},{"$ref":"#/components/parameters/UpdatedBefore"},{"$ref":"#/components/parameters/NameInQuery"},{"$ref":"#/components/parameters/KindInQuery"},{"$ref":"#/components/parameters/StatusInQuery"},{"$ref":"#/components/parameters/IdInQuery"},{"$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"],"x-snyk-api-version":"2022-12-21~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"],"x-snyk-api-version":"2022-12-21~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"],"x-snyk-api-version":"2022-12-21~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"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["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"],"x-snyk-api-version":"2022-12-21~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"],"x-snyk-api-version":"2022-12-21~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"},{"$ref":"#/components/parameters/ResourceId"},{"$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"],"x-snyk-api-version":"2022-12-21~beta"},"x-snyk-api-resource":"resources"},"/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_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":["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"}]},"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":["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":["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":["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":["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":["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":["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":["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":["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":"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/CodeIssue"},"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":["2023-03-08~experimental"],"x-snyk-api-version":"2023-03-08~experimental"},"x-snyk-api-resource":"code_issues"},"/orgs/{org_id}/code_issue_summaries":{"get":{"description":"⚠️ _This endpoint currently only lists issues for Snyk Code projects. If a project ID for any other type of project is used, it will return 404_\nGet a summary of all types of issues found on a project or snapshot. Supports pagination, filtering by severity and issue type. One of ProjectID or SnapshotID must be specified.\n","operationId":"getIssuesSummary","parameters":[{"description":"The id of the org to return a list of projects","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Project ID","in":"query","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/IssueSeverity"},{"$ref":"#/components/parameters/IssueType"},{"$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/IssueSummary"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of matching issue summaries 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 summary of issues within an org","tags":["Issues"],"x-snyk-api-releases":["2023-03-08~experimental"],"x-snyk-api-version":"2023-03-08~experimental"},"x-snyk-api-resource":"issue_summaries"},"/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"],"x-snyk-api-version":"2023-03-08~beta"},"post":{"description":"Create a new container image","operationId":"createContainerImage","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Image"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Image"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Created container image 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 container image","tags":["ContainerImage"],"x-snyk-api-releases":["2023-03-08~beta"],"x-snyk-api-version":"2023-03-08~beta"},"x-snyk-api-resource":"container_images"},"/orgs/{org_id}/container_images/{image_id}":{"get":{"description":"Get instance of container image","operationId":"getContainerImage","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ImageId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Image"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"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"],"x-snyk-api-version":"2023-03-08~beta"},"patch":{"description":"Update an instance of container image","operationId":"updateContainerImage","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ImageId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"names":{"items":{"$ref":"#/components/schemas/ImageName"},"type":"array"}},"required":["names"],"type":"object"},"id":{"$ref":"#/components/schemas/ImageDigest"},"type":{"enum":["container_image"],"type":"string"}},"required":["attributes"],"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 an instance of container image","tags":["ContainerImage"],"x-snyk-api-releases":["2023-03-08~beta"],"x-snyk-api-version":"2023-03-08~beta"},"x-snyk-api-resource":"container_images"},"/orgs/{org_id}/ignores":{"get":{"description":"List all ignores for an org, project 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/ScanItemId"},{"$ref":"#/components/parameters/ScanItemType"},{"$ref":"#/components/parameters/IssueProblemId"},{"$ref":"#/components/parameters/IssueKey"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"$ref":"#/components/responses/ListIgnores200"},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"List all ignores for an org, project and/or issue","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~experimental"],"x-snyk-api-version":"2022-10-28~experimental"},"post":{"description":"Add an ignore rule to a project 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":{"$ref":"#/components/responses/CreateIgnore201"},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Add an ignore rule to a project and create the corresponding ignore.","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~experimental"],"x-snyk-api-version":"2022-10-28~experimental"},"x-snyk-api-resource":"ignores"},"/orgs/{org_id}/ignores/{ignore_id}":{"delete":{"description":"Delete 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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Delete ignore","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~experimental"],"x-snyk-api-version":"2022-10-28~experimental"},"get":{"description":"Get 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":{"$ref":"#/components/responses/GetIgnore200"},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get an ignore","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~experimental"],"x-snyk-api-version":"2022-10-28~experimental"},"patch":{"description":"Update 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/IgnoreUpdateBody"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateIgnore200"},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Update an ignore","tags":["Ignore"],"x-snyk-api-releases":["2022-05-11~experimental","2022-10-28~experimental"],"x-snyk-api-version":"2022-10-28~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/OrgInvitation"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A new organization invitation has been created","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Invite a user to an organization","tags":["Invites"],"x-snyk-api-releases":["2022-06-01","2023-04-28"],"x-snyk-api-version":"2023-04-28"},"x-snyk-api-resource":"org_invitations"},"/orgs/{org_id}/invites/{invite_id}":{"delete":{"description":"Cancel a pending user invitations to an organization.","operationId":"deleteOrgInvitation","parameters":[{"description":"The id of the org the user is being invited to","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the pending invite to cancel","in":"path","name":"invite_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Cancel a pending user invitations to an organization.","tags":["Invites"],"x-snyk-api-releases":["2022-11-14"],"x-snyk-api-version":"2022-11-14"},"x-snyk-api-resource":"org_invitations"},"/orgs/{org_id}/issues":{"get":{"description":"⚠️ _This endpoint currently only lists issues for Snyk Code projects. If a project ID for any other type of project is used, it will return 404_\nGet a summary of all types of issues found on a project or snapshot. Supports pagination, filtering by severity and issue type. One of ProjectID or SnapshotID must be specified.\n","operationId":"getIssuesSummary","parameters":[{"description":"The id of the org to return a list of projects","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Project ID","in":"query","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/IssueSeverity"},{"$ref":"#/components/parameters/IssueType"},{"$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/IssueSummary"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of matching issue summaries 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 summary of issues within an org","tags":["Issues"],"x-snyk-api-releases":["2021-08-13~experimental"],"x-snyk-api-version":"2021-08-13~experimental"},"x-snyk-api-resource":"issue_summaries"},"/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/CodeIssue"},"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/detail/code/{issue_id}/all":{"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":"listCodeIssues","parameters":[{"$ref":"#/components/parameters/Version"},{"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/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CodeIssue"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Code issue(s) 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(s) by its ID","tags":["Issues"],"x-snyk-api-releases":["2022-06-08~experimental"],"x-snyk-api-version":"2022-06-08~experimental"},"x-snyk-api-resource":"code_issues"},"/orgs/{org_id}/monitors":{"post":{"description":"Create monitor","operationId":"createMonitor","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"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/MonitorAttributes"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"204":{"description":"Created monitor 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":"Create monitor","tags":["Monitors"],"x-snyk-api-releases":["2022-10-14~experimental"],"x-snyk-api-version":"2022-10-14~experimental"},"x-snyk-api-resource":"monitors"},"/orgs/{org_id}/packages":{"get":{"description":"List instances of packages","operationId":"listPackages","parameters":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PackageName"},{"$ref":"#/components/parameters/PackageVersion"},{"$ref":"#/components/parameters/PackageType"},{"$ref":"#/components/parameters/UriEncode"},{"$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":{"id":{"format":"uri","type":"string"},"issues_url":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"type":{"example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"properties":{"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"}},"type":"object"}}},"description":"Returns a list of repositories","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 instances of packages","tags":["Packages"],"x-snyk-api-releases":["2022-08-08~experimental"],"x-snyk-api-version":"2022-08-08~experimental"},"x-snyk-api-resource":"packages"},"/orgs/{org_id}/packages/issues":{"post":{"description":"This endpoint is not available to all customers. If you are interested please contact support. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned, transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.","operationId":"listIssuesForManyPurls","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkPackageUrlsRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IssuesWithPurlsResponse"}}},"description":"Returns an array of issues with the purl identifier of the package that caused them","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/Location"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$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"],"x-snyk-api-version":"2023-04-17"},"x-snyk-api-resource":"issues"},"/orgs/{org_id}/packages/{purl}/issues":{"get":{"description":"Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.","operationId":"fetchIssuesPerPurl","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/PackageUrl"},{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0.","in":"query","name":"offset","schema":{"type":"number"}},{"description":"Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000.","in":"query","name":"limit","schema":{"type":"number"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IssuesResponse"}}},"description":"Returns an array of issues","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$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-04-04~experimental","2022-06-29~beta","2022-09-15"],"x-snyk-api-version":"2022-09-15"},"x-snyk-api-resource":"issues"},"/orgs/{org_id}/projects":{"get":{"description":"List all Projects for an Org.","operationId":"listOrgProjects","parameters":[{"description":"The ID of the org that the projects belong to.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Return projects that belong to the provided targets","in":"query","name":"target_id","schema":{"items":{"type":"string"},"type":"array"}},{"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 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":"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"}},{"$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"}},"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"],"x-snyk-api-version":"2023-02-15"},"x-snyk-api-resource":"projects"},"/orgs/{org_id}/projects/{project_id}":{"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"},{"$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"}},"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"],"x-snyk-api-version":"2023-02-15"},"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":"The ID of user initiating the action.","in":"query","name":"user_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"],"x-snyk-api-version":"2023-02-15"},"x-snyk-api-resource":"projects"},"/orgs/{org_id}/projects/{project_id}/sbom":{"get":{"description":"This endpoint lets you retrieve the SBOM document of a software project.\nIt supports the following formats:\n* CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`).\n* CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`).\n* SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`).\n\nBy default it will respond with an empty JSON:API response.","operationId":"getSbom","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Unique identifier for a project","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Format"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpdxDocument"}},"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SbomResponse"}},"application/vnd.cyclonedx+json":{"schema":{"$ref":"#/components/schemas/CycloneDxDocument"}},"application/vnd.cyclonedx+xml":{"schema":{"$ref":"#/components/schemas/CycloneDxXmlDocument"}}},"description":"Returns the SBOM document of a project","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a project’s SBOM document","tags":["SBOM"],"x-snyk-api-releases":["2022-03-31~experimental","2022-12-06~beta","2023-03-20"],"x-snyk-api-version":"2023-03-20"},"x-snyk-api-resource":"sboms","x-snyk-resource-singleton":true},"/orgs/{org_id}/service_accounts":{"post":{"description":"Create a service account for an organization. The service account can be used to generate access tokens.","operationId":"createServiceAccount","parameters":[{"description":"The ID of the Snyk Org that is creating and owns 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":{"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 oauth_private_key_jwt.","maximum":86400,"minimum":3600,"type":"number"},"auth_type":{"description":"Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\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_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","auth_type","role_id"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"access_token_ttl_seconds":{"description":"The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.","type":"number"},"api_key":{"description":"The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.","type":"string"},"auth_type":{"description":"The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_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_private_key_jwt"],"type":"string"},"client_id":{"description":"The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.","type":"string"},"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"},"name":{"description":"A human-friendly name of the service account.","type":"string"},"role_id":{"description":"The ID of the role which the Service Account is associated with.","format":"uuid","type":"string"}},"required":["name","auth_type","role_id"],"type":"object"},"id":{"format":"uuid","type":"string"},"links":{"additionalProperties":false,"properties":{"first":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"last":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"next":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"prev":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"related":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]},"self":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"type":{"type":"string"}},"required":["type","id","attributes","links"],"type":"object"},"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 an organization.","tags":["ServiceAccounts"],"x-snyk-api-releases":["2022-07-08~experimental"],"x-snyk-api-version":"2022-07-08~experimental"},"x-snyk-api-resource":"service_accounts"},"/orgs/{org_id}/service_accounts/{service_account_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":"service_account_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":["2022-07-08~experimental"],"x-snyk-api-version":"2022-07-08~experimental"},"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}/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~experimental"],"x-snyk-api-version":"2022-12-14~experimental"},"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~experimental"],"x-snyk-api-version":"2022-12-14~experimental"},"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~experimental"],"x-snyk-api-version":"2022-12-14~experimental"},"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~experimental"],"x-snyk-api-version":"2022-12-14~experimental"},"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~experimental"],"x-snyk-api-version":"2022-12-14~experimental"},"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~experimental"],"x-snyk-api-version":"2022-12-14~experimental"},"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~experimental"],"x-snyk-api-version":"2022-12-14~experimental"},"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~experimental"],"x-snyk-api-version":"2022-11-07~experimental"},"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"},{"$ref":"#/components/parameters/Limit"},{"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 isPrivate","in":"query","name":"isPrivate","schema":{"type":"boolean"}},{"description":"Return targets that match the provided remoteUrl. Currently null for all projects except those imported from the CLI","in":"query","name":"remoteUrl","schema":{"type":"string"}},{"description":"Return targets that match the provided origin","in":"query","name":"origin","schema":{"type":"string"}},{"description":"Whether to exclude targets from the response that have no associated projects","in":"query","name":"excludeEmpty","schema":{"default":true,"type":"boolean"}},{"description":"Return targets with display names starting with the provided string","in":"query","name":"displayName","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Target"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"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"],"x-snyk-api-version":"2021-08-20~beta"},"x-snyk-api-resource":"targets"},"/orgs/{org_id}/targets/{target_id}":{"delete":{"description":"Delete the specified target. Will fail if the target has any projects.","operationId":"deleteOrgsTarget","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":{"204":{"description":"The target is deleted if it is found in the specified org and has no projects","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"},"409":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Unprocessable Entity: The target cannot be deleted as it has projects.","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":{"$ref":"#/components/responses/500"}},"summary":"Delete target by target ID","tags":["Targets"],"x-snyk-api-releases":["2021-09-29~beta"],"x-snyk-api-version":"2021-09-29~beta"},"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/Target"},"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 org ID","tags":["Targets"],"x-snyk-api-releases":["2021-08-20~beta"],"x-snyk-api-version":"2021-08-20~beta"},"x-snyk-api-resource":"targets"},"/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":{"$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":"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":{"$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":"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.","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"},"/orgs/{org_id}/webhooks":{"get":{"description":"List instances of webhook","operationId":"listWebhook","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The organization ID to associate a webhook to. The API_KEY must have access to this organization.","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":{"examples":{"SpecificOperations":{"$ref":"#/components/examples/SpecificOperationsGetManyResponse"},"Wildcard":{"$ref":"#/components/examples/WildcardGetManyResponse"}},"schema":{"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/WebhookAttributes"},"id":{"description":"Unique identifier for webhook instances.","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/WebhookRelationships"},"type":{"enum":["webhook"],"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 webhook 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 webhook","tags":["Webhooks"],"x-snyk-api-releases":["2022-04-21~experimental","2022-11-04~experimental","2022-11-15~experimental"],"x-snyk-api-version":"2022-11-15~experimental"},"post":{"description":"⚠️ _This endpoint currently only supports project events.\n","operationId":"createWebhook","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The organization ID to associate a webhook to. The API_KEY must have access to this organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"examples":{"SpecificOperations":{"$ref":"#/components/examples/SpecificOperationsCreateOneRequestBody"},"Wildcard":{"$ref":"#/components/examples/WildcardCreateOneRequestBody"}},"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/WebhookCreateAttributes"},"type":{"description":"Type of resource.","enum":["webhook"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"examples":{"SpecificOperations":{"$ref":"#/components/examples/SpecificOperationsGetOrCreateOneResponse"},"Wildcard":{"$ref":"#/components/examples/WildcardGetOrCreateOneResponse"}},"schema":{"properties":{"data":{"additionalProperties":false,"description":"webhook resource object","properties":{"attributes":{"$ref":"#/components/schemas/WebhookAttributes"},"id":{"description":"Unique identifier for webhook instances.","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/WebhookRelationships"},"type":{"description":"Type of resource","enum":["webhook"],"type":"string"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}}}}},"description":"Created webhook 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 webhook","tags":["Webhooks"],"x-snyk-api-releases":["2022-04-21~experimental","2022-11-04~experimental","2022-11-15~experimental"],"x-snyk-api-version":"2022-11-15~experimental"},"x-snyk-api-resource":"webhooks"},"/orgs/{org_id}/webhooks/{webhook_id}":{"delete":{"description":"Delete a webhook by ID","operationId":"deleteWebhook","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The organization ID to associate a webhook to. The API_KEY must have access to this organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/WebhookId"}],"responses":{"204":{"description":"Deletes an instance of webhook","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 webhook","tags":["Webhooks"],"x-snyk-api-releases":["2022-04-21~experimental","2022-11-04~experimental","2022-11-15~experimental"],"x-snyk-api-version":"2022-11-15~experimental"},"get":{"description":"Get instance of webhook","operationId":"getWebhook","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The organization ID to associate a webhook to. The API_KEY must have access to this organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/WebhookId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"examples":{"SpecificOperations":{"$ref":"#/components/examples/SpecificOperationsGetOrCreateOneResponse"},"Wildcard":{"$ref":"#/components/examples/WildcardGetOrCreateOneResponse"}},"schema":{"properties":{"data":{"additionalProperties":false,"description":"webhook resource object","properties":{"attributes":{"$ref":"#/components/schemas/WebhookAttributes"},"id":{"description":"Unique identifier for webhook instances.","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/WebhookRelationships"},"type":{"enum":["webhook"],"type":"string"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}}}}},"description":"Returns an instance of webhook","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 webhook","tags":["Webhooks"],"x-snyk-api-releases":["2022-04-21~experimental","2022-11-04~experimental","2022-11-15~experimental"],"x-snyk-api-version":"2022-11-15~experimental"},"patch":{"description":"Update a webhook","operationId":"updateWebhook","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The organization ID to associate a webhook to. The API_KEY must have access to this organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/WebhookId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/WebhookUpdateAttributes"},"id":{"description":"Unique identifier for webhook instances.","format":"uuid","type":"string"},"type":{"description":"Type of resource.","enum":["webhook"],"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":"webhook resource object","properties":{"attributes":{"$ref":"#/components/schemas/WebhookAttributes"},"id":{"description":"Unique identifier for webhook instances.","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/WebhookRelationships"},"type":{"description":"Type of resource.","enum":["webhook"],"type":"string"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Instance of webhook 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 a webhook","tags":["Webhooks"],"x-snyk-api-releases":["2022-04-21~experimental","2022-11-04~experimental","2022-11-15~experimental"],"x-snyk-api-version":"2022-11-15~experimental"},"x-snyk-api-resource":"webhooks"},"/self":{"get":{"description":"Retrieves information about the the user making the request.","operationId":"getSelf","parameters":[{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Principal"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Current user is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"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"],"x-snyk-api-version":"2022-09-14~experimental"},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get a list of 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/{app_id}":{"delete":{"description":"Revoke access for an app by app id","operationId":"revokeUserInstalledApp","parameters":[{"$ref":"#/components/parameters/Version"},{"in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"}}],"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get a list of active OAuth sessions for the app.","tags":["Apps"],"x-snyk-api-releases":["2023-03-30~experimental"],"x-snyk-api-version":"2023-03-30~experimental"},"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"},{"in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"}},{"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Revoke an active user app session.","tags":["Apps"],"x-snyk-api-releases":["2023-03-30~experimental"],"x-snyk-api-version":"2023-03-30~experimental"},"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},"/versioning_schemas":{"post":{"description":"Create a new versioning schema","operationId":"createVersioningSchema","parameters":[{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VersioningSchemaPostRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VersioningSchemaResponse"}}},"description":"Successfully created a versioning schema","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 versioning schema","tags":["Versioning Schema"],"x-snyk-api-releases":["2023-03-21~experimental"],"x-snyk-api-version":"2023-03-21~experimental"},"x-snyk-api-resource":"versioningschema"}},"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":"Snyk Cloud API","name":"Cloud"},{"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","name":"Custom Base Images"},{"description":"todo","name":"Depgraphs"},{"description":"An example of a v3 API resource","name":"Examples"},{"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":"Monitor","name":"Monitors"},{"description":"The OpenAPI specification for unmanaged-deps.","name":"OpenAPI"},{"description":"Snyk Organizations","name":"Orgs"},{"description":"Short description of what Package represents","name":"Packages"},{"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":"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":"Registration"},{"description":"A Software Bill of Materials document","name":"SBOM"},{"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":"A target is the external source of data from which Snyk can scan resources and create projects. Many projects may exist for the same target.\n","name":"Targets"},{"description":"Snyk Users","name":"Users"},{"description":"A 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","name":"Versioning Schema"},{"description":"Webhooks for event notification to 3rd party services","name":"Webhooks"}],"x-optic-url":"https://app.useoptic.com/organizations/390ef489-882c-48ba-acb3-4e0b73e48767/apis/5Tz5UMTNEIuz5-FZ6J2ki","x-snyk-api-lifecycle":"deprecated","x-snyk-api-version":"2023-04-28~experimental"} \ No newline at end of file diff --git a/specs/snyk.json b/specs/snyk.json new file mode 100644 index 0000000..8c25e68 --- /dev/null +++ b/specs/snyk.json @@ -0,0 +1 @@ +{"components":{"headers":{"DeprecationHeader":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"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"}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}},"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":{"ClientId":{"description":"Client ID","in":"path","name":"client_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"EndingBefore":{"description":"Return the page of results immediately before this cursor","example":"v1.eyJpZCI6IjExMDAifQo=","in":"query","name":"ending_before","schema":{"type":"string"}},"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"}},"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"}},"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, hex, maven, npm, nuget, 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"}},"ProjectId":{"description":"Unique identifier for a project","in":"path","name":"project_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"}},"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"}}}},"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"},"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"},"AppName":{"description":"New name of the app to display to users during authorization flow.","example":"My App","minLength":1,"type":"string"},"AppPatchRequest":{"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":{"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"},"AppResourceAttributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTTLSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId"},"context":{"$ref":"#/components/schemas/Context"},"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","context"],"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":{"$ref":"#/components/schemas/Context"},"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"],"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"},"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"},"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, hex, maven, npm, nuget, 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"},"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":"my-secret","minLength":1,"type":"string"},"CommonIssueModel":{"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"},"key":{"description":"The Snyk vulnerability ID.","example":"SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754","type":"string"},"problems":{"items":{"$ref":"#/components/schemas/Problem"},"type":"array"},"severities":{"description":"The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’.","items":{"$ref":"#/components/schemas/Severity"},"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"},"CommonIssueModelVTwo":{"properties":{"attributes":{"properties":{"coordinates":{"items":{"$ref":"#/components/schemas/CoordinateVTwo"},"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/Problem"},"type":"array"},"severities":{"description":"The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’.","items":{"$ref":"#/components/schemas/Severity"},"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/Remedy"},"type":"array"},"representation":{"description":"The affected versions of this vulnerability.","items":{"example":"5.3.0","type":"string"},"type":"array"}},"type":"object"},"CoordinateVTwo":{"properties":{"remedies":{"items":{"$ref":"#/components/schemas/Remedy"},"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"},"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"}},"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"},"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"},"HelloWorld":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"message":{"type":"string"},"requestSubject":{"additionalProperties":false,"properties":{"clientId":{"format":"uuid","type":"string"},"publicId":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["publicId","type"],"type":"object"}},"required":["message","requestSubject"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"Id":{"format":"uuid","type":"string"},"InheritFromParent":{"description":"Which parent to inherit settings from.","enum":["group"],"type":"string"},"IsConfidential":{"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"},"IssuesMeta":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta"}},"type":"object"},"IssuesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModel"},"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/CommonIssueModelVTwo"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"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"},"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"},"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"},"Meta":{"additionalProperties":true,"description":"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"},"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"},"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":{"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 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"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","attributes"],"type":"object"},"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":"woodstox-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"com.fasterxml.woodstox","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":"5.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"},"Problem":{"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"},"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"},"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","settings"],"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/Target"}]}},"required":["target","organization"],"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"},"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"},"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"},"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\").","enum":["all","only_new"],"example":"all","type":"string"},"severity_threshold":{"description":"Only fail for issues greater than or equal to the specified severity.","enum":["low","medium","high","critical"],"example":"high","type":"string"}},"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"},"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"},"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":{"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"},"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"},"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"},"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"},"Severity":{"properties":{"level":{"example":"medium","type":"string"},"score":{"description":"The CVSSv3 value of the vulnerability.","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"},"vector":{"description":"The CVSSv3 value of the 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"}},"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":{"description":"The exploit maturity. Value of ‘No Data’, ‘Not Defined’, ‘Unproven’, ‘Proof of Concept’, ‘Functional’ or ‘High’.","example":"Not Defined","type":"string"},"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"},"SpdxDocument":{"additionalProperties":true,"type":"object"},"Target":{"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"},"Type":{"type":"string"},"Types":{"example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"},"Updated":{"description":"The last time the settings were updated.","example":"2021-11-12T10:31:06.026Z","format":"date-time","type":"string"},"Uuid":{"format":"uuid","type":"string"},"YarnBuildArgs":{"additionalProperties":false,"properties":{"root_workspace":{"type":"string"}},"required":["rootWorkspace"],"type":"object"}},"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":{"/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"},"/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"}},"security":[],"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"}},"security":[],"tags":["OpenAPI"]}},"/orgs/{org_id}/app_bots":{"get":{"description":"Get a list of app bots authorized to an organization.","operationId":"getAppBots","parameters":[{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["app"],"type":"string"},"type":"array"},"style":"form"},{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get a list of app bots authorized to an organization.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"app_bots"},"/orgs/{org_id}/app_bots/{bot_id}":{"delete":{"description":"Revoke app bot authorization","operationId":"deleteAppBot","parameters":[{"description":"The ID of the app bot","in":"path","name":"bot_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"}],"responses":{"204":{"description":"The app bot has been deauthorized","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Revoke app bot authorization","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"app_bots"},"/orgs/{org_id}/apps":{"get":{"description":"Get a list of apps created by an organization.","operationId":"getApps","parameters":[{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get a list of apps created by an organization.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"post":{"description":"Create a new app for an organization.","operationId":"createApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostRequest"}}},"description":"app to be created"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Create a new app for an organization.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"apps"},"/orgs/{org_id}/apps/{client_id}":{"delete":{"description":"Delete an app by app id","operationId":"deleteApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/ClientId"}],"responses":{"204":{"description":"The app has been deleted","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Delete an app","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"get":{"description":"Get an App by client id","operationId":"getApp","parameters":[{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/ClientId"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData"},"jsonapi":{"$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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get an app by client id","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"patch":{"description":"Update app attributes","operationId":"updateApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/ClientId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPatchRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Update 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-api-resource":"apps"},"/orgs/{org_id}/apps/{client_id}/secrets":{"post":{"description":"Manage client secrets for an app.","operationId":"manageSecrets","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/ClientId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"mode":{"description":"Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n","enum":["replace","create","delete"],"type":"string"},"secret":{"description":"Secret to delete when using `delete` mode","type":"string"}},"required":["mode"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Secrets have been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Manage client secrets for an app.","tags":["Apps"],"x-snyk-api-releases":["2022-03-11"],"x-snyk-api-version":"2022-03-11"},"x-snyk-api-resource":"apps"},"/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/OrgInvitation"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A new organization invitation has been created","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Invite a user to an organization","tags":["Invites"],"x-snyk-api-releases":["2022-06-01","2023-04-28"],"x-snyk-api-version":"2023-04-28"},"x-snyk-api-resource":"org_invitations"},"/orgs/{org_id}/invites/{invite_id}":{"delete":{"description":"Cancel a pending user invitations to an organization.","operationId":"deleteOrgInvitation","parameters":[{"description":"The id of the org the user is being invited to","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the pending invite to cancel","in":"path","name":"invite_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Cancel a pending user invitations to an organization.","tags":["Invites"],"x-snyk-api-releases":["2022-11-14"],"x-snyk-api-version":"2022-11-14"},"x-snyk-api-resource":"org_invitations"},"/orgs/{org_id}/packages/issues":{"post":{"description":"This endpoint is not available to all customers. If you are interested please contact support. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned, transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.","operationId":"listIssuesForManyPurls","parameters":[{"$ref":"#/components/parameters/Version"},{"$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"],"x-snyk-api-version":"2023-04-17"},"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-04-04~experimental","2022-06-29~beta","2022-09-15"],"x-snyk-api-version":"2022-09-15"},"x-snyk-api-resource":"issues"},"/orgs/{org_id}/projects":{"get":{"description":"List all Projects for an Org.","operationId":"listOrgProjects","parameters":[{"description":"The ID of the org that the projects belong to.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Return projects that belong to the provided targets","in":"query","name":"target_id","schema":{"items":{"type":"string"},"type":"array"}},{"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 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":"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"}},{"$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"}},"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"],"x-snyk-api-version":"2023-02-15"},"x-snyk-api-resource":"projects"},"/orgs/{org_id}/projects/{project_id}":{"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"},{"$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"}},"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"],"x-snyk-api-version":"2023-02-15"},"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":"The ID of user initiating the action.","in":"query","name":"user_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"],"x-snyk-api-version":"2023-02-15"},"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"},{"$ref":"#/components/parameters/ProjectId"},{"$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"],"x-snyk-api-version":"2023-03-20"},"x-snyk-api-resource":"sboms","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},"/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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"Get a list of 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/{app_id}":{"delete":{"description":"Revoke access for an app by app id","operationId":"revokeUserInstalledApp","parameters":[{"$ref":"#/components/parameters/Version"},{"in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"}}],"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"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. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n","example":"2021-08-02T00:00:00Z","schema":{"format":"date-time","type":"string"}}}}},"summary":"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"}},"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":"An example of a v3 API resource","name":"Examples"},{"description":"Infrastructure as Code Settings.","name":"IacSettings"},{"description":"Organization Invites.","name":"Invites"},{"description":"Issues relevant to a particular package","name":"Issues"},{"description":"The OpenAPI specification for sbom-export.","name":"OpenAPI"},{"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":"A Software Bill of Materials document","name":"SBOM"}],"x-snyk-api-lifecycle":"released","x-snyk-api-version":"2023-04-28"} \ No newline at end of file