diff --git a/docs/.gitbook/assets/rest-spec.json b/docs/.gitbook/assets/rest-spec.json index 02db16cc9039..8ee393779c5b 100644 --- a/docs/.gitbook/assets/rest-spec.json +++ b/docs/.gitbook/assets/rest-spec.json @@ -256,6 +256,14 @@ "type": "string" } }, + "DeprecationHeader__0": { + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "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": { @@ -292,6 +300,14 @@ "type": "string" } }, + "RequestIdResponseHeader__0": { + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, "SunsetHeader": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", "example": "2021-08-02", @@ -300,6 +316,14 @@ "type": "string" } }, + "SunsetHeader__0": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", + "example": "2021-08-02", + "schema": { + "format": "date", + "type": "string" + } + }, "VersionRequestedResponseHeader": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", @@ -307,6 +331,15 @@ "$ref": "#/components/schemas/QueryVersion" } }, + "VersionRequestedResponseHeader__0": { + "description": "The version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, "VersionServedResponseHeader": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", @@ -314,6 +347,15 @@ "$ref": "#/components/schemas/ActualVersion" } }, + "VersionServedResponseHeader__0": { + "description": "The version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, "VersionStageResponseHeader": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { @@ -328,9 +370,37 @@ "example": "ga", "type": "string" } + }, + "VersionStageResponseHeader__0": { + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } } }, "parameters": { + "ApiVersion": { + "description": "The requested version of the endpoint to process the request", + "example": "2024-05-13~experimental", + "in": "query", + "name": "version", + "required": true, + "schema": { + "default": "2024-05-13~experimental", + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, "AppId": { "description": "App ID", "in": "path", @@ -400,6 +470,26 @@ "type": "string" } }, + "ConnectionTypeFilter": { + "description": "Filter the response by Users that match the provided connection type", + "in": "query", + "name": "connection_type", + "schema": { + "type": "string" + } + }, + "ContentSource": { + "description": "The source of educational resources", + "in": "query", + "name": "content_source", + "schema": { + "enum": [ + "source-preview", + "cache" + ], + "type": "string" + } + }, "CreatedAfter": { "description": "A filter to select issues created after this date.", "in": "query", @@ -473,6 +563,29 @@ "type": "string" } }, + "EnvironmentId": { + "description": "Unique identifier for an environment", + "example": "052781a7-17f6-494d-0000-25c8b509abcd", + "in": "path", + "name": "environment_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + "EnvironmentIdQuery": { + "description": "Filter resources by environment ID (multi-value, comma-separated)", + "example": "052781a7-17f6-494d-0000-25c8b509abcd", + "explode": false, + "in": "query", + "name": "environment_id", + "schema": { + "format": "uuid", + "type": "string" + }, + "style": "form" + }, "Events": { "description": "Filter logs by event types, cannot be used in conjunction with exclude_events parameter.", "in": "query", @@ -532,6 +645,27 @@ "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" + } + }, "Ignored": { "description": "Whether an issue is ignored or not.", "in": "query", @@ -598,6 +732,36 @@ "$ref": "#/components/schemas/Uuid" } }, + "JobId": { + "description": "Job ID", + "in": "path", + "name": "job_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + "Kind": { + "description": "Filter resources by kind (multi-value, comma-separated): cloud", + "example": "cloud", + "explode": false, + "in": "query", + "name": "kind", + "schema": { + "$ref": "#/components/schemas/ResourceKind" + }, + "style": "form" + }, + "KindInQuery": { + "description": "Filter environments by kind (multi-value, comma-separated): aws", + "example": "aws", + "in": "query", + "name": "kind", + "schema": { + "$ref": "#/components/schemas/EnvironmentKind" + } + }, "Limit": { "description": "Number of results to return per page", "example": 10, @@ -612,6 +776,17 @@ "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" + }, "MembershipId": { "description": "The ID of the Group Membership", "in": "path", @@ -622,6 +797,34 @@ "type": "string" } }, + "Name": { + "description": "Filter resources by name (multi-value, comma-separated)", + "example": "example-bucket", + "explode": false, + "in": "query", + "name": "name", + "schema": { + "type": "string" + }, + "style": "form" + }, + "NameFilter": { + "description": "Filter the response by Users that match the provided name", + "in": "query", + "name": "name", + "schema": { + "type": "string" + } + }, + "NameInQuery": { + "description": "Filter environments by name (multi-value, comma-separated)", + "example": "Demo AWS Environment", + "in": "query", + "name": "name", + "schema": { + "$ref": "#/components/schemas/EnvironmentName" + } + }, "Names": { "description": "The container registry names", "example": [ @@ -639,7 +842,42 @@ }, "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" + }, "OrgId": { + "description": "The ID of the org", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + "OrgIdFilter": { + "description": "The IDs of the org to filter by", + "explode": false, + "in": "query", + "name": "org_id", + "schema": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + "OrgId__0": { "description": "The id of the org", "in": "path", "name": "org_id", @@ -713,19 +951,20 @@ } }, "Platform": { - "description": "The image Operating System and processor architecture", - "example": "linux/amd64", + "description": "Filter resources by platform (multi-value, comma-separated): aws", + "example": "aws", + "explode": false, "in": "query", "name": "platform", "schema": { - "$ref": "#/components/schemas/Platform" - } + "type": "string" + }, + "style": "form" }, "ProjectId": { - "description": "Unique identifier for a project", - "in": "path", + "description": "The ID of the container project that the custom base image is based off of.", + "in": "query", "name": "project_id", - "required": true, "schema": { "format": "uuid", "type": "string" @@ -747,6 +986,17 @@ "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", @@ -755,6 +1005,28 @@ "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" + }, "RoleFilter": { "description": "Filter the response for results only with the specified role.", "in": "query", @@ -763,6 +1035,17 @@ "type": "string" } }, + "ScanId": { + "description": "Scan ID", + "example": "56465b1d-8764-458c-1234-0987abcd6543", + "in": "path", + "name": "scan_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, "ScanItemId": { "description": "A scan item id to filter issues through their scan item relationship.", "in": "query", @@ -798,6 +1081,21 @@ } }, "SortBy": { + "description": "Which column to sort by.", + "in": "query", + "name": "sort_by", + "schema": { + "enum": [ + "username", + "user_display_name", + "email", + "login_method", + "role" + ], + "type": "string" + } + }, + "SortBy__0": { "description": "Which column to sort by.", "in": "query", "name": "sort_by", @@ -826,6 +1124,20 @@ } }, "SortOrder": { + "description": "Order in which results are returned.", + "example": "ASC", + "in": "query", + "name": "sort_order", + "schema": { + "default": "ASC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + "SortOrder__0": { "description": "Order in which results are returned.", "example": "ASC", "in": "query", @@ -839,6 +1151,16 @@ "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=", @@ -865,6 +1187,22 @@ }, "style": "form" }, + "StatusInQuery": { + "description": "Filter environments by latest scan status (multi-value, comma-separated)", + "example": "error", + "in": "query", + "name": "status", + "schema": { + "enum": [ + "queued", + "in_progress", + "success", + "error", + "null" + ], + "type": "string" + } + }, "Tag": { "description": "The image tag", "in": "query", @@ -874,13 +1212,12 @@ } }, "TenantId": { - "description": "Tenant ID", + "description": "Unique identifier of the tenant.", "in": "path", "name": "tenant_id", "required": true, "schema": { - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/TenantId" } }, "To": { @@ -929,6 +1266,16 @@ "type": "string" } }, + "UserId20230130": { + "description": "The ID of the User", + "in": "path", + "name": "user_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, "UserIdFilter": { "description": "Filter the response by Users that match the provided user ID", "in": "query", @@ -937,6 +1284,14 @@ "type": "string" } }, + "UserIdSearchFilter": { + "description": "Filter the response by Users that match the provided user ID", + "in": "query", + "name": "user_id", + "schema": { + "$ref": "#/components/schemas/UserId" + } + }, "UsernameFilter": { "description": "Filter the response by Users that match the provided username", "in": "query", @@ -1010,6 +1365,36 @@ } } }, + "400__0": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/ErrorDocument__0" + } + } + }, + "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": { @@ -1040,6 +1425,36 @@ } } }, + "401__0": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/ErrorDocument__0" + } + } + }, + "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": { @@ -1100,6 +1515,36 @@ } } }, + "404__0": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/ErrorDocument__0" + } + } + }, + "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": { @@ -1160,6 +1605,36 @@ } } }, + "500__0": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/ErrorDocument__0" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, "GetIssue20020240123": { "content": { "application/vnd.api+json": { @@ -1185,7 +1660,7 @@ "description": "Returns an instance of an issue", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "$ref": "#/components/headers/DeprecationHeader__0" }, "location": { "description": "A header providing a URL for the location of a resource\n", @@ -1196,19 +1671,19 @@ } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "$ref": "#/components/headers/RequestIdResponseHeader__0" }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "$ref": "#/components/headers/VersionStageResponseHeader__0" }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "$ref": "#/components/headers/VersionRequestedResponseHeader__0" }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "$ref": "#/components/headers/VersionServedResponseHeader__0" }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "$ref": "#/components/headers/SunsetHeader__0" } } }, @@ -1254,27 +1729,66 @@ "description": "Returns a collection of issues.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "$ref": "#/components/headers/DeprecationHeader__0" }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "$ref": "#/components/headers/RequestIdResponseHeader__0" }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "$ref": "#/components/headers/VersionStageResponseHeader__0" }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "$ref": "#/components/headers/VersionRequestedResponseHeader__0" }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "$ref": "#/components/headers/VersionServedResponseHeader__0" }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "$ref": "#/components/headers/SunsetHeader__0" } } } }, "schemas": { + "AccessRequest": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/AccessRequestAttributes" + }, + "id": { + "description": "The Snyk ID of the access request.", + "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34", + "format": "uuid", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "AccessRequestAttributes": { + "additionalProperties": false, + "properties": { + "status": { + "enum": [ + "pending", + "expired" + ], + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + }, "AccessTokenTtlSeconds": { "description": "The access token time to live for your app, in seconds. It only affects the newly generated access tokens, existing access token will continue to have their previous time to live as expiration.", "example": 3600, @@ -1412,10 +1926,7 @@ "attributes": { "properties": { "client_id": { - "description": "The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.", - "example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf", - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/ClientId" }, "installed_at": { "$ref": "#/components/schemas/InstalledAt" @@ -1459,10 +1970,7 @@ "attributes": { "properties": { "client_id": { - "description": "The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.", - "example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf", - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/ClientId" }, "client_secret": { "$ref": "#/components/schemas/ClientSecret20240523" @@ -1658,12 +2166,7 @@ "$ref": "#/components/schemas/AccessTokenTtlSeconds" }, "context": { - "description": "Allow installing the app to at org/group level or user level. Defaults to tenant.", - "enum": [ - "tenant", - "user" - ], - "type": "string" + "$ref": "#/components/schemas/Context__0" }, "name": { "$ref": "#/components/schemas/AppName" @@ -1765,15 +2268,10 @@ "$ref": "#/components/schemas/AccessTokenTtlSeconds" }, "client_id": { - "$ref": "#/components/schemas/ClientId" + "$ref": "#/components/schemas/ClientId__0" }, "context": { - "description": "Allow installing the app to at org/group level or user level. Defaults to tenant.", - "enum": [ - "tenant", - "user" - ], - "type": "string" + "$ref": "#/components/schemas/Context__0" }, "grant_type": { "$ref": "#/components/schemas/GrantType" @@ -1815,10 +2313,7 @@ "$ref": "#/components/schemas/AccessTokenTtlSeconds" }, "client_id": { - "description": "The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.", - "example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf", - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/ClientId__1" }, "context": { "$ref": "#/components/schemas/Context" @@ -1865,18 +2360,13 @@ "$ref": "#/components/schemas/AccessTokenTtlSeconds" }, "client_id": { - "$ref": "#/components/schemas/ClientId" + "$ref": "#/components/schemas/ClientId__0" }, "client_secret": { "$ref": "#/components/schemas/ClientSecret" }, "context": { - "description": "Allow installing the app to at org/group level or user level. Defaults to tenant.", - "enum": [ - "tenant", - "user" - ], - "type": "string" + "$ref": "#/components/schemas/Context__0" }, "grant_type": { "$ref": "#/components/schemas/GrantType" @@ -1921,10 +2411,7 @@ "$ref": "#/components/schemas/AccessTokenTtlSeconds" }, "client_id": { - "description": "The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.", - "example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf", - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/ClientId__1" }, "client_secret": { "$ref": "#/components/schemas/ClientSecret" @@ -2012,50 +2499,6 @@ }, "type": "object" }, - "AutoDependencyUpgradeSettings": { - "additionalProperties": false, - "description": "Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Project's integration.", - "properties": { - "ignored_dependencies": { - "description": "Dependencies which should NOT be included in an automatic upgrade operation.", - "example": [ - "typescript" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "is_enabled": { - "description": "Automatically raise pull requests to update out-of-date dependencies.", - "example": true, - "type": "boolean" - }, - "is_inherited": { - "description": "Apply the auto dependency integration settings of the Organization to this project.", - "example": true, - "type": "boolean" - }, - "is_major_upgrade_enabled": { - "description": "Include major version in dependency upgrade recommendation.", - "example": true, - "type": "boolean" - }, - "limit": { - "description": "Limit of dependency upgrade PRs which can be opened simultaneously. When the limit is reached, no new upgrade PRs are created. If specified, must be between 1 and 10.", - "example": 10, - "maximum": 10, - "minimum": 1, - "type": "number" - }, - "minimum_age": { - "description": "Minimum dependency maturity period in days. If specified, must be between 1 and 365.", - "example": 365, - "type": "number" - } - }, - "type": "object" - }, "AutoDependencyUpgradeSettings20240531": { "additionalProperties": false, "description": "Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Organization's integration.", @@ -2095,9 +2538,9 @@ }, "type": "object" }, - "AutoRemediationPRsSettings": { + "AutoRemediationPRsSettings20240531": { "additionalProperties": false, - "description": "Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration.", + "description": "Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.", "properties": { "is_backlog_prs_enabled": { "description": "Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities.", @@ -2117,26 +2560,77 @@ }, "type": "object" }, - "AutoRemediationPRsSettings20240531": { + "AwsOptions": { "additionalProperties": false, - "description": "Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.", + "description": "Options for creating an AWS environment", + "example": { + "role_arn": "arn:aws:iam::12345678910:role/SnykCloud1234" + }, "properties": { - "is_backlog_prs_enabled": { - "description": "Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities.", - "example": true, - "type": "boolean" + "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 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" }, - "is_fresh_prs_enabled": { - "description": "Automatically create pull requests on scheduled tests for new vulnerabilities.", - "example": true, - "type": "boolean" + "tenant_id": { + "description": "Azure Tenant (directory) ID", + "example": "51627f08-8dd4-11ed-a1eb-0242ac120002", + "type": "string" + } + }, + "required": [ + "tenant_id", + "subscription_id" + ], + "type": "object" + }, + "AzureOptions__0": { + "additionalProperties": false, + "description": "Options for creating an Azure environment", + "example": { + "application_id": "1234d000-8dd4-11ed-a1eb-5678ac120002", + "subscription_id": "6884d000-8dd4-11ed-a1eb-0242ac120002", + "tenant_id": "51627f08-8dd4-11ed-a1eb-0242ac120002" + }, + "properties": { + "application_id": { + "description": "ID of the Azure app registration with permissions to scan", + "example": "1234d000-8dd4-11ed-a1eb-5678ac120002", + "type": "string" }, - "is_patch_remediation_enabled": { - "description": "Include vulnerability patches in automatic pull requests.", - "example": true, - "type": "boolean" + "subscription_id": { + "description": "ID of the Azure subscription to be scanned", + "example": "6884d000-8dd4-11ed-a1eb-0242ac120002", + "type": "string" + }, + "tenant_id": { + "description": "Azure Tenant (directory) ID", + "example": "51627f08-8dd4-11ed-a1eb-0242ac120002", + "type": "string" } }, + "required": [ + "tenant_id", + "subscription_id" + ], "type": "object" }, "BulkPackageUrlsRequestBody": { @@ -2220,11 +2714,23 @@ "type": "string" }, "ClientId": { + "description": "The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.", + "example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf", + "format": "uuid", + "type": "string" + }, + "ClientId__0": { "description": "The oauth2 client id for the app.", "example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf", "format": "uuid", "type": "string" }, + "ClientId__1": { + "description": "The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.", + "example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf", + "format": "uuid", + "type": "string" + }, "ClientSecret": { "description": "The oauth2 client secret for the app. This is the only time this secret will be returned, store it securely and don’t lose it.", "example": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht\u003c]S_v1", @@ -2240,114 +2746,10 @@ "CloudResource": { "properties": { "environment": { - "properties": { - "id": { - "description": "Internal ID for an environment.", - "format": "uuid", - "type": "string" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "native_id": { - "description": "An optional native identifier for this environment. For example, a cloud account id.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "type": { - "enum": [ - "aws", - "azure", - "azure_ad", - "google", - "scm", - "cli", - "tfc" - ], - "type": "string" - } - }, - "required": [ - "id", - "type", - "name" - ], - "type": "object" + "$ref": "#/components/schemas/Environment" }, "resource": { - "properties": { - "iac_mappings_count": { - "description": "Amount of IaC resources this resource maps to.", - "format": "int64", - "minimum": 0, - "type": "integer" - }, - "id": { - "description": "Internal ID for a resource.", - "format": "uuid", - "type": "string" - }, - "input_type": { - "enum": [ - "cloud_scan", - "arm", - "k8s", - "tf", - "tf_hcl", - "tf_plan", - "tf_state", - "cfn" - ], - "type": "string" - }, - "location": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "native_id": { - "description": "An optional native identifier for this resource. For example, a cloud resource id.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "platform": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "resource_type": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "tags": { - "additionalProperties": { - "maxLength": 256, - "type": "string" - }, - "type": "object" - }, - "type": { - "enum": [ - "cloud", - "iac" - ], - "type": "string" - } - }, - "required": [ - "input_type" - ], - "type": "object" + "$ref": "#/components/schemas/Resource" } }, "required": [ @@ -2511,7 +2913,98 @@ "properties": { "coordinates": { "items": { - "$ref": "#/components/schemas/Coordinate" + "properties": { + "remedies": { + "items": { + "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" + }, + "type": "array" + }, + "representations": { + "description": "The affected versions of this vulnerability.", + "items": { + "anyOf": [ + { + "description": "An object that contains an opaque identifying string.", + "properties": { + "resource_path": { + "example": ",5.4.0),[6.0.0.pr1,6.4.0)", + "maxLength": 2024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "resource_path" + ], + "type": "object" + }, + { + "properties": { + "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" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "type": "array" + } + }, + "required": [ + "representations" + ], + "type": "object" }, "type": "array" }, @@ -2538,7 +3031,47 @@ }, "problems": { "items": { - "$ref": "#/components/schemas/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" }, "type": "array" }, @@ -2604,32 +3137,106 @@ ], "type": "string" }, + "Context__0": { + "description": "Allow installing the app to at org/group level or user level. Defaults to tenant.", + "enum": [ + "tenant", + "user" + ], + "type": "string" + }, "Coordinate": { "properties": { + "is_fixable_manually": { + "type": "boolean" + }, + "is_fixable_snyk": { + "type": "boolean" + }, + "is_fixable_upstream": { + "type": "boolean" + }, + "is_patchable": { + "type": "boolean" + }, + "is_pinnable": { + "type": "boolean" + }, + "is_upgradeable": { + "type": "boolean" + }, + "reachability": { + "type": "string" + }, "remedies": { "items": { "$ref": "#/components/schemas/Remedy" }, + "maxItems": 5, + "minItems": 1, "type": "array" }, "representations": { - "description": "The affected versions of this vulnerability.", + "description": "A list of precise locations that surface an issue. A coordinate may have multiple representations.\n", "items": { - "anyOf": [ + "oneOf": [ + { + "description": "An object that contains an opaque identifying string.", + "properties": { + "resourcePath": { + "maxLength": 2024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "resourcePath" + ], + "type": "object" + }, + { + "description": "An object that contains a list of opaque identifying strings.", + "properties": { + "dependency": { + "$ref": "#/components/schemas/Dependency" + } + }, + "required": [ + "dependency" + ], + "type": "object" + }, { - "$ref": "#/components/schemas/ResourcePathRepresentation" + "description": "A resource location to some service, like a cloud resource.", + "properties": { + "cloud_resource": { + "$ref": "#/components/schemas/CloudResource" + } + }, + "required": [ + "cloud_resource" + ], + "type": "object" }, { - "$ref": "#/components/schemas/PackageRepresentation" + "description": "A location within a file.", + "properties": { + "sourceLocation": { + "$ref": "#/components/schemas/SourceLocation" + } + }, + "required": [ + "sourceLocation" + ], + "type": "object" } ] }, + "maxItems": 5, + "minItems": 1, "type": "array" } }, - "required": [ - "representations" - ], "type": "object" }, "CreateCollectionRequest": { @@ -2869,6 +3476,38 @@ }, "type": "object" }, + "CreatePermissionsAttributes": { + "example": { + "platform": "aws", + "type": "cf" + }, + "properties": { + "options": { + "anyOf": [ + { + "$ref": "#/components/schemas/AzureOptions" + } + ] + }, + "platform": { + "$ref": "#/components/schemas/PlatformType" + }, + "type": { + "$ref": "#/components/schemas/PermissionType" + } + }, + "required": [ + "type", + "platform" + ], + "type": "object" + }, + "CreatedAt": { + "description": "The time at which the resource was created.", + "example": "2022-03-16T00:00:00Z", + "format": "date-time", + "type": "string" + }, "CustomBaseImageAttributes": { "additionalProperties": false, "properties": { @@ -3065,6 +3704,36 @@ }, "type": "object" }, + "DeleteAssignmentsRequest": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "lesson_assignment" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "DeleteProjectsFromCollectionRequest": { "additionalProperties": false, "properties": { @@ -3148,6 +3817,76 @@ ], "type": "object" }, + "EducationResource": { + "properties": { + "attributes": { + "properties": { + "author": { + "type": "string" + }, + "date_published": { + "format": "date", + "type": "string" + }, + "description": { + "type": "string" + }, + "education_content_category": { + "enum": [ + "security education", + "product training" + ], + "type": "string" + }, + "image": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "tags": { + "items": { + "$ref": "#/components/schemas/Tag" + }, + "type": "array" + }, + "url": { + "type": "string" + } + }, + "required": [ + "name", + "description", + "url", + "slug", + "image", + "education_content_category", + "tags" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "lesson", + "learning_path" + ], + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, "Environment": { "properties": { "id": { @@ -3167,16 +3906,7 @@ "type": "string" }, "type": { - "enum": [ - "aws", - "azure", - "azure_ad", - "google", - "scm", - "cli", - "tfc" - ], - "type": "string" + "$ref": "#/components/schemas/EnvironmentTypeDef" } }, "required": [ @@ -3186,6 +3916,147 @@ ], "type": "object" }, + "EnvironmentAttributes": { + "description": "Environment attributes", + "example": { + "created_at": "2022-05-06T12:25:15-04:00", + "kind": "aws", + "name": "Demo AWS Environment", + "native_id": "12345678910", + "options": { + "role_arn": "arn:aws:iam::123456789012:role/SnykCloud1234" + }, + "properties": { + "account_id": "123456789012" + }, + "revision": 1, + "status": "success", + "updated_at": "2022-05-06T12:25:15-04:00" + }, + "properties": { + "created_at": { + "description": "When the environment was created", + "example": "2022-05-06T12:25:15-04:00", + "format": "date-time", + "type": "string" + }, + "deleted_at": { + "format": "date-time", + "nullable": true, + "type": "string" + }, + "kind": { + "$ref": "#/components/schemas/EnvironmentKind" + }, + "name": { + "$ref": "#/components/schemas/EnvironmentName" + }, + "options": { + "type": "object" + }, + "properties": { + "type": "object" + }, + "revision": { + "description": "Increment for each change to an environment", + "example": 1, + "type": "integer" + }, + "updated_at": { + "description": "When the environment was last updated", + "example": "2022-05-07T12:25:15-04:00", + "format": "date-time", + "nullable": true, + "type": "string" + } + }, + "required": [ + "kind", + "name", + "created_at" + ], + "type": "object" + }, + "EnvironmentCreateAttributes": { + "example": { + "kind": "aws", + "options": { + "role_arn": "arn:aws:iam::336447867772:role/SnykCloud1234" + } + }, + "properties": { + "kind": { + "$ref": "#/components/schemas/EnvironmentKind" + }, + "name": { + "$ref": "#/components/schemas/EnvironmentName" + }, + "options": { + "$ref": "#/components/schemas/EnvironmentOptions" + } + }, + "required": [ + "kind", + "options" + ], + "type": "object" + }, + "EnvironmentKind": { + "description": "Environment kind: aws", + "enum": [ + "aws", + "google", + "azure", + "scm", + "tfc", + "cli" + ], + "type": "string" + }, + "EnvironmentName": { + "description": "Environment name", + "example": "Demo AWS Environment", + "type": "string" + }, + "EnvironmentOptions": { + "oneOf": [ + { + "$ref": "#/components/schemas/AwsOptions" + }, + { + "$ref": "#/components/schemas/GoogleOptions" + }, + { + "$ref": "#/components/schemas/AzureOptions__0" + } + ] + }, + "EnvironmentRelationships": { + "additionalProperties": true, + "description": "Environment relationships", + "example": { + "organization": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "organization" + }, + "links": { + "related": "/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..." + } + }, + "project": { + "data": { + "id": "11111111-1111-11111-1111-111111111111", + "type": "project" + } + } + }, + "type": "object" + }, + "EnvironmentType": { + "example": "environment", + "type": "string" + }, "EnvironmentTypeDef": { "enum": [ "aws", @@ -3198,6 +4069,26 @@ ], "type": "string" }, + "EnvironmentUpdateAttributes": { + "description": "Environment update attributes. Only the AWS role ARN can be updated; new ARN must have the same account ID as the old ARN.", + "example": { + "options": { + "role_arn": "arn:aws:iam::123456789012:role/SnykCloud1234" + } + }, + "properties": { + "name": { + "$ref": "#/components/schemas/EnvironmentName" + }, + "options": { + "$ref": "#/components/schemas/EnvironmentOptions" + } + }, + "required": [ + "options" + ], + "type": "object" + }, "Error": { "additionalProperties": false, "example": { @@ -3305,6 +4196,43 @@ ], "type": "object" }, + "ErrorDocument__0": { + "additionalProperties": false, + "example": { + "errors": [ + { + "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__0" + }, + "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.", @@ -3318,6 +4246,76 @@ }, "type": "object" }, + "Error__0": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "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" + }, "ExploitDetails": { "description": "Details about the exploits", "properties": { @@ -3395,6 +4393,39 @@ }, "type": "object" }, + "GoogleOptions": { + "additionalProperties": false, + "description": "Options for creating a Google environment", + "example": { + "identity_provider": "https://iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/snyk-workload-identity-123/providers/snyk-identity-provider-123", + "project_id": "demo-project", + "service_account_email": "snyk-demo@demo-project.iam.gserviceaccount.com" + }, + "properties": { + "identity_provider": { + "description": "The full resource name of the workload identity provider", + "example": "https://iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/snyk-workload-identity-123/providers/snyk-identity-provider-123", + "format": "uri", + "type": "string" + }, + "project_id": { + "description": "Google project ID", + "example": "demo-project", + "type": "string" + }, + "service_account_email": { + "description": "Google service account email", + "example": "snyk-demo@demo-project.iam.gserviceaccount.com", + "format": "email", + "type": "string" + } + }, + "required": [ + "service_account_email", + "identity_provider" + ], + "type": "object" + }, "GrantType": { "description": "An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token. The grant type represents the way your app will get the access token.", "enum": [ @@ -3411,6 +4442,44 @@ ], "type": "string" }, + "Group": { + "additionalProperties": true, + "properties": { + "attributes": { + "$ref": "#/components/schemas/GroupAttributes" + }, + "id": { + "example": "331ede0a-de94-456f-b788-166caeca58bf", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Content type.", + "example": "group", + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "GroupAttributes": { + "additionalProperties": true, + "properties": { + "name": { + "description": "The name of the group.", + "example": "My Group", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, "GroupIacSettingsRequest": { "description": "The Infrastructure as Code settings for a group.", "properties": { @@ -3488,6 +4557,11 @@ }, "type": "object" }, + "GroupId": { + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + }, "GroupMembership": { "additionalProperties": false, "properties": { @@ -3904,7 +4978,141 @@ }, "type": "object" }, + "GroupRelationships": { + "properties": { + "tenant": { + "properties": { + "data": { + "properties": { + "id": { + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "GroupResponse": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "example": { + "name": "My Group" + }, + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "$ref": "#/components/schemas/GroupId" + }, + "relationships": { + "$ref": "#/components/schemas/GroupRelationships" + }, + "type": { + "$ref": "#/components/schemas/GroupType" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "required": [ + "data", + "jsonapi", + "links" + ], + "type": "object" + }, + "GroupType": { + "description": "The type of the resource for group operations", + "enum": [ + "group" + ], + "type": "string" + }, "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" + }, + "HelloWorld__0": { "additionalProperties": false, "properties": { "attributes": { @@ -4155,338 +5363,7 @@ "coordinates": { "description": "Where the issue originated, specific to issue type. Details on what\ncode, package, etc introduced the issue. An issue may be caused by\nmore than one coordinate.\n", "items": { - "properties": { - "is_fixable_manually": { - "type": "boolean" - }, - "is_fixable_snyk": { - "type": "boolean" - }, - "is_fixable_upstream": { - "type": "boolean" - }, - "is_patchable": { - "type": "boolean" - }, - "is_pinnable": { - "type": "boolean" - }, - "is_upgradeable": { - "type": "boolean" - }, - "reachability": { - "type": "string" - }, - "remedies": { - "items": { - "additionalProperties": false, - "properties": { - "correlation_id": { - "description": "An optional identifier for correlating remedies between coordinates or across issues. They are scoped\nto a single Project and test run. Remedies with the same correlation_id must have the same contents.\n", - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "description": { - "description": "A markdown-formatted optional description of this remedy. Links are not permitted.", - "maxLength": 4096, - "minLength": 1, - "type": "string" - }, - "meta": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": true, - "description": "Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.", - "type": "object" - }, - "schema_version": { - "description": "A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n", - "maxLength": 256, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "data", - "schema_version" - ], - "type": "object" - }, - "type": { - "enum": [ - "indeterminate", - "manual", - "automated", - "rule_result_message", - "terraform", - "cloudformation", - "cli", - "kubernetes", - "arm" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "representations": { - "description": "A list of precise locations that surface an issue. A coordinate may have multiple representations.\n", - "items": { - "oneOf": [ - { - "description": "An object that contains an opaque identifying string.", - "properties": { - "resourcePath": { - "maxLength": 2024, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "resourcePath" - ], - "type": "object" - }, - { - "description": "An object that contains a list of opaque identifying strings.", - "properties": { - "dependency": { - "properties": { - "package_name": { - "description": "The package name the issue was found in", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "package_version": { - "description": "The package version the issue was found in", - "maxLength": 2048, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "package_name", - "package_version" - ], - "type": "object" - } - }, - "required": [ - "dependency" - ], - "type": "object" - }, - { - "description": "A resource location to some service, like a cloud resource.", - "properties": { - "cloud_resource": { - "properties": { - "environment": { - "properties": { - "id": { - "description": "Internal ID for an environment.", - "format": "uuid", - "type": "string" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "native_id": { - "description": "An optional native identifier for this environment. For example, a cloud account id.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "type": { - "enum": [ - "aws", - "azure", - "azure_ad", - "google", - "scm", - "cli", - "tfc" - ], - "type": "string" - } - }, - "required": [ - "id", - "type", - "name" - ], - "type": "object" - }, - "resource": { - "properties": { - "iac_mappings_count": { - "description": "Amount of IaC resources this resource maps to.", - "format": "int64", - "minimum": 0, - "type": "integer" - }, - "id": { - "description": "Internal ID for a resource.", - "format": "uuid", - "type": "string" - }, - "input_type": { - "enum": [ - "cloud_scan", - "arm", - "k8s", - "tf", - "tf_hcl", - "tf_plan", - "tf_state", - "cfn" - ], - "type": "string" - }, - "location": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "native_id": { - "description": "An optional native identifier for this resource. For example, a cloud resource id.", - "maxLength": 2048, - "minLength": 1, - "type": "string" - }, - "platform": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "resource_type": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "tags": { - "additionalProperties": { - "maxLength": 256, - "type": "string" - }, - "type": "object" - }, - "type": { - "enum": [ - "cloud", - "iac" - ], - "type": "string" - } - }, - "required": [ - "input_type" - ], - "type": "object" - } - }, - "required": [ - "environment" - ], - "type": "object" - } - }, - "required": [ - "cloud_resource" - ], - "type": "object" - }, - { - "description": "A location within a file.", - "properties": { - "sourceLocation": { - "properties": { - "file": { - "description": "A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n", - "maximum": 2048, - "minimum": 1, - "type": "string" - }, - "region": { - "properties": { - "end": { - "properties": { - "column": { - "minimum": 0, - "type": "integer" - }, - "line": { - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "line", - "column" - ], - "type": "object" - }, - "start": { - "properties": { - "column": { - "minimum": 0, - "type": "integer" - }, - "line": { - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "line", - "column" - ], - "type": "object" - } - }, - "required": [ - "start", - "end" - ], - "type": "object" - } - }, - "required": [ - "file" - ], - "type": "object" - } - }, - "required": [ - "sourceLocation" - ], - "type": "object" - } - ] - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - } - }, - "type": "object" + "$ref": "#/components/schemas/Coordinate" }, "minItems": 1, "type": "array" @@ -4527,60 +5404,7 @@ "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" + "$ref": "#/components/schemas/Problem" }, "maxItems": 10, "minItems": 1, @@ -4895,6 +5719,108 @@ }, "type": "object" }, + "LessonAssignmentCreationAttributes": { + "properties": { + "due_date": { + "format": "date", + "type": "string" + }, + "lesson_id": { + "type": "string" + }, + "user_id": { + "format": "uuid", + "type": "string" + } + }, + "required": [ + "user_id", + "lesson_id" + ], + "type": "object" + }, + "LessonAssignmentDecoratedAttributes": { + "allOf": [ + { + "$ref": "#/components/schemas/LessonAssignmentRecordAttributes" + }, + { + "properties": { + "assigning_user_email": { + "type": "string" + }, + "lesson_title": { + "type": "string" + }, + "user_email": { + "format": "email", + "type": "string" + } + }, + "required": [ + "user_email", + "lesson_title" + ], + "type": "object" + } + ] + }, + "LessonAssignmentDecoratedResource": { + "properties": { + "attributes": { + "$ref": "#/components/schemas/LessonAssignmentDecoratedAttributes" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "lesson_assignment" + ], + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "LessonAssignmentRecordAttributes": { + "allOf": [ + { + "$ref": "#/components/schemas/LessonAssignmentCreationAttributes" + }, + { + "properties": { + "assigning_user_id": { + "format": "uuid", + "type": "string" + }, + "completed_date": { + "format": "date-time", + "type": "string" + }, + "created_at": { + "format": "date-time", + "type": "string" + }, + "updated_at": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "created_at", + "updated_at", + "assigning_user_id" + ], + "type": "object" + } + ] + }, "LinkProperty": { "example": "https://example.com/api/resource", "oneOf": [ @@ -4949,17 +5875,12 @@ }, "type": "object" }, - "ManualRemediationPRsSettings": { + "ListTenantMembershipResponseData": { "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" - } + "items": { + "$ref": "#/components/schemas/TenantMembershipResponseDataObject" }, - "type": "object" + "type": "array" }, "ManualRemediationPRsSettings20240531": { "additionalProperties": false, @@ -5142,7 +6063,60 @@ "additionalProperties": false, "properties": { "attributes": { - "$ref": "#/components/schemas/OrgAttributes" + "additionalProperties": false, + "properties": { + "group_id": { + "description": "The ID of a Group.", + "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34", + "format": "uuid", + "type": "string" + }, + "is_personal": { + "description": "Whether this organization belongs to an individual, rather than a Group.", + "example": true, + "type": "boolean" + }, + "name": { + "description": "Friendly name of the organization.", + "example": "My Org", + "type": "string" + }, + "slug": { + "description": "Unique URL sanitized name of the organization for accessing it in Snyk.", + "example": "my-org", + "type": "string" + } + }, + "required": [ + "name", + "slug", + "is_personal" + ], + "type": "object" + }, + "id": { + "description": "The Snyk ID corresponding to this org", + "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Content type.", + "example": "org", + "type": "string" + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "Org20230529": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/OrgAttributes20230529" }, "id": { "description": "The Snyk ID of the organization.", @@ -5210,6 +6184,50 @@ ], "type": "object" }, + "OrgAttributes20230529": { + "additionalProperties": false, + "properties": { + "created_at": { + "description": "The time the organization was created.", + "example": "2022-03-16T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "group_id": { + "description": "The Snyk ID of the group to which the organization belongs.", + "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34", + "format": "uuid", + "type": "string" + }, + "is_personal": { + "description": "Whether the organization is independent (that is, not part of a group).", + "example": true, + "type": "boolean" + }, + "name": { + "description": "The display name of the organization.", + "example": "My Org", + "type": "string" + }, + "slug": { + "description": "The canonical (unique and URL-friendly) name of the organization.", + "example": "my-org", + "type": "string" + }, + "updated_at": { + "description": "The time the organization was last modified.", + "example": "2022-03-16T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "name", + "slug", + "is_personal" + ], + "type": "object" + }, "OrgIacSettingsRequest": { "description": "The Infrastructure as Code settings for an org.", "properties": { @@ -5352,38 +6370,6 @@ ], "type": "object" }, - "OrgInvitation20230828": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/OrgInvitationAttributes20230428" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "relationships": { - "properties": { - "org": { - "$ref": "#/components/schemas/Relationship" - } - }, - "type": "object" - }, - "type": { - "enum": [ - "org_invitation" - ], - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - }, "OrgInvitation20240621": { "additionalProperties": false, "properties": { @@ -5442,33 +6428,6 @@ ], "type": "object" }, - "OrgInvitationAttributes20230428": { - "additionalProperties": false, - "properties": { - "email": { - "description": "The email address of the invitee.", - "example": "example@email.com", - "type": "string" - }, - "is_active": { - "description": "The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n", - "example": true, - "type": "boolean" - }, - "role": { - "description": "The role public ID that will be granted to to invitee on acceptance.", - "example": "f1968726-1dca-42d4-a4dc-80cab99e2b6c", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "email", - "is_active", - "role" - ], - "type": "object" - }, "OrgInvitationAttributes20230828": { "additionalProperties": false, "properties": { @@ -5535,33 +6494,6 @@ ], "type": "object" }, - "OrgInvitationPostData20230428": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/OrgInvitationPostAttributes" - }, - "relationships": { - "properties": { - "org": { - "$ref": "#/components/schemas/Relationship" - } - }, - "type": "object" - }, - "type": { - "enum": [ - "org_invitation" - ], - "type": "string" - } - }, - "required": [ - "type", - "attributes" - ], - "type": "object" - }, "OrgMembership": { "additionalProperties": false, "properties": { @@ -5921,7 +6853,34 @@ "PackageRepresentation": { "properties": { "package": { - "$ref": "#/components/schemas/PackageMeta" + "properties": { + "name": { + "description": "The package’s name", + "example": "spring-core", + "type": "string" + }, + "namespace": { + "description": "A name prefix, such as a maven group id or docker image owner", + "example": "org.springframework", + "type": "string" + }, + "type": { + "description": "The package type or protocol", + "example": "maven", + "type": "string" + }, + "url": { + "description": "The purl of the package", + "example": "pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0", + "type": "string" + }, + "version": { + "description": "The version of the package", + "example": "1.0.0", + "type": "string" + } + }, + "type": "object" } }, "type": "object" @@ -6107,6 +7066,29 @@ ], "type": "object" }, + "PermissionType": { + "enum": [ + "cf", + "tf", + "bash" + ], + "type": "string" + }, + "PermissionsAttributes": { + "properties": { + "data": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PermissionType" + } + }, + "required": [ + "data", + "type" + ], + "type": "object" + }, "Platform": { "enum": [ "aix/ppc64", @@ -6187,6 +7169,14 @@ "example": "linux/amd64", "type": "string" }, + "PlatformType": { + "enum": [ + "aws", + "azure", + "google" + ], + "type": "string" + }, "Principal20240422": { "additionalProperties": false, "properties": { @@ -6227,6 +7217,12 @@ "type": "object" }, "Problem": { + "additionalProperties": false, + "example": { + "id": "SNYK-DEBIAN8-CURL-358558", + "source": "snyk", + "type": "rule" + }, "properties": { "disclosed_at": { "description": "When this problem was disclosed to the public.", @@ -6239,7 +7235,6 @@ "type": "string" }, "id": { - "example": "CWE-61", "maxLength": 1024, "minLength": 1, "type": "string" @@ -6250,6 +7245,9 @@ "minLength": 1, "type": "string" }, + "type": { + "$ref": "#/components/schemas/ProblemTypeDef" + }, "updated_at": { "description": "When this problem was last updated.", "format": "date-time", @@ -6265,6 +7263,7 @@ }, "required": [ "id", + "type", "source" ], "type": "object" @@ -6429,312 +7428,6 @@ ], "type": "object" }, - "ProjectAttributes20230215": { - "additionalProperties": false, - "properties": { - "build_args": { - "oneOf": [ - { - "$ref": "#/components/schemas/YarnBuildArgs" - }, - { - "$ref": "#/components/schemas/ContainerBuildArgs" - }, - { - "$ref": "#/components/schemas/NugetBuildArgs" - } - ] - }, - "business_criticality": { - "example": [ - "medium" - ], - "items": { - "enum": [ - "critical", - "high", - "medium", - "low" - ], - "type": "string" - }, - "type": "array" - }, - "created": { - "description": "The date that the project was created on", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "type": "string" - }, - "environment": { - "example": [ - "external", - "hosted" - ], - "items": { - "enum": [ - "frontend", - "backend", - "internal", - "external", - "mobile", - "saas", - "onprem", - "hosted", - "distributed" - ], - "type": "string" - }, - "type": "array" - }, - "lifecycle": { - "example": [ - "production" - ], - "items": { - "enum": [ - "production", - "development", - "sandbox" - ], - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Project name.", - "example": "snyk/goof", - "type": "string" - }, - "origin": { - "description": "The origin the project was added from.", - "example": "github", - "type": "string" - }, - "read_only": { - "description": "Whether the project is read-only", - "type": "boolean" - }, - "settings": { - "$ref": "#/components/schemas/ProjectSettings" - }, - "status": { - "description": "Describes if a project is currently monitored or it is de-activated.", - "enum": [ - "active", - "inactive" - ], - "example": "active", - "type": "string" - }, - "tags": { - "example": [ - { - "key": "tag-key", - "value": "tag-value" - } - ], - "items": { - "properties": { - "key": { - "example": "tag-key", - "type": "string" - }, - "value": { - "example": "tag-value", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "target_file": { - "description": "Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.", - "example": "package.json", - "type": "string" - }, - "target_reference": { - "description": "The additional information required to resolve which revision of the resource should be scanned.", - "example": "main", - "type": "string" - }, - "target_runtime": { - "description": "Dotnet Target, for relevant projects", - "type": "string" - }, - "type": { - "description": "The package manager of the project.", - "example": "maven", - "type": "string" - } - }, - "required": [ - "name", - "type", - "target_file", - "target_reference", - "origin", - "created", - "status", - "read_only", - "settings" - ], - "type": "object" - }, - "ProjectAttributes20230828": { - "additionalProperties": false, - "properties": { - "build_args": { - "oneOf": [ - { - "$ref": "#/components/schemas/YarnBuildArgs" - }, - { - "$ref": "#/components/schemas/ContainerBuildArgs" - }, - { - "$ref": "#/components/schemas/NugetBuildArgs" - } - ] - }, - "business_criticality": { - "example": [ - "medium" - ], - "items": { - "enum": [ - "critical", - "high", - "medium", - "low" - ], - "type": "string" - }, - "type": "array" - }, - "created": { - "description": "The date that the project was created on", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "type": "string" - }, - "environment": { - "example": [ - "external", - "hosted" - ], - "items": { - "enum": [ - "frontend", - "backend", - "internal", - "external", - "mobile", - "saas", - "onprem", - "hosted", - "distributed" - ], - "type": "string" - }, - "type": "array" - }, - "lifecycle": { - "example": [ - "production" - ], - "items": { - "enum": [ - "production", - "development", - "sandbox" - ], - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Project name.", - "example": "snyk/goof", - "type": "string" - }, - "origin": { - "description": "The origin the project was added from.", - "example": "github", - "type": "string" - }, - "read_only": { - "description": "Whether the project is read-only", - "type": "boolean" - }, - "settings": { - "$ref": "#/components/schemas/ProjectSettings" - }, - "status": { - "description": "Describes if a project is currently monitored or it is de-activated.", - "enum": [ - "active", - "inactive" - ], - "example": "active", - "type": "string" - }, - "tags": { - "example": [ - { - "key": "tag-key", - "value": "tag-value" - } - ], - "items": { - "properties": { - "key": { - "example": "tag-key", - "type": "string" - }, - "value": { - "example": "tag-value", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "target_file": { - "description": "Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.", - "example": "package.json", - "type": "string" - }, - "target_reference": { - "description": "The additional information required to resolve which revision of the resource should be scanned.", - "example": "main", - "type": "string" - }, - "target_runtime": { - "description": "Dotnet Target, for relevant projects", - "type": "string" - }, - "type": { - "description": "The package manager of the project.", - "example": "maven", - "type": "string" - } - }, - "required": [ - "name", - "type", - "target_file", - "target_reference", - "origin", - "created", - "status", - "read_only", - "settings" - ], - "type": "object" - }, "ProjectMeta": { "additionalProperties": false, "properties": { @@ -6858,7 +7551,7 @@ "$ref": "#/components/schemas/Relationship" }, { - "$ref": "#/components/schemas/ProjectRelationshipsTarget20230215" + "$ref": "#/components/schemas/ProjectRelationshipsTarget" } ] } @@ -6928,152 +7621,6 @@ ], "type": "object" }, - "ProjectRelationshipsTarget20230215": { - "additionalProperties": false, - "properties": { - "data": { - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "display_name": { - "description": "The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n", - "example": "snyk-fixtures/goof", - "type": "string" - }, - "url": { - "description": "The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n", - "example": "http://github.com/snyk/local-goof", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The Resource ID.", - "format": "uuid", - "type": "string" - }, - "meta": { - "properties": { - "integration_data": { - "description": "A collection of properties regarding integration data", - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "The Resource type.", - "example": "target", - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - }, - "links": { - "$ref": "#/components/schemas/RelatedLink" - } - }, - "required": [ - "data", - "links" - ], - "type": "object" - }, - "ProjectRelationshipsTarget20230911": { - "additionalProperties": false, - "properties": { - "data": { - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "display_name": { - "description": "The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n", - "example": "snyk-fixtures/goof", - "type": "string" - }, - "url": { - "description": "The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n", - "example": "http://github.com/snyk/local-goof", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The Resource ID.", - "format": "uuid", - "type": "string" - }, - "meta": { - "properties": { - "integration_data": { - "description": "A collection of properties regarding integration data", - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "The Resource type.", - "example": "target", - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - }, - "links": { - "$ref": "#/components/schemas/RelatedLink" - } - }, - "required": [ - "data", - "links" - ], - "type": "object" - }, - "ProjectSettings": { - "additionalProperties": false, - "properties": { - "auto_dependency_upgrade": { - "$ref": "#/components/schemas/AutoDependencyUpgradeSettings" - }, - "auto_remediation_prs": { - "$ref": "#/components/schemas/AutoRemediationPRsSettings" - }, - "manual_remediation_prs": { - "$ref": "#/components/schemas/ManualRemediationPRsSettings" - }, - "pull_request_assignment": { - "$ref": "#/components/schemas/PullRequestAssignmentSettings" - }, - "pull_requests": { - "$ref": "#/components/schemas/PullRequestsSettings" - }, - "recurring_tests": { - "$ref": "#/components/schemas/RecurringTestsSettings" - } - }, - "required": [ - "recurring_tests", - "pull_requests" - ], - "type": "object" - }, "ProjectSettings20240531": { "additionalProperties": false, "properties": { @@ -7190,7 +7737,7 @@ "additionalProperties": false, "properties": { "attributes": { - "$ref": "#/components/schemas/PublicAppAttributes" + "$ref": "#/components/schemas/PublicAppAttributes__0" }, "id": { "$ref": "#/components/schemas/Id" @@ -7209,9 +7756,31 @@ "type": "object" }, "PublicAppAttributes": { + "additionalProperties": false, "properties": { "client_id": { - "$ref": "#/components/schemas/ClientId" + "$ref": "#/components/schemas/Uuid" + }, + "context": { + "$ref": "#/components/schemas/Context" + }, + "name": { + "$ref": "#/components/schemas/AppName" + }, + "scopes": { + "$ref": "#/components/schemas/Scopes" + } + }, + "required": [ + "name", + "client_id" + ], + "type": "object" + }, + "PublicAppAttributes__0": { + "properties": { + "client_id": { + "$ref": "#/components/schemas/ClientId__0" }, "context": { "$ref": "#/components/schemas/Context" @@ -7233,41 +7802,7 @@ "additionalProperties": false, "properties": { "attributes": { - "additionalProperties": false, - "properties": { - "client_id": { - "format": "uuid", - "type": "string" - }, - "context": { - "description": "Allow installing the app to a org/group or to a user, default tenant.", - "enum": [ - "tenant", - "user" - ], - "type": "string" - }, - "name": { - "description": "New name of the app to display to users during authorization flow.", - "example": "My App", - "minLength": 1, - "type": "string" - }, - "scopes": { - "description": "The scopes this app is allowed to request during authorization.", - "items": { - "minLength": 1, - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "name", - "client_id" - ], - "type": "object" + "$ref": "#/components/schemas/PublicAppAttributes" }, "id": { "$ref": "#/components/schemas/Uuid" @@ -7453,37 +7988,6 @@ ], "type": "object" }, - "PullRequestAssignmentSettings": { - "additionalProperties": false, - "description": "Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Project's integration.", - "properties": { - "assignees": { - "description": "Manually specify users to assign (and all will be assigned).", - "example": [ - "my-github-username" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "is_enabled": { - "description": "Automatically assign pull requests created by Snyk.", - "example": true, - "type": "boolean" - }, - "type": { - "description": "Automatically assign the last user to change the manifest file (\"auto\"), or manually specify a list of users (\"manual\").", - "enum": [ - "auto", - "manual" - ], - "example": "auto", - "type": "string" - } - }, - "type": "object" - }, "PullRequestAssignmentSettings20240531": { "additionalProperties": false, "description": "Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Organization's integration.", @@ -7582,6 +8086,26 @@ "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string" }, + "ReadTenantMembershipResponseRelationships": { + "additionalProperties": false, + "properties": { + "role": { + "$ref": "#/components/schemas/TenantMembershipTenantRoleRelationshipFull" + }, + "tenant": { + "$ref": "#/components/schemas/TenantMembershipTenantRelationshipFull" + }, + "user": { + "$ref": "#/components/schemas/TenantMembershipUserRelationshipFullWithMeta" + } + }, + "required": [ + "role", + "tenant", + "user" + ], + "type": "object" + }, "RecurringTestsSettings": { "additionalProperties": false, "description": "Settings which describe how recurring tests are run for a project.", @@ -7625,38 +8149,10 @@ "Region": { "properties": { "end": { - "properties": { - "column": { - "minimum": 0, - "type": "integer" - }, - "line": { - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "line", - "column" - ], - "type": "object" + "$ref": "#/components/schemas/FilePosition" }, "start": { - "properties": { - "column": { - "minimum": 0, - "type": "integer" - }, - "line": { - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "line", - "column" - ], - "type": "object" + "$ref": "#/components/schemas/FilePosition" } }, "required": [ @@ -7725,28 +8221,41 @@ "type": "object" }, "Remedy": { + "additionalProperties": false, "properties": { + "correlation_id": { + "description": "An optional identifier for correlating remedies between coordinates or across issues. They are scoped\nto a single Project and test run. Remedies with the same correlation_id must have the same contents.\n", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, "description": { - "description": "A markdown-formatted optional description of this remedy.", - "example": "Upgrade the package version to 5.4.0,6.4.0 to fix this vulnerability", + "description": "A markdown-formatted optional description of this remedy. Links are not permitted.", + "maxLength": 4096, + "minLength": 1, "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" + "meta": { + "$ref": "#/components/schemas/RemedyMetadata" }, "type": { - "description": "The type of the remedy. Always ‘indeterminate’.", - "example": "indeterminate", + "enum": [ + "indeterminate", + "manual", + "automated", + "rule_result_message", + "terraform", + "cloudformation", + "cli", + "kubernetes", + "arm" + ], "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "RemedyMetadata": { @@ -7872,6 +8381,153 @@ ], "type": "object" }, + "ResourceAttributes": { + "example": { + "created_at": "2022-08-10T17:19:33.14749Z", + "hash": "3333342563a86c675333de5848c9220a7bb35c039e7b9c0688c10f72b4666666", + "kind": "runtime", + "location": "us-west-2", + "name": "example-bucket", + "namespace": "us-west-2", + "native_id": "arn:aws:s3:::example-bucket", + "options": "json here", + "origin": "aws-account", + "platform": "aws", + "resource_id": "example-bucket", + "resource_type": "aws_s3_bucket", + "revision": 1, + "state": { + "acl": "private", + "arn": "arn:aws:s3:::example-bucket", + "bucket": "example-bucket" + }, + "tags": { + "stage": "prod" + }, + "updated_at": "2022-08-10T17:19:33.14749Z" + }, + "properties": { + "created_at": { + "description": "When the resource was first recorded", + "example": "2022-08-10T17:19:33.14749Z", + "format": "date-time", + "type": "string" + }, + "deleted_at": { + "format": "date-time", + "nullable": true, + "type": "string" + }, + "hash": { + "description": "Computed hash value for the resource based on its attributes", + "example": "3333342563a86c675333de5848c9220a7bb35c039e7b9c0688c10f72b4666666", + "type": "string" + }, + "is_managed": { + "nullable": true, + "type": "boolean" + }, + "kind": { + "$ref": "#/components/schemas/ResourceKind" + }, + "location": { + "description": "Physical location (AWS region)", + "example": "us-west-2", + "type": "string" + }, + "name": { + "description": "Human friendly resource name", + "example": "example-bucket", + "type": "string" + }, + "namespace": { + "description": "Resource namespace (AWS region)", + "example": "us-west-2", + "type": "string" + }, + "native_id": { + "description": "ID of the physical resource from the cloud provider (AWS ARN, if available)", + "example": "arn:aws:s3:::example-bucket", + "type": "string" + }, + "platform": { + "description": "Resource platform: aws", + "example": "aws", + "type": "string" + }, + "relationships": { + "additionalProperties": true, + "type": "object" + }, + "removed_at": { + "format": "date-time", + "nullable": true, + "type": "string" + }, + "resource_id": { + "description": "Unique ID for the resource", + "example": "4a662442-7445-55c3-adcc-cbbbdd99999", + "type": "string" + }, + "resource_type": { + "description": "Terraform resource type", + "example": "aws_s3_bucket", + "type": "string" + }, + "revision": { + "description": "Increment for each change to a resource", + "example": 2, + "type": "integer" + }, + "schema_version": { + "nullable": true, + "type": "string" + }, + "source_location": { + "items": { + "additionalProperties": true, + "type": "object" + }, + "type": "array" + }, + "state": { + "additionalProperties": true, + "description": "Terraform state attributes", + "type": "object" + }, + "tags": { + "additionalProperties": true, + "description": "Resource tags from the cloud provider", + "example": { + "stage": "prod" + }, + "type": "object" + }, + "updated_at": { + "description": "When the resource was last updated", + "example": "2022-08-10T17:19:33.14749Z", + "format": "date-time", + "nullable": true, + "type": "string" + } + }, + "required": [ + "created_at", + "updated_at", + "revision", + "kind", + "hash", + "platform", + "resource_type", + "resource_id" + ], + "type": "object" + }, + "ResourceKind": { + "description": "Kind of resource: cloud", + "example": "cloud - cloud - iac", + "type": "string" + }, "ResourcePath": { "example": ",5.4.0),[6.0.0.pr1,6.4.0)", "maxLength": 2024, @@ -7882,7 +8538,10 @@ "description": "An object that contains an opaque identifying string.", "properties": { "resource_path": { - "$ref": "#/components/schemas/ResourcePath" + "example": ",5.4.0),[6.0.0.pr1,6.4.0)", + "maxLength": 2024, + "minLength": 1, + "type": "string" } }, "required": [ @@ -7890,6 +8549,61 @@ ], "type": "object" }, + "ResourceReference": { + "additionalProperties": false, + "properties": { + "id": { + "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Type of the related resource", + "example": "resource", + "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", + "type": "string" + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "ResourceRelationships": { + "additionalProperties": true, + "description": "Resource relationships", + "example": { + "environment": { + "data": { + "id": "11000000-0000-0000-0000-000000000000", + "type": "environment" + }, + "links": { + "related": "/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..." + } + }, + "organization": { + "data": { + "id": "10000000-0000-0000-0000-000000000000", + "type": "organization" + }, + "links": { + "related": "/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..." + } + }, + "scan": { + "data": { + "id": "12000000-0000-0000-0000-000000000000", + "type": "scan" + }, + "links": { + "related": "/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..." + } + } + }, + "type": "object" + }, "Risk": { "additionalProperties": false, "description": "Risk prioritization information for an issue", @@ -7980,6 +8694,44 @@ ], "type": "object" }, + "SSOConnection": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/SSOConnectionAttributes" + }, + "id": { + "example": "331ede0a-de94-456f-b788-166caeca58bf", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Content type.", + "example": "sso_connection", + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "SSOConnectionAttributes": { + "additionalProperties": false, + "properties": { + "name": { + "description": "The display name of the sso connection.", + "example": "My SSO", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, "SastEnablement": { "additionalProperties": false, "properties": { @@ -8051,6 +8803,169 @@ ], "type": "object" }, + "SbomTestCreateAttributes": { + "properties": { + "format": { + "type": "string" + }, + "sbom": { + "additionalProperties": true, + "type": "object" + } + }, + "required": [ + "sbom" + ], + "type": "object" + }, + "SbomTestResultsAttributes": { + "additionalProperties": true, + "type": "object" + }, + "ScanAttributes": { + "description": "Scan attributes", + "example": { + "created_at": "2022-05-06T12:25:15-04:00", + "error": "", + "finished_at": "2022-05-06T12:25:15-04:00", + "kind": "user_initiated", + "options": { + "role_arn": "arn:aws:iam::123456789012:role/SnykCloud1234" + }, + "revision": 1, + "status": "success", + "updated_at": "2022-05-06T12:25:15-04:00" + }, + "properties": { + "created_at": { + "description": "When the scan was created", + "example": "2022-05-06T12:25:15-04:00", + "format": "date-time", + "type": "string" + }, + "deleted_at": { + "format": "date-time", + "nullable": true, + "type": "string" + }, + "environment_id": { + "description": "Environment ID", + "example": "052781a7-17f6-494d-0000-25c8b509abcd", + "format": "uuid", + "type": "string" + }, + "error": { + "description": "Error message if the scan failed", + "example": "could not start scan", + "nullable": true, + "type": "string" + }, + "finished_at": { + "description": "When the scan finished", + "example": "2022-05-06T12:25:15-04:00", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "kind": { + "description": "Scan kind", + "enum": [ + "scheduled", + "user_initiated", + "event_driven", + null + ], + "example": "user_initiated", + "nullable": true, + "type": "string" + }, + "options": { + "example": { + "role_arn": "arn:aws:iam::123456789012:role/SnykCloud1234" + }, + "nullable": true, + "type": "object" + }, + "organization_id": { + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", + "format": "uuid", + "type": "string" + }, + "partial_errors": { + "description": "Errors that didn't fail the scan", + "type": "string" + }, + "revision": { + "description": "Increment for each change to a scan", + "example": 1, + "type": "number" + }, + "status": { + "description": "Scan status", + "enum": [ + "queued", + "in_progress", + "success", + "error", + null + ], + "example": "in_progress", + "nullable": true, + "type": "string" + }, + "updated_at": { + "description": "When the scan was last updated", + "example": "2022-05-06T12:25:15-04:00", + "format": "date-time", + "nullable": true, + "type": "string" + } + }, + "required": [ + "created_at", + "revision", + "kind", + "status", + "error" + ], + "type": "object" + }, + "ScanCreateAttributes": { + "additionalProperties": false, + "description": "Scan create attributes", + "type": "object" + }, + "ScanCreateRelationships": { + "description": "Scan create relationships", + "properties": { + "environment": { + "properties": { + "data": { + "example": { + "id": "12000000-0000-0000-0000-000000000000", + "type": "environment" + }, + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "ScanItemType": { "enum": [ "project", @@ -8059,6 +8974,35 @@ "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": { @@ -8410,47 +9354,7 @@ "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" + "$ref": "#/components/schemas/Region" } }, "required": [ @@ -8458,6 +9362,24 @@ ], "type": "object" }, + "Tag": { + "properties": { + "tag_type": { + "type": "string" + }, + "tag_values": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tag_type", + "tag_values" + ], + "type": "object" + }, "TargetChannelId": { "example": "slack://channel?team=team-id\u0026id=channel-id", "format": "uri", @@ -8468,6 +9390,275 @@ "minLength": 1, "type": "string" }, + "TenantId": { + "description": "Unique identifier for a tenant.", + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + }, + "TenantMembershipId": { + "description": "Unique identifier for a tenant membership.", + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + }, + "TenantMembershipResponseAttributes": { + "additionalProperties": false, + "properties": { + "created_at": { + "$ref": "#/components/schemas/CreatedAt" + } + }, + "required": [ + "created_at" + ], + "type": "object" + }, + "TenantMembershipResponseDataObject": { + "properties": { + "attributes": { + "$ref": "#/components/schemas/TenantMembershipResponseAttributes" + }, + "id": { + "$ref": "#/components/schemas/TenantMembershipId" + }, + "relationships": { + "$ref": "#/components/schemas/ReadTenantMembershipResponseRelationships" + }, + "type": { + "$ref": "#/components/schemas/TenantMembershipType" + } + }, + "required": [ + "id", + "type", + "attributes", + "relationships" + ], + "type": "object" + }, + "TenantMembershipTenantRelationshipDataFull": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "name": { + "$ref": "#/components/schemas/TenantName" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "$ref": "#/components/schemas/TenantId" + }, + "type": { + "$ref": "#/components/schemas/TenantType" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "TenantMembershipTenantRelationshipFull": { + "additionalProperties": false, + "description": "The tenant to which the membership applies.", + "properties": { + "data": { + "$ref": "#/components/schemas/TenantMembershipTenantRelationshipDataFull" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TenantMembershipTenantRoleRelationshipBasic": { + "additionalProperties": false, + "description": "The role held by the user in the tenant.", + "properties": { + "data": { + "$ref": "#/components/schemas/TenantMembershipTenantRoleRelationshipDataBasic" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TenantMembershipTenantRoleRelationshipDataBasic": { + "additionalProperties": false, + "properties": { + "id": { + "$ref": "#/components/schemas/TenantRoleId" + }, + "type": { + "$ref": "#/components/schemas/TenantRoleType" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TenantMembershipTenantRoleRelationshipDataFull": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "name": { + "$ref": "#/components/schemas/TenantRoleName" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "$ref": "#/components/schemas/TenantRoleId" + }, + "type": { + "$ref": "#/components/schemas/TenantRoleType" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "TenantMembershipTenantRoleRelationshipFull": { + "additionalProperties": false, + "description": "The role held by the user in the tenant.", + "properties": { + "data": { + "$ref": "#/components/schemas/TenantMembershipTenantRoleRelationshipDataFull" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TenantMembershipType": { + "description": "Resource type for tenant memberships.", + "enum": [ + "tenant_membership" + ], + "type": "string" + }, + "TenantMembershipUserRelationshipDataAttributes": { + "additionalProperties": false, + "properties": { + "account_type": { + "$ref": "#/components/schemas/UserAccountType" + }, + "active": { + "$ref": "#/components/schemas/UserIsActive" + }, + "email": { + "$ref": "#/components/schemas/UserEmail" + }, + "login_method": { + "$ref": "#/components/schemas/UserLoginMethod" + }, + "name": { + "$ref": "#/components/schemas/UserName" + }, + "username": { + "$ref": "#/components/schemas/UserUsername" + } + }, + "required": [ + "name", + "email", + "login_method" + ], + "type": "object" + }, + "TenantMembershipUserRelationshipDataFullWithMeta": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/TenantMembershipUserRelationshipDataAttributes" + }, + "id": { + "$ref": "#/components/schemas/UserId" + }, + "meta": { + "additionalProperties": false, + "properties": { + "tenant_owner": { + "description": "Whether the user is the owner of the tenant.", + "type": "boolean" + } + }, + "type": "object" + }, + "type": { + "$ref": "#/components/schemas/UserType" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "TenantMembershipUserRelationshipFullWithMeta": { + "additionalProperties": false, + "description": "The user to which the membership belongs.", + "properties": { + "data": { + "$ref": "#/components/schemas/TenantMembershipUserRelationshipDataFullWithMeta" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TenantName": { + "description": "The display name of the tenant.", + "example": "My Tenant", + "type": "string" + }, + "TenantRoleId": { + "description": "Unique identifier for a tenant role.", + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + }, + "TenantRoleName": { + "description": "The display name of the role.", + "example": "Role name", + "type": "string" + }, + "TenantRoleType": { + "description": "Resource type for tenant roles.", + "enum": [ + "tenant_role" + ], + "type": "string" + }, + "TenantType": { + "description": "Resource type for tenants.", + "enum": [ + "tenant" + ], + "type": "string" + }, "TestExecutionType": { "enum": [ "test-workflow-execution", @@ -8628,12 +9819,116 @@ ], "type": "object" }, - "Updated": { - "description": "The last time the settings were updated.", - "example": "2021-11-12T10:31:06.026Z", - "format": "date-time", - "type": "string" - }, + "UpdateTenantMembershipRequestData": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "type": "object" + }, + "id": { + "$ref": "#/components/schemas/TenantMembershipId" + }, + "relationships": { + "$ref": "#/components/schemas/UpdateTenantMembershipRequestRelationships" + }, + "type": { + "$ref": "#/components/schemas/TenantMembershipType" + } + }, + "required": [ + "id", + "type", + "relationships" + ], + "type": "object" + }, + "UpdateTenantMembershipRequestRelationships": { + "additionalProperties": false, + "properties": { + "role": { + "$ref": "#/components/schemas/TenantMembershipTenantRoleRelationshipBasic" + } + }, + "required": [ + "role" + ], + "type": "object" + }, + "Updated": { + "description": "The last time the settings were updated.", + "example": "2021-11-12T10:31:06.026Z", + "format": "date-time", + "type": "string" + }, + "User": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "active": { + "description": "Whether the user status is enabled or not", + "example": true, + "type": "boolean" + }, + "email": { + "description": "The email of the user.", + "example": "user@someorg.com", + "type": "string" + }, + "membership": { + "properties": { + "created_at": { + "description": "The date the membership was established.", + "example": "2022-09-14T09:19:29.206Z", + "format": "date-time", + "type": "string" + }, + "strategy": { + "description": "Whether the membership is a direct, or indirect membership.", + "enum": [ + "direct", + "indirect" + ], + "example": "direct", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The name of the user.", + "example": "user", + "type": "string" + }, + "username": { + "description": "The username of the user.", + "example": "username", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The Snyk ID corresponding to this user", + "example": "55a348e2-c3ad-4bbc-b40e-9b232d1f4121", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Content type.", + "example": "user", + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, "User20240422": { "additionalProperties": false, "properties": { @@ -8671,6 +9966,90 @@ ], "type": "object" }, + "UserAccountType": { + "description": "The type of the user account.", + "example": "user", + "type": "string" + }, + "UserEmail": { + "description": "The e-mail address of the user.", + "example": "user@example.com", + "type": "string" + }, + "UserId": { + "description": "Unique identifier for a user.", + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + }, + "UserIsActive": { + "description": "Whether the user is active.", + "example": true, + "type": "boolean" + }, + "UserLoginMethod": { + "description": "The authentication method used by the user.", + "example": "saml", + "type": "string" + }, + "UserName": { + "description": "The real name of the user.", + "example": "Firstname Lastname", + "type": "string" + }, + "UserPatchRequestBody": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "membership": { + "nullable": true, + "properties": { + "role": { + "description": "Role name", + "example": "MEMBER", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "membership" + ], + "type": "object" + }, + "id": { + "description": "The Snyk ID corresponding to this user", + "example": "55a348e2-c3ad-4bbc-b40e-9b232d1f4121", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Content type", + "example": "user", + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "UserType": { + "description": "Resource type for users.", + "enum": [ + "user" + ], + "type": "string" + }, + "UserUsername": { + "description": "The username of the user.", + "example": "username", + "type": "string" + }, "Uuid": { "format": "uuid", "type": "string" @@ -8816,13 +10195,7 @@ "$ref": "#/components/parameters/Limit" }, { - "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" - } + "$ref": "#/components/parameters/ProjectId" }, { "description": "The organization ID of the custom base image", @@ -8919,13 +10292,17 @@ "tags": [ "Custom Base Images" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ "2023-08-21", "2023-09-20", "2024-01-04", "2024-05-31" ], - "x-snyk-api-version": "2024-05-31" + "x-snyk-api-resource": "custombaseimages", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" }, "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", @@ -9002,15 +10379,18 @@ "tags": [ "Custom Base Images" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ "2023-08-21", "2023-09-20", "2024-01-04", "2024-05-31" ], - "x-snyk-api-version": "2024-05-31" - }, - "x-snyk-api-resource": "custombaseimages" + "x-snyk-api-resource": "custombaseimages", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" + } }, "/custom_base_images/{custombaseimage_id}": { "delete": { @@ -9062,13 +10442,17 @@ "tags": [ "Custom Base Images" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ "2023-08-21", "2023-09-20", "2024-01-04", "2024-05-31" ], - "x-snyk-api-version": "2024-05-31" + "x-snyk-api-resource": "custombaseimages", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" }, "get": { "description": "Get a custom base image", @@ -9132,13 +10516,17 @@ "tags": [ "Custom Base Images" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ "2023-08-21", "2023-09-20", "2024-01-04", "2024-05-31" ], - "x-snyk-api-version": "2024-05-31" + "x-snyk-api-resource": "custombaseimages", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" }, "patch": { "description": "Updates a custom base image's attributes", @@ -9212,50 +10600,24 @@ "tags": [ "Custom Base Images" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ "2023-08-21", "2023-09-20", "2024-01-04", "2024-05-31" ], - "x-snyk-api-version": "2024-05-31" - }, - "x-snyk-api-resource": "custombaseimages" + "x-snyk-api-resource": "custombaseimages", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/apps/installs": { + "/groups": { "get": { - "description": "Get a list of apps installed for a group.", - "operationId": "getAppInstallsForGroup", + "description": "Returns a list of groups which a user is a member of", + "operationId": "listGroups", "parameters": [ - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, { "$ref": "#/components/parameters/StartingAfter" }, @@ -9264,6 +10626,9 @@ }, { "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/Version" } ], "responses": { @@ -9271,11 +10636,10 @@ "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { "items": { - "$ref": "#/components/schemas/AppInstallData" + "$ref": "#/components/schemas/Group" }, "type": "array" }, @@ -9283,19 +10647,109 @@ "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "$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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-01-31~experimental", + "2023-01-30~beta" + ], + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-01-30~beta", + "x-stability-level": "beta" + } + }, + "/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": "A list of apps installed for the specified group.", + "description": "Group is returned", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -9318,405 +10772,836 @@ } }, "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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-01-31~experimental", + "2023-01-30~beta" + ], + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-01-30~beta", + "x-stability-level": "beta" + } + }, + "/groups/{group_id}/apps/installs": { + "get": { + "description": "Get a list of apps installed for a group.", + "operationId": "getAppInstallsForGroup", + "parameters": [ + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Group ID", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppInstallData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "A list of apps installed for the specified group.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400__0" + }, "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Get a list of apps installed for a group.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + }, + "post": { + "description": "Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.", + "operationId": "createGroupAppInstall", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Group ID", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "properties": { + "type": { + "enum": [ + "app_install" + ], + "example": "app_install", + "type": "string" } - ], - "jsonapi": { - "version": "1.0" - } + }, + "type": "object" }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { + "relationships": { + "additionalProperties": false, + "properties": { + "app": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { + "data": { "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" + "id": { + "$ref": "#/components/schemas/Uuid" }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", + "type": { + "enum": [ + "app" + ], + "example": "app", "type": "string" } }, + "required": [ + "id", + "type" + ], "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" } }, "required": [ - "status", - "detail" + "data" ], "type": "object" - }, - "minItems": 1, - "type": "array" + } + }, + "required": [ + "app" + ], + "type": "object" + } + }, + "required": [ + "data", + "relationships" + ], + "type": "object" + } + } + }, + "description": "App Install to be created" + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppInstallWithClient" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "The newly created app install.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, "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" - }, + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Install a Snyk Apps to this group.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/apps/installs/{install_id}": { + "delete": { + "description": "Revoke app authorization for an Snyk Group with install ID.", + "operationId": "deleteGroupAppInstallById", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Group ID", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/InstallId" + } + ], + "responses": { + "204": { + "description": "The app install has been de-authorized.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Revoke app authorization for an Snyk Group with install ID.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/apps/installs/{install_id}/secrets": { + "post": { + "description": "Manage client secret for non-interactive Snyk App installations.", + "operationId": "updateGroupAppInstallSecret", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Group ID", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/InstallId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", + "enum": [ + "replace", + "create", + "delete" + ], + "type": "string" + }, + "secret": { + "description": "Secret to delete when using `delete` mode", + "type": "string" + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "type": { + "enum": [ + "app" + ], + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppInstallDataWithSecret" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Secret has been updated.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Manage client secret for non-interactive Snyk App installations.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/audit_logs/search": { + "get": { + "description": "Search audit logs for a Group. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Some Organization level events are supported as well as the following\nGroup level events:\n - api.access\n - group.cloud_config.settings.edit\n - group.create\n - group.delete\n - group.edit\n - group.notification_settings.edit\n - group.org.add\n - group.org.remove\n - group.policy.create\n - group.policy.delete\n - group.policy.edit\n - group.request_access_settings.edit\n - group.role.create\n - group.role.delete\n - group.role.edit\n - group.service_account.create\n - group.service_account.delete\n - group.service_account.edit\n - group.settings.edit\n - group.settings.feature_flag.edit\n - group.sso.add\n - group.sso.auth0_connection.create\n - group.sso.auth0_connection.edit\n - group.sso.create\n - group.sso.delete\n - group.sso.edit\n - group.sso.membership.sync\n - group.sso.remove\n - group.tag.create\n - group.tag.delete\n - group.user.add\n - group.user.remove\n - group.user.role.edit\n", + "operationId": "listGroupAuditLogs", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The ID of the Group.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Cursor" + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/Size" + }, + { + "description": "Order in which results are returned.", + "example": "ASC", + "in": "query", + "name": "sort_order", + "schema": { + "default": "DESC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + { + "description": "Filter logs by user ID.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "in": "query", + "name": "user_id", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Filter logs by project ID.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "in": "query", + "name": "project_id", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Events" + }, + { + "$ref": "#/components/parameters/ExcludeEvents" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AuditLogSearch" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" + } + } + }, + "description": "Group Audit Logs.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Search Group audit logs.", + "tags": [ + "Audit Logs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-11", + "2024-04-29" + ], + "x-snyk-api-resource": "audit-logs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-04-29", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/issues": { + "get": { + "description": "Get a list of a group's issues.", + "operationId": "listGroupIssues", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Group ID", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/ScanItemId" + }, + { + "$ref": "#/components/parameters/ScanItemType" + }, + { + "$ref": "#/components/parameters/Type" + }, + { + "$ref": "#/components/parameters/UpdatedBefore" + }, + { + "$ref": "#/components/parameters/UpdatedAfter" + }, + { + "$ref": "#/components/parameters/CreatedBefore" + }, + { + "$ref": "#/components/parameters/CreatedAfter" + }, + { + "$ref": "#/components/parameters/EffectiveSeverityLevel" + }, + { + "$ref": "#/components/parameters/Status" + }, + { + "$ref": "#/components/parameters/Ignored" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ListIssues200" + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", @@ -9802,10 +11687,10 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -9813,7 +11698,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -9821,7 +11706,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -9836,7 +11721,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -9845,7 +11730,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -9863,7 +11748,7 @@ } } }, - "404": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -9984,10 +11869,10 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -9995,7 +11880,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -10003,7 +11888,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -10018,7 +11903,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -10027,7 +11912,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -10045,7 +11930,7 @@ } } }, - "409": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -10166,10 +12051,10 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -10177,7 +12062,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -10185,7 +12070,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -10200,7 +12085,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -10209,7 +12094,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -10351,7 +12236,7 @@ "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -10359,7 +12244,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -10367,7 +12252,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -10382,7 +12267,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -10391,7 +12276,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -10410,20 +12295,26 @@ } } }, - "summary": "Get a list of apps installed for a group.", + "summary": "Get issues by group ID", "tags": [ - "Apps" + "Issues" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" + "2023-03-10~experimental", + "2023-09-29~beta", + "2024-01-23" ], - "x-snyk-api-version": "2024-05-23" - }, - "post": { - "description": "Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.", - "operationId": "createGroupAppInstall", + "x-snyk-api-resource": "issues", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-01-23", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/issues/{issue_id}": { + "get": { + "description": "Get an issue", + "operationId": "getGroupIssueByIssueID", "parameters": [ { "$ref": "#/components/parameters/Version" @@ -10434,132 +12325,384 @@ "name": "group_id", "required": true, "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", "format": "uuid", "type": "string" } + }, + { + "$ref": "#/components/parameters/PathIssueId20240123" } ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "properties": { - "type": { - "enum": [ - "app_install" - ], - "example": "app_install", - "type": "string" + "responses": { + "200": { + "$ref": "#/components/responses/GetIssue20020240123" + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" } - }, - "type": "object" + ], + "jsonapi": { + "version": "1.0" + } }, - "relationships": { - "additionalProperties": false, - "properties": { - "app": { + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, "properties": { - "data": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, "properties": { - "id": { - "$ref": "#/components/schemas/Uuid" + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "type": { - "enum": [ - "app" - ], - "example": "app", + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", "type": "string" } }, - "required": [ - "id", - "type" - ], "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" } }, "required": [ - "data" + "status", + "detail" ], "type": "object" - } + }, + "minItems": 1, + "type": "array" }, - "required": [ - "app" - ], - "type": "object" - } - }, - "required": [ - "data", - "relationships" - ], - "type": "object" + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "The version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "The version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", + "example": "2021-08-02", + "schema": { + "format": "date", + "type": "string" + } } } }, - "description": "App Install to be created" - }, - "responses": { - "201": { + "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/AppInstallWithClient" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ - "data", "jsonapi", - "links" + "errors" ], "type": "object" } } }, - "description": "The newly created app install.", + "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", "schema": { + "format": "date-time", "type": "string" } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "The version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "The version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", + "example": "2021-08-02", + "schema": { + "format": "date", + "type": "string" + } } } }, - "400": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -10680,10 +12823,10 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -10691,7 +12834,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -10699,7 +12842,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -10714,7 +12857,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -10723,7 +12866,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -10741,7 +12884,7 @@ } } }, - "401": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -10862,10 +13005,10 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -10873,7 +13016,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -10881,7 +13024,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -10896,7 +13039,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -10905,7 +13048,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -10923,7 +13066,7 @@ } } }, - "403": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -11044,10 +13187,10 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -11055,7 +13198,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -11063,7 +13206,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -11078,7 +13221,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -11087,7 +13230,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -11105,7 +13248,7 @@ } } }, - "404": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -11226,10 +13369,10 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -11237,7 +13380,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -11245,7 +13388,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -11260,7 +13403,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -11269,7 +13412,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -11286,419 +13429,265 @@ } } } + } + }, + "summary": "Get an issue", + "tags": [ + "Issues" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-01-23" + ], + "x-snyk-api-resource": "issues", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-01-23", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/memberships": { + "get": { + "description": "Returns all memberships of the group", + "operationId": "listGroupMemberships", + "parameters": [ + { + "$ref": "#/components/parameters/GroupId" }, - "409": { + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/SortBy__0" + }, + { + "$ref": "#/components/parameters/SortOrder__0" + }, + { + "$ref": "#/components/parameters/EmailFilter" + }, + { + "$ref": "#/components/parameters/UserIdFilter" + }, + { + "$ref": "#/components/parameters/UsernameFilter" + }, + { + "$ref": "#/components/parameters/RoleFilter" + }, + { + "$ref": "#/components/parameters/IncludeGroupMembershipCount" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/GroupMembershipResponseData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "List of group memberships is returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get all memberships of the group", + "tags": [ + "Groups" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-09~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + }, + "post": { + "description": "Create a group membership for a user with role", + "operationId": "createGroupMembership", + "parameters": [ + { + "$ref": "#/components/parameters/GroupId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CreateGroupMembershipRequestBody" + } + } + } + }, + "responses": { + "201": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/GroupMembership" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Membership for the group was created", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Install a Snyk Apps to this group.", + "summary": "Create a group membership for a user with role", "tags": [ - "Apps" + "Groups" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" + "2024-05-09~experimental", + "2024-08-25" ], - "x-snyk-api-version": "2024-05-23" - }, - "x-snyk-api-resource": "app_installs" + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/apps/installs/{install_id}": { + "/groups/{group_id}/memberships/{membership_id}": { "delete": { - "description": "Revoke app authorization for an Snyk Group with install ID.", - "operationId": "deleteGroupAppInstallById", + "description": "Deletes a membership from a group", + "operationId": "deleteGroupMembership", "parameters": [ { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/GroupId" }, { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/MembershipId" }, { - "$ref": "#/components/parameters/InstallId" + "$ref": "#/components/parameters/Cascade" + }, + { + "$ref": "#/components/parameters/Version" } ], "responses": { "204": { - "description": "The app install has been de-authorized.", + "description": "group membership is deleted from Group", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "schema": { - "type": "string" - } - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -11717,1123 +13706,891 @@ } }, "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" + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete a membership from a group", + "tags": [ + "Groups" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-09~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + }, + "patch": { + "description": "Update a role from a group membership", + "operationId": "updateGroupUserMembership", + "parameters": [ + { + "$ref": "#/components/parameters/GroupId" + }, + { + "$ref": "#/components/parameters/MembershipId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/MembershipPatchRequestBody" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update a role from a group membership", + "tags": [ + "Groups" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-09~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/org_memberships": { + "get": { + "description": "Get list of org memberships of a group user", + "operationId": "listGroupUserOrgMemberships", + "parameters": [ + { + "$ref": "#/components/parameters/GroupId" + }, + { + "$ref": "#/components/parameters/UserId" + }, + { + "$ref": "#/components/parameters/OrgName" + }, + { + "$ref": "#/components/parameters/RoleFilter" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/GroupMembershipOrgMembership" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + }, + "meta": { "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" + "org_membership_count": { + "description": "Org memberships for this user within this group.", + "type": "number" } }, - "required": [ - "version" - ], "type": "object" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "A list of org memberships is returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get list of org memberships of a group user", + "tags": [ + "Groups" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-07~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/orgs": { + "get": { + "description": "Get a paginated list of all the organizations belonging to the group.\nBy default, this endpoint returns the organizations in alphabetical order of their name.", + "operationId": "listOrgsInGroup", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/PathGroupId" + }, + { + "$ref": "#/components/parameters/QueryNameFilter" + }, + { + "$ref": "#/components/parameters/QuerySlugFilter" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { + "attributes": { "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", + "access_requests_enabled": { + "description": "Whether the organization permits access requests from users who are not members of the organization.", + "example": false, + "type": "boolean" + }, + "created_at": { + "description": "The time the organization was created.", + "example": "2022-03-16T00:00:00Z", + "format": "date-time", "type": "string" }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", + "group_id": { + "description": "The Snyk ID of the group to which the organization belongs.", + "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34", + "format": "uuid", + "type": "string" + }, + "is_personal": { + "description": "Whether the organization is independent (that is, not part of a group).", + "example": true, + "type": "boolean" + }, + "name": { + "description": "The display name of the organization.", + "example": "My Org", + "type": "string" + }, + "slug": { + "description": "The canonical (unique and URL-friendly) name of the organization.", + "example": "my-org", + "type": "string" + }, + "updated_at": { + "description": "The time the organization was last modified.", + "example": "2022-03-16T00:00:00Z", + "format": "date-time", "type": "string" } }, + "required": [ + "name", + "slug", + "is_personal" + ], "type": "object" }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", + "id": { + "description": "The Snyk ID of the organization.", + "example": "59d6d97e-3106-4ebb-b608-352fad9c5b34", + "format": "uuid", "type": "string" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "type": { + "example": "resource", + "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string" } }, "required": [ - "status", - "detail" + "type", + "id", + "attributes" ], "type": "object" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "A list of organizations in the group.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "List all organizations in group", + "tags": [ + "Orgs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-10-24~experimental", + "2023-12-14~beta", + "2024-02-28" + ], + "x-snyk-api-resource": "orgs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-02-28", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/service_accounts": { + "get": { + "description": "Get all service accounts for a group.", + "operationId": "getManyGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service accounts.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ServiceAccount" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "A list of service accounts is returned.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "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": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of group service accounts.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + }, + "post": { + "description": "Create a service account for a group. The service account can be used to access the Snyk API.", + "operationId": "createGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that is creating and owns the service account", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", + "maximum": 86400, + "minimum": 3600, + "type": "number" }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", + "auth_type": { + "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], "type": "string" }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", + "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" }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", + "name": { + "description": "A human-friendly name for the service account.", "type": "string" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "role_id": { + "description": "The ID of the role which the created service account should use.", + "format": "uuid", "type": "string" } }, "required": [ - "status", - "detail" + "name", + "auth_type", + "role_id" ], "type": "object" }, - "minItems": 1, - "type": "array" + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/ServiceAccount" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "A new service account has been created", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, - "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.", + "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-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/service_accounts/{serviceaccount_id}": { + "delete": { + "description": "Permanently delete a group-level service account by its ID.", + "operationId": "deleteOneGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "Service account was successfully deleted.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete a group service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + }, + "get": { + "description": "Get a group-level service account by its ID.", + "operationId": "getOneGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/ServiceAccount" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Service account is returned.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Revoke app authorization for an Snyk Group with install ID.", + "summary": "Get a group service account.", "tags": [ - "Apps" + "ServiceAccounts" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" + "2023-09-07" ], - "x-snyk-api-version": "2024-05-23" + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" }, - "x-snyk-api-resource": "app_installs" - }, - "/groups/{group_id}/apps/installs/{install_id}/secrets": { - "post": { - "description": "Manage client secret for non-interactive Snyk App installations.", - "operationId": "updateGroupAppInstallSecret", + "patch": { + "description": "Update the name of a group's service account by its ID.", + "operationId": "updateGroupServiceAccount", "parameters": [ { - "$ref": "#/components/parameters/Version" + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "description": "Group ID", + "description": "The ID of the service account.", "in": "path", - "name": "group_id", + "name": "serviceaccount_id", "required": true, "schema": { "format": "uuid", @@ -12841,7 +14598,7 @@ } }, { - "$ref": "#/components/parameters/InstallId" + "$ref": "#/components/parameters/Version" } ], "requestBody": { @@ -12856,35 +14613,33 @@ "attributes": { "additionalProperties": false, "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", + "name": { + "description": "A human-friendly name for the service account. Must be unique within the group.", "type": "string" } }, "required": [ - "mode" + "name" ], "type": "object" }, + "id": { + "description": "The ID of the service account. Must match the id in the url path.", + "format": "uuid", + "type": "string" + }, "type": { + "description": "The Resource type.", "enum": [ - "app" + "service_account" ], "type": "string" } }, "required": [ - "attributes", - "type" + "type", + "id", + "attributes" ], "type": "object" } @@ -12895,7 +14650,8 @@ "type": "object" } } - } + }, + "required": true }, "responses": { "200": { @@ -12905,28 +14661,31 @@ "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/AppInstallDataWithSecret" + "$ref": "#/components/schemas/ServiceAccount" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/SelfLink" + "$ref": "#/components/schemas/Links" } }, + "required": [ + "jsonapi", + "data", + "links" + ], "type": "object" } } }, - "description": "Secret has been updated.", + "description": "Service account is returned.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, "location": { - "schema": { - "type": "string" - } + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" @@ -12946,1170 +14705,848 @@ } }, "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$", + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update a group service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets": { + "post": { + "description": "Manage the client secret of a group service account by the service account ID.", + "operationId": "updateServiceAccountSecret", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", + "enum": [ + "replace", + "create", + "delete" + ], "type": "string" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "secret": { + "description": "Secret to delete when using `delete` mode", "type": "string" } }, "required": [ - "status", - "detail" + "mode" ], "type": "object" }, - "minItems": 1, - "type": "array" + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/ServiceAccount" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Service account client secret has been updated.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Manage a group service account's client secret.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/settings/iac": { + "get": { + "description": "Get the Infrastructure as Code Settings for a group.", + "operationId": "getIacSettingsForGroup", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the group whose Infrastructure as Code settings are requested", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/GroupIacSettingsResponse" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "The Infrastructure as Code Settings of the group.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get the Infrastructure as Code Settings for a group", + "tags": [ + "IacSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-resource": "iac_settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2021-12-09", + "x-stability-level": "stable" + }, + "patch": { + "description": "Update the Infrastructure as Code Settings for a group.", + "operationId": "updateIacSettingsForGroup", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the group whose Infrastructure as Code settings are getting updated", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/GroupIacSettingsRequest" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "$ref": "#/components/schemas/GroupIacSettingsResponse" + }, "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "The Infrastructure as Code Settings of the group were updated.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update the Infrastructure as Code Settings for a group", + "tags": [ + "IacSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-resource": "iac_settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2021-12-09", + "x-stability-level": "stable" + } + }, + "/groups/{group_id}/settings/pull_request_template": { + "delete": { + "description": "Delete your groups pull request template. This means Snyk pull requests will start to use the default template for this group.", + "operationId": "deletePullRequestTemplate", + "parameters": [ + { + "description": "Snyk Group ID", + "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete pull request template for group", + "tags": [ + "Pull Request Templates" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-10-13~beta", + "2024-05-08" + ], + "x-snyk-api-resource": "pull-request-templates", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-08", + "x-stability-level": "stable" + }, + "get": { + "description": "Get your groups pull request template", + "operationId": "getPullRequestTemplate", + "parameters": [ + { + "description": "Snyk Group ID", + "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { + "data": { "additionalProperties": false, - "example": { - "version": "1.0" - }, + "description": "Fetch a pull request template response", "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" + "attributes": { + "$ref": "#/components/schemas/PullRequestTemplateAttributes" + }, + "id": { + "$ref": "#/components/schemas/PullRequsetTemplateId" + }, + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "type", + "attributes" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Fetch Pull Request Template for group.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, - "409": { + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get pull request template for group", + "tags": [ + "Pull Request Templates" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-10-13~beta", + "2024-05-08" + ], + "x-snyk-api-resource": "pull-request-templates", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-08", + "x-stability-level": "stable" + }, + "post": { + "description": "Configures a group level pull request template that will be used on any org or project within that group", + "operationId": "createOrUpdatePullRequestTemplate", + "parameters": [ + { + "description": "Snyk Group ID", + "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/PullRequestTemplateAttributes" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" + "data": { + "additionalProperties": false, + "description": "Create or update Pull Request Template response", + "properties": { + "attributes": { + "$ref": "#/components/schemas/PullRequestTemplateAttributes" }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } + "id": { + "$ref": "#/components/schemas/PullRequsetTemplateId" }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "type", + "attributes" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Pull Request Template created for group.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Create or update pull request template for group", + "tags": [ + "Pull Request Templates" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-10-13~beta", + "2024-05-08" + ], + "x-snyk-api-resource": "pull-request-templates", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-08", + "x-stability-level": "stable" + } + }, + "/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": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/SSOConnection" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "List of SSO connections is returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Manage client secret for non-interactive Snyk App installations.", + "summary": "Get all SSO connections for a group", "tags": [ - "Apps" + "Groups" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" + "2022-01-31~experimental", + "2023-01-30~beta" ], - "x-snyk-api-version": "2024-05-23" - }, - "x-snyk-api-resource": "app_installs" + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-01-30~beta", + "x-stability-level": "beta" + } }, - "/groups/{group_id}/audit_logs/search": { + "/groups/{group_id}/sso_connections/{sso_id}/users": { "get": { - "description": "Search audit logs for a Group. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Some Organization level events are supported as well as the following\nGroup level events:\n - api.access\n - group.cloud_config.settings.edit\n - group.create\n - group.delete\n - group.edit\n - group.notification_settings.edit\n - group.org.add\n - group.org.remove\n - group.policy.create\n - group.policy.delete\n - group.policy.edit\n - group.request_access_settings.edit\n - group.role.create\n - group.role.delete\n - group.role.edit\n - group.service_account.create\n - group.service_account.delete\n - group.service_account.edit\n - group.settings.edit\n - group.settings.feature_flag.edit\n - group.sso.add\n - group.sso.auth0_connection.create\n - group.sso.auth0_connection.edit\n - group.sso.create\n - group.sso.delete\n - group.sso.edit\n - group.sso.membership.sync\n - group.sso.remove\n - group.tag.create\n - group.tag.delete\n - group.user.add\n - group.user.remove\n - group.user.role.edit\n", - "operationId": "listGroupAuditLogs", + "description": "Returns a list of users for a SSO connection", + "operationId": "listGroupSsoConnectionUsers", "parameters": [ { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The ID of the Group.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Cursor" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/Size" + "$ref": "#/components/parameters/GroupId" }, { - "$ref": "#/components/parameters/SortOrder" + "$ref": "#/components/parameters/SsoId" }, { - "description": "Filter logs by user ID.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", - "in": "query", - "name": "user_id", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/StartingAfter" }, { - "description": "Filter logs by project ID.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", - "in": "query", - "name": "project_id", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/EndingBefore" }, { - "$ref": "#/components/parameters/Events" + "$ref": "#/components/parameters/Limit" }, { - "$ref": "#/components/parameters/ExcludeEvents" + "$ref": "#/components/parameters/Version" } ], "responses": { @@ -14117,10 +15554,12 @@ "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/AuditLogSearch" + "items": { + "$ref": "#/components/schemas/User" + }, + "type": "array" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" @@ -14131,22 +15570,18 @@ }, "required": [ "jsonapi", - "data" + "data", + "links" ], "type": "object" } } }, - "description": "Group Audit Logs.", + "description": "List of users is returned", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "schema": { - "type": "string" - } - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -14180,1995 +15615,1527 @@ "$ref": "#/components/responses/500" } }, - "summary": "Search Group audit logs.", + "summary": "Get all users using a given SSO connection", "tags": [ - "Audit Logs" + "Groups" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-09-11", - "2024-04-29" + "2022-01-31~experimental", + "2023-01-30~beta" ], - "x-snyk-api-version": "2024-04-29" - }, - "x-snyk-api-resource": "audit-logs", - "x-snyk-resource-singleton": true + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-01-30~beta", + "x-stability-level": "beta" + } }, - "/groups/{group_id}/issues": { - "get": { - "description": "Get a list of a group's issues.", - "operationId": "listGroupIssues", + "/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/Version" + "$ref": "#/components/parameters/GroupId" }, { - "$ref": "#/components/parameters/StartingAfter" + "$ref": "#/components/parameters/SsoId" }, { - "$ref": "#/components/parameters/EndingBefore" + "$ref": "#/components/parameters/UserId20230130" }, { - "$ref": "#/components/parameters/Limit" + "$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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-01-31~experimental", + "2023-01-30~beta" + ], + "x-snyk-api-resource": "groups", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-01-30~beta", + "x-stability-level": "beta" + } + }, + "/groups/{group_id}/users/{id}": { + "patch": { + "description": "Update a user's membership of the group. \n\nTo remove a user's membership, provide 'null' as the membership parameter (see example).\n\nAt present, only removing memberships is supported by this endpoint. To update a user's group membership, please use\nthe UI or legacy API.\n", + "operationId": "updateUser", + "parameters": [ { - "description": "Group ID", + "description": "The id of the group", "in": "path", "name": "group_id", "required": true, "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", "format": "uuid", "type": "string" } }, { - "$ref": "#/components/parameters/ScanItemId" - }, - { - "$ref": "#/components/parameters/ScanItemType" + "description": "The id of the user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "$ref": "#/components/parameters/Type" - }, - { - "$ref": "#/components/parameters/UpdatedBefore" + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "example": { + "data": { + "attributes": { + "membership": null + }, + "id": "55a348e2-c3ad-4bbc-b40e-9b232d1f4122", + "type": "user" + } + }, + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/UserPatchRequestBody" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" }, - { - "$ref": "#/components/parameters/UpdatedAfter" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update a user's role in a group", + "tags": [ + "Users" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-10-06~beta" + ], + "x-snyk-api-resource": "users", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2022-10-06~beta", + "x-stability-level": "beta" + } + }, + "/learn/catalog": { + "get": { + "description": "List Snyk Learn's catalog resources", + "operationId": "listLearnCatalog", + "parameters": [ { - "$ref": "#/components/parameters/CreatedBefore" + "$ref": "#/components/parameters/ApiVersion" }, { - "$ref": "#/components/parameters/CreatedAfter" + "$ref": "#/components/parameters/ContentSource" }, { - "$ref": "#/components/parameters/EffectiveSeverityLevel" + "$ref": "#/components/parameters/Limit" }, { - "$ref": "#/components/parameters/Status" + "$ref": "#/components/parameters/StartingAfter" }, { - "$ref": "#/components/parameters/Ignored" + "$ref": "#/components/parameters/EndingBefore" } ], "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" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/EducationResource" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ - "jsonapi", - "errors" + "data", + "links", + "jsonapi" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Returns a list of catalog resources", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "List Snyk Learn's resources", + "tags": [ + "Catalog Resource" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-13~experimental", + "2024-10-13~beta" + ], + "x-snyk-api-resource": "catalog", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-10-13~beta", + "x-stability-level": "beta" + } + }, + "/openapi": { + "get": { + "description": "List available versions of OpenAPI specification", + "operationId": "listAPIVersions", + "responses": { + "200": { + "content": { + "application/json": { "schema": { - "format": "date", - "type": "string" + "items": { + "type": "string" + }, + "type": "array" } } + }, + "description": "List of available versions is returned", + "headers": { + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + } } }, - "403": { + "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 paginated list of organizations you have access to.", + "operationId": "listOrgs", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "If set, only return organizations within the specified group", + "in": "query", + "name": "group_id", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "If true, only return organizations that are not part of a group.", + "in": "query", + "name": "is_personal", + "schema": { + "type": "boolean" + } + }, + { + "description": "Only return orgs whose slug exactly matches this value.", + "in": "query", + "name": "slug", + "schema": { + "maxLength": 100, + "pattern": "^[\\w.-]+$", + "type": "string" + } + }, + { + "description": "Only return orgs whose name contains this value.", + "in": "query", + "name": "name", + "schema": { + "maxLength": 100, + "type": "string" + } + }, + { + "description": "Expand the specified related resources in the response to include their attributes.", + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "member_role" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/OrgWithRelationships" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "A list of organizations you have access to.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "List accessible organizations", + "tags": [ + "Orgs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-04-06~experimental", + "2022-12-15~beta", + "2023-05-29", + "2024-02-28" + ], + "x-snyk-api-resource": "orgs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-02-28", + "x-stability-level": "stable" + } + }, + "/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": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/Org" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Org is returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get an org", + "tags": [ + "Orgs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-02-16~experimental", + "2022-04-06~experimental", + "2022-12-15~beta" + ], + "x-snyk-api-resource": "orgs", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2022-12-15~beta", + "x-stability-level": "beta" + }, + "patch": { + "description": "Update the details of an organization", + "operationId": "updateOrg", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/PathOrgId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/OrgUpdateAttributes" + }, + "id": { + "description": "The ID of the resource.", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "The type of the resource.", + "enum": [ + "org" + ], + "example": "org", + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { + "data": { "additionalProperties": false, - "example": { - "version": "1.0" - }, + "description": "org resource object", "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "attributes": { + "$ref": "#/components/schemas/OrgAttributes" + }, + "id": { + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", + "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/OrgRelationships" + }, + "type": { + "enum": [ + "org" + ], + "example": "org", "type": "string" } }, "required": [ - "version" + "id", + "type" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Instance of org is updated", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } - } - }, - "summary": "Get issues by group ID", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2023-03-10~experimental", - "2023-09-29~beta", - "2024-01-23" + }, + "204": { + "$ref": "#/components/responses/204" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update organization", + "tags": [ + "Orgs" ], - "x-snyk-api-version": "2024-01-23" - }, - "x-snyk-api-resource": "issues" + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-04-06~experimental", + "2022-12-15~beta", + "2023-05-29", + "2024-02-28" + ], + "x-snyk-api-resource": "orgs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-02-28", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/issues/{issue_id}": { + "/orgs/{org_id}/app_bots": { "get": { - "description": "Get an issue", - "operationId": "getGroupIssueByIssueID", + "deprecated": true, + "description": "Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.", + "operationId": "getAppBots", "parameters": [ { - "$ref": "#/components/parameters/Version" + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { - "description": "Group ID", + "description": "Organization ID", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", "format": "uuid", "type": "string" } }, { - "$ref": "#/components/parameters/PathIssueId20240123" + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" } ], "responses": { "200": { - "$ref": "#/components/responses/GetIssue20020240123" - }, - "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppBot" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "A list of app bots authorized to the specified organization", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Get a list of app bots authorized to an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-resource": "app_bots", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/app_bots/{bot_id}": { + "delete": { + "deprecated": true, + "description": "Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.", + "operationId": "deleteAppBot", + "parameters": [ + { + "description": "The ID of the app bot", + "in": "path", + "name": "bot_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Organization ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The app bot has been deauthorized", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date", "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__0" + }, "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Revoke app bot authorization", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-resource": "app_bots", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/apps": { + "get": { + "deprecated": true, + "description": "Get a list of apps created by an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", + "operationId": "getApps", + "parameters": [ + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppData20220311" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "A list of apps created by the specified organization", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Get a list of apps created by an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" + }, + "post": { + "deprecated": true, + "description": "Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", + "operationId": "createApp", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/AppPostRequest20220311" + } + } + }, + "description": "app to be created" + }, + "responses": { + "201": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" + "$ref": "#/components/schemas/AppPostResponse20220311" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Created Snyk App successfully", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Create a new app for an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/apps/creations": { + "get": { + "description": "Get a list of apps created by an organization.", + "operationId": "getOrgApps", + "parameters": [ + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "A list of apps created by the specified organization", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Get a list of apps created by an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03" + ], + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" + }, + "post": { + "description": "Create a new Snyk App for an organization.", + "operationId": "createOrgApp", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/AppPostRequest" + } + } + }, + "description": "Snyk App details for app to be created." + }, + "responses": { + "201": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" + "$ref": "#/components/schemas/AppPostResponse" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Created Snyk App successfully.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Create a new Snyk App for an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03" + ], + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/apps/creations/{app_id}": { + "delete": { + "description": "Delete an app by its App ID.", + "operationId": "deleteAppByID", + "parameters": [ + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/AppId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "The app has been deleted", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" } }, - "summary": "Get an issue", + "summary": "Delete an app by its App ID.", "tags": [ - "Issues" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2024-01-23" + "2023-06-19~experimental", + "2023-11-03" ], - "x-snyk-api-version": "2024-01-23" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" }, - "x-snyk-api-resource": "issues" - }, - "/groups/{group_id}/memberships": { "get": { - "description": "Returns all memberships of the group", - "operationId": "listGroupMemberships", + "description": "Get a Snyk App by its App ID.", + "operationId": "getAppByID", "parameters": [ { - "$ref": "#/components/parameters/GroupId" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "$ref": "#/components/parameters/Limit" + "$ref": "#/components/parameters/AppId" }, { "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/SortBy" - }, - { - "$ref": "#/components/parameters/SortOrder" - }, - { - "$ref": "#/components/parameters/EmailFilter" - }, - { - "$ref": "#/components/parameters/UserIdFilter" - }, - { - "$ref": "#/components/parameters/UsernameFilter" - }, - { - "$ref": "#/components/parameters/RoleFilter" - }, - { - "$ref": "#/components/parameters/IncludeGroupMembershipCount" } ], "responses": { @@ -16176,27 +17143,23 @@ "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/GroupMembershipResponseData" + "$ref": "#/components/schemas/AppData" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "data", - "links" - ], "type": "object" } } }, - "description": "List of group memberships is returned", + "description": "The requested app", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -16219,79 +17182,94 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Get all memberships of the group", + "summary": "Get a Snyk App by its App ID.", "tags": [ - "Groups" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2024-05-09~experimental", - "2024-08-25" + "2023-06-19~experimental", + "2023-11-03" ], - "x-snyk-api-version": "2024-08-25" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" }, - "post": { - "description": "Create a group membership for a user with role", - "operationId": "createGroupMembership", + "patch": { + "description": "Update app creation attributes with App ID.", + "operationId": "updateAppCreationByID", "parameters": [ { - "$ref": "#/components/parameters/GroupId" + "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/Version" + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/AppId" } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/CreateGroupMembershipRequestBody" + "$ref": "#/components/schemas/AppPatchRequest" } } } }, "responses": { - "201": { + "200": { "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/GroupMembership" + "$ref": "#/components/schemas/AppData" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" + "$ref": "#/components/schemas/SelfLink" } }, "type": "object" } } }, - "description": "Membership for the group was created", + "description": "The update app.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -16310,57 +17288,136 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" }, "409": { "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Create a group membership for a user with role", + "summary": "Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID.", "tags": [ - "Groups" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2024-05-09~experimental", - "2024-08-25" + "2023-06-19~experimental", + "2023-11-03" ], - "x-snyk-api-version": "2024-08-25" - }, - "x-snyk-api-resource": "groups" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/memberships/{membership_id}": { - "delete": { - "description": "Deletes a membership from a group", - "operationId": "deleteGroupMembership", + "/orgs/{org_id}/apps/creations/{app_id}/secrets": { + "post": { + "description": "Manage client secret for the Snyk App.", + "operationId": "manageAppCreationSecret", "parameters": [ { - "$ref": "#/components/parameters/GroupId" - }, - { - "$ref": "#/components/parameters/MembershipId" + "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/Cascade" - }, + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/AppId" } ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", + "enum": [ + "replace", + "create", + "delete" + ], + "type": "string" + }, + "secret": { + "description": "Secret to delete when using `delete` mode", + "type": "string" + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "type": { + "enum": [ + "app" + ], + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, "responses": { - "204": { - "description": "group membership is deleted from Group", + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppDataWithSecret" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Secret has been updated.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -16383,110 +17440,72 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" }, "409": { "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete a membership from a group", - "tags": [ - "Groups" - ], - "x-snyk-api-releases": [ - "2024-05-09~experimental", - "2024-08-25" - ], - "x-snyk-api-version": "2024-08-25" - }, - "patch": { - "description": "Update a role from a group membership", - "operationId": "updateGroupUserMembership", - "parameters": [ - { - "$ref": "#/components/parameters/GroupId" - }, - { - "$ref": "#/components/parameters/MembershipId" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/MembershipPatchRequestBody" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Update a role from a group membership", + "summary": "Manage client secret for the Snyk App.", "tags": [ - "Groups" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2024-05-09~experimental", - "2024-08-25" + "2023-06-19~experimental", + "2023-11-03" ], - "x-snyk-api-version": "2024-08-25" - }, - "x-snyk-api-resource": "groups" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/org_memberships": { + "/orgs/{org_id}/apps/installs": { "get": { - "description": "Get list of org memberships of a group user", - "operationId": "listGroupUserOrgMemberships", + "description": "Get a list of apps installed for an organization.", + "operationId": "getAppInstallsForOrg", "parameters": [ { - "$ref": "#/components/parameters/GroupId" - }, - { - "$ref": "#/components/parameters/UserId" + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { - "$ref": "#/components/parameters/OrgName" + "description": "Organization ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "$ref": "#/components/parameters/RoleFilter" + "$ref": "#/components/parameters/Version" }, { "$ref": "#/components/parameters/StartingAfter" @@ -16496,9 +17515,6 @@ }, { "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/Version" } ], "responses": { @@ -16506,10 +17522,11 @@ "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, "properties": { "data": { "items": { - "$ref": "#/components/schemas/GroupMembershipOrgMembership" + "$ref": "#/components/schemas/AppInstallData" }, "type": "array" }, @@ -16517,28 +17534,19 @@ "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" - }, - "meta": { - "properties": { - "org_membership_count": { - "description": "Org memberships for this user within this group.", - "type": "number" - } - }, - "type": "object" + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ - "jsonapi", "data", + "jsonapi", "links" ], "type": "object" } } }, - "description": "A list of org memberships is returned", + "description": "A list of apps installed for the specified organization.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -16561,75 +17569,133 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" }, "409": { "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Get list of org memberships of a group user", + "summary": "Get a list of apps installed for an organization.", "tags": [ - "Groups" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2024-05-07~experimental", - "2024-08-25" + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" ], - "x-snyk-api-version": "2024-08-25" + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" }, - "x-snyk-api-resource": "groups" - }, - "/groups/{group_id}/orgs": { - "get": { - "description": "Get a paginated list of all the organizations belonging to the group.\nBy default, this endpoint returns the organizations in alphabetical order of their name.", - "operationId": "listOrgsInGroup", + "post": { + "description": "Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.", + "operationId": "createOrgAppInstall", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/PathGroupId" - }, - { - "$ref": "#/components/parameters/QueryNameFilter" - }, - { - "$ref": "#/components/parameters/QuerySlugFilter" + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } } ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "properties": { + "type": { + "enum": [ + "app_install" + ], + "example": "app_install", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "additionalProperties": false, + "properties": { + "app": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "id": { + "$ref": "#/components/schemas/Uuid" + }, + "type": { + "enum": [ + "app" + ], + "example": "app", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "required": [ + "app" + ], + "type": "object" + } + }, + "required": [ + "data", + "relationships" + ], + "type": "object" + } + } + }, + "description": "App Install to be created" + }, "responses": { - "200": { + "201": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { - "items": { - "$ref": "#/components/schemas/Org" - }, - "type": "array" + "$ref": "#/components/schemas/AppInstallWithClient" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" @@ -16639,19 +17705,24 @@ } }, "required": [ - "jsonapi", "data", + "jsonapi", "links" ], "type": "object" } } }, - "description": "A list of organizations in the group.", + "description": "The newly created app install.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "schema": { + "type": "string" + } + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -16670,43 +17741,52 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "List all organizations in group", + "summary": "Install a Snyk Apps to this organization.", "tags": [ - "Orgs" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-10-24~experimental", - "2023-12-14~beta", - "2024-02-28" + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" ], - "x-snyk-api-version": "2024-02-28" - }, - "x-snyk-api-resource": "orgs" + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/service_accounts": { - "get": { - "description": "Get all service accounts for a group.", - "operationId": "getManyGroupServiceAccount", + "/orgs/{org_id}/apps/installs/{install_id}": { + "delete": { + "description": "Revoke app authorization for an Snyk Organization with install ID.", + "operationId": "deleteAppOrgInstallById", "parameters": [ { - "description": "The ID of the Snyk Group that owns the service accounts.", + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", @@ -16714,54 +17794,20 @@ } }, { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/InstallId" } ], "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/ServiceAccount" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of service accounts is returned.", + "204": { + "description": "The app install has been revoked.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, "location": { - "$ref": "#/components/headers/LocationHeader" + "schema": { + "type": "string" + } }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" @@ -16781,38 +17827,52 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Get a list of group service accounts.", + "summary": "Revoke app authorization for an Snyk Organization with install ID.", "tags": [ - "ServiceAccounts" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-09-07" + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" ], - "x-snyk-api-version": "2023-09-07" - }, + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/apps/installs/{install_id}/secrets": { "post": { - "description": "Create a service account for a group. The service account can be used to access the Snyk API.", - "operationId": "createGroupServiceAccount", + "description": "Manage client secret for non-interactive Snyk App installations.", + "operationId": "updateOrgAppInstallSecret", "parameters": [ { - "description": "The ID of the Snyk Group that is creating and owns the service account", + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", @@ -16820,7 +17880,7 @@ } }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/InstallId" } ], "requestBody": { @@ -16835,53 +17895,35 @@ "attributes": { "additionalProperties": false, "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", - "maximum": 86400, - "minimum": 3600, - "type": "number" - }, - "auth_type": { - "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", + "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": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" + "replace", + "create", + "delete" ], "type": "string" }, - "jwks_url": { - "description": "A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "name": { - "description": "A human-friendly name for the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the created service account should use.", - "format": "uuid", + "secret": { + "description": "Secret to delete when using `delete` mode", "type": "string" } }, "required": [ - "name", - "auth_type", - "role_id" + "mode" ], "type": "object" }, "type": { - "description": "The Resource type.", "enum": [ - "service_account" + "app" ], "type": "string" } }, "required": [ - "type", - "attributes" + "attributes", + "type" ], "type": "object" } @@ -16892,41 +17934,38 @@ "type": "object" } } - }, - "required": true + } }, "responses": { - "201": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/ServiceAccount" + "$ref": "#/components/schemas/AppInstallDataWithSecret" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "data" - ], "type": "object" } } }, - "description": "A new service account has been created", + "description": "Secret has been updated.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, "location": { - "$ref": "#/components/headers/LocationHeader" + "schema": { + "type": "string" + } }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" @@ -16946,48 +17985,53 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Create a service account for a group.", + "summary": "Manage client secret for non-interactive Snyk App installations.", "tags": [ - "ServiceAccounts" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-09-07" + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/service_accounts/{serviceaccount_id}": { + "/orgs/{org_id}/apps/{client_id}": { "delete": { - "description": "Permanently delete a group-level service account by its ID.", - "operationId": "deleteOneGroupServiceAccount", + "deprecated": true, + "description": "Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", + "operationId": "deleteApp", "parameters": [ { - "description": "The ID of the Snyk Group that owns the service account.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/Version" }, { - "description": "The ID of the service account.", + "description": "Org ID", "in": "path", - "name": "serviceaccount_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", @@ -16995,18 +18039,20 @@ } }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/ClientId" } ], "responses": { "204": { - "description": "Service account was successfully deleted.", + "description": "The app has been deleted", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, "location": { - "$ref": "#/components/headers/LocationHeader" + "schema": { + "type": "string" + } }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" @@ -17026,38 +18072,47 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Delete a group service account.", + "summary": "Delete an app", "tags": [ - "ServiceAccounts" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-09-07" + "2022-03-11" ], - "x-snyk-api-version": "2023-09-07" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" }, "get": { - "description": "Get a group-level service account by its ID.", - "operationId": "getOneGroupServiceAccount", + "deprecated": true, + "description": "Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", + "operationId": "getApp", "parameters": [ { - "description": "The ID of the Snyk Group that owns the service account.", + "description": "Org ID", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", @@ -17065,14 +18120,7 @@ } }, { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/ClientId" }, { "$ref": "#/components/parameters/Version" @@ -17086,32 +18134,24 @@ "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/ServiceAccount" + "$ref": "#/components/schemas/AppData20220311" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "data", - "links" - ], "type": "object" } } }, - "description": "Service account is returned.", + "description": "The requested app", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -17130,48 +18170,50 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Get a group service account.", + "summary": "Get an app by client id", "tags": [ - "ServiceAccounts" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-09-07" + "2022-03-11" ], - "x-snyk-api-version": "2023-09-07" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" }, "patch": { - "description": "Update the name of a group's service account by its ID.", - "operationId": "updateGroupServiceAccount", + "deprecated": true, + "description": "Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", + "operationId": "updateApp", "parameters": [ { - "description": "The ID of the Snyk Group that owns the service account.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/Version" }, { - "description": "The ID of the service account.", + "description": "Org ID", "in": "path", - "name": "serviceaccount_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", @@ -17179,60 +18221,17 @@ } }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/ClientId" } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "name": { - "description": "A human-friendly name for the service account. Must be unique within the group.", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The ID of the service account. Must match the id in the url path.", - "format": "uuid", - "type": "string" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" + "$ref": "#/components/schemas/AppPatchRequest20220311" } } - }, - "required": true + } }, "responses": { "200": { @@ -17242,32 +18241,24 @@ "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/ServiceAccount" + "$ref": "#/components/schemas/AppData20220311" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "data", - "links" - ], "type": "object" } } }, - "description": "Service account is returned.", + "description": "The update app.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -17286,51 +18277,52 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Update a group service account.", + "summary": "Update app attributes that are name, redirect URIs, and access token time to live", "tags": [ - "ServiceAccounts" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-09-07" + "2022-03-11" ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets": { + "/orgs/{org_id}/apps/{client_id}/secrets": { "post": { - "description": "Manage the client secret of a group service account by the service account ID.", - "operationId": "updateServiceAccountSecret", + "deprecated": true, + "description": "Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead.", + "operationId": "manageSecrets", "parameters": [ { - "description": "The ID of the Snyk Group that owns the service account.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/Version" }, { - "description": "The ID of the service account.", + "description": "Org ID", "in": "path", - "name": "serviceaccount_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", @@ -17338,7 +18330,7 @@ } }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/ClientId" } ], "requestBody": { @@ -17347,54 +18339,27 @@ "schema": { "additionalProperties": false, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "type" + "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": "object" + "type": "string" + }, + "secret": { + "description": "Secret to delete when using `delete` mode", + "type": "string" } }, "required": [ - "data" + "mode" ], "type": "object" } } - }, - "required": true + } }, "responses": { "200": { @@ -17404,31 +18369,24 @@ "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/ServiceAccount" + "$ref": "#/components/schemas/AppDataWithSecret20220311" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "data" - ], "type": "object" } } }, - "description": "Service account client secret has been updated.", + "description": "Secrets have been updated.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -17447,49 +18405,109 @@ } }, "400": { - "$ref": "#/components/responses/400" + "$ref": "#/components/responses/400__0" }, "401": { - "$ref": "#/components/responses/401" + "$ref": "#/components/responses/401__0" }, "403": { "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/404" + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" }, "500": { - "$ref": "#/components/responses/500" + "$ref": "#/components/responses/500__0" } }, - "summary": "Manage a group service account's client secret.", + "summary": "Manage client secrets for an app.", "tags": [ - "ServiceAccounts" + "Apps" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-09-07" + "2022-03-11" ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" + "x-snyk-api-resource": "apps", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17", + "x-stability-level": "stable" + } }, - "/groups/{group_id}/settings/iac": { + "/orgs/{org_id}/audit_logs/search": { "get": { - "description": "Get the Infrastructure as Code Settings for a group.", - "operationId": "getIacSettingsForGroup", + "description": "Search audit logs for an Organization. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Supported event types:\n - api.access\n - org.app_bot.create\n - org.app.create\n - org.app.delete\n - org.app.edit\n - org.cloud_config.settings.edit\n - org.collection.create\n - org.collection.delete\n - org.collection.edit\n - org.create\n - org.delete\n - org.edit\n - org.ignore_policy.edit\n - org.integration.create\n - org.integration.delete\n - org.integration.edit\n - org.integration.settings.edit\n - org.language_settings.edit\n - org.notification_settings.edit\n - org.org_source.create\n - org.org_source.delete\n - org.org_source.edit\n - org.policy.edit\n - org.project_filter.create\n - org.project_filter.delete\n - org.project.add\n - org.project.attributes.edit\n - org.project.delete\n - org.project.edit\n - org.project.fix_pr.auto_open\n - org.project.fix_pr.manual_open\n - org.project.ignore.create\n - org.project.ignore.delete\n - org.project.ignore.edit\n - org.project.monitor\n - org.project.pr_check.edit\n - org.project.remove\n - org.project.settings.delete\n - org.project.settings.edit\n - org.project.stop_monitor\n - org.project.tag.add\n - org.project.tag.remove\n - org.project.test\n - org.request_access_settings.edit\n - org.sast_settings.edit\n - org.service_account.create\n - org.service_account.delete\n - org.service_account.edit\n - org.settings.feature_flag.edit\n - org.target.create\n - org.target.delete\n - org.user.add\n - org.user.invite\n - org.user.invite.accept\n - org.user.invite.revoke\n - org.user.invite_link.accept\n - org.user.invite_link.create\n - org.user.invite_link.revoke\n - org.user.leave\n - org.user.provision.accept\n - org.user.provision.create\n - org.user.provision.delete\n - org.user.remove\n - org.user.role.create\n - org.user.role.delete\n - org.user.role.details.edit\n - org.user.role.edit\n - org.user.role.permissions.edit\n - org.webhook.add\n - org.webhook.delete\n - user.org.notification_settings.edit\n", + "operationId": "listOrgAuditLogs", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "The id of the group whose Infrastructure as Code settings are requested", + "description": "The ID of the organization.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string" } + }, + { + "$ref": "#/components/parameters/Cursor" + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/Size" + }, + { + "description": "Order in which results are returned.", + "example": "ASC", + "in": "query", + "name": "sort_order", + "schema": { + "default": "DESC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + { + "description": "Filter logs by user ID.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "in": "query", + "name": "user_id", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Filter logs by project ID.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "in": "query", + "name": "project_id", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Events" + }, + { + "$ref": "#/components/parameters/ExcludeEvents" } ], "responses": { @@ -17500,7 +18518,7 @@ "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/GroupIacSettingsResponse" + "$ref": "#/components/schemas/AuditLogSearch" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" @@ -17511,18 +18529,22 @@ }, "required": [ "jsonapi", - "data", - "links" + "data" ], "type": "object" } } }, - "description": "The Infrastructure as Code Settings of the group.", + "description": "Organization Audit Logs.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "schema": { + "type": "string" + } + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -17556,74 +18578,157 @@ "$ref": "#/components/responses/500" } }, - "summary": "Get the Infrastructure as Code Settings for a group", + "summary": "Search Organization audit logs.", "tags": [ - "IacSettings" + "Audit Logs" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2021-12-09" + "2023-09-11", + "2024-04-29" ], - "x-snyk-api-version": "2021-12-09" - }, - "patch": { - "description": "Update the Infrastructure as Code Settings for a group.", - "operationId": "updateIacSettingsForGroup", + "x-snyk-api-resource": "audit-logs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-04-29", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/cloud/environments": { + "get": { + "description": "List environments for an organization", + "operationId": "listEnvironments", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "The id of the group whose Infrastructure as Code settings are getting updated", + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string" } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/GroupIacSettingsRequest" - } - }, - "type": "object" - } + }, + { + "description": "Return environments created after this date", + "example": "2022-05-06T12:25:15-04:00", + "in": "query", + "name": "created_after", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Return environments created before this date", + "example": "2022-05-06T12:25:15-04:00", + "in": "query", + "name": "created_before", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Return environments updated after this date", + "example": "2022-05-06T12:25:15-04:00", + "in": "query", + "name": "updated_after", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Return environments updated before this date", + "example": "2022-05-06T12:25:15-04:00", + "in": "query", + "name": "updated_before", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/NameInQuery" + }, + { + "$ref": "#/components/parameters/KindInQuery" + }, + { + "$ref": "#/components/parameters/StatusInQuery" + }, + { + "$ref": "#/components/parameters/IdInQuery" + }, + { + "description": "Filter environments by project ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", + "in": "query", + "name": "project_id", + "schema": { + "format": "uuid", + "type": "string" } + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" } - }, + ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/GroupIacSettingsResponse" + "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/Links" + "$ref": "#/components/schemas/PaginatedLinks" } }, - "required": [ - "jsonapi", - "data", - "links" - ], "type": "object" } } }, - "description": "The Infrastructure as Code Settings of the group were updated.", + "description": "Returns a list of environments", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -17657,44 +18762,142 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { "$ref": "#/components/responses/500" } }, - "summary": "Update the Infrastructure as Code Settings for a group", + "summary": "List Environments", "tags": [ - "IacSettings" + "Cloud" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2021-12-09" + "2022-04-13~experimental", + "2022-12-21~beta", + "2023-10-19~beta" ], - "x-snyk-api-version": "2021-12-09" + "x-snyk-api-resource": "environments", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-10-19~beta", + "x-stability-level": "beta" }, - "x-snyk-api-resource": "iac_settings" - }, - "/groups/{group_id}/settings/pull_request_template": { - "delete": { - "description": "Delete your groups pull request template. This means Snyk pull requests will start to use the default template for this group.", - "operationId": "deletePullRequestTemplate", + "post": { + "description": "Create a new environment and run a scan", + "operationId": "createEnvironment", "parameters": [ { - "description": "Snyk Group ID", - "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "$ref": "#/components/parameters/Version" + }, + { + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string" } - }, - { - "$ref": "#/components/parameters/Version" } ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/EnvironmentCreateAttributes" + }, + "type": { + "$ref": "#/components/schemas/EnvironmentType" + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, "responses": { - "204": { - "$ref": "#/components/responses/204" + "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" @@ -17708,29 +18911,42 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { "$ref": "#/components/responses/500" } }, - "summary": "Delete pull request template for group", + "summary": "Create New Environment", "tags": [ - "Pull Request Templates" + "Cloud" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-10-13~beta", - "2024-05-08" - ], - "x-snyk-api-version": "2024-05-08" - }, - "get": { - "description": "Get your groups pull request template", - "operationId": "getPullRequestTemplate", + "2022-04-13~experimental", + "2022-12-21~beta", + "2023-10-19~beta" + ], + "x-snyk-api-resource": "environments", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-10-19~beta", + "x-stability-level": "beta" + } + }, + "/orgs/{org_id}/cloud/environments/{environment_id}": { + "delete": { + "description": "Delete an environment", + "operationId": "deleteEnvironment", "parameters": [ { - "description": "Snyk Group ID", - "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "$ref": "#/components/parameters/Version" + }, + { + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", @@ -17738,18 +18954,124 @@ } }, { - "$ref": "#/components/parameters/Version" + "$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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-04-13~experimental", + "2022-12-21~beta", + "2023-10-19~beta" + ], + "x-snyk-api-resource": "environments", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-10-19~beta", + "x-stability-level": "beta" + }, + "patch": { + "description": "Update an environment", + "operationId": "updateEnvironment", + "parameters": [ { - "$ref": "#/components/parameters/StartingAfter" + "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/EndingBefore" + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "$ref": "#/components/parameters/Limit" + "$ref": "#/components/parameters/EnvironmentId" } ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/EnvironmentUpdateAttributes" + }, + "id": { + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/EnvironmentType" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -17758,22 +19080,26 @@ "properties": { "data": { "additionalProperties": false, - "description": "Fetch a pull request template response", + "description": "environment resource object", "properties": { "attributes": { - "$ref": "#/components/schemas/PullRequestTemplateAttributes" + "$ref": "#/components/schemas/EnvironmentAttributes" }, "id": { - "$ref": "#/components/schemas/PullRequsetTemplateId" + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", + "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/EnvironmentRelationships" }, "type": { - "$ref": "#/components/schemas/Types" + "$ref": "#/components/schemas/EnvironmentType" } }, "required": [ "id", - "type", - "attributes" + "type" ], "type": "object" }, @@ -17788,14 +19114,11 @@ } } }, - "description": "Fetch Pull Request Template for group.", + "description": "Updated an environment successfully", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -17825,37 +19148,47 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { "$ref": "#/components/responses/500" } }, - "summary": "Get pull request template for group", + "summary": "Update Environment", "tags": [ - "Pull Request Templates" + "Cloud" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-10-13~beta", - "2024-05-08" - ], - "x-snyk-api-version": "2024-05-08" - }, + "2022-04-13~experimental", + "2022-12-21~beta", + "2023-10-19~beta" + ], + "x-snyk-api-resource": "environments", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-10-19~beta", + "x-stability-level": "beta" + } + }, + "/orgs/{org_id}/cloud/permissions": { "post": { - "description": "Configures a group level pull request template that will be used on any org or project within that group", - "operationId": "createOrUpdatePullRequestTemplate", + "description": "Generate IAC template for Snyk to access your cloud resources", + "operationId": "getPermissions", "parameters": [ { - "description": "Snyk Group ID", - "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "$ref": "#/components/parameters/Version" + }, + { + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", "in": "path", - "name": "group_id", + "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string" } - }, - { - "$ref": "#/components/parameters/Version" } ], "requestBody": { @@ -17867,10 +19200,11 @@ "additionalProperties": false, "properties": { "attributes": { - "$ref": "#/components/schemas/PullRequestTemplateAttributes" + "$ref": "#/components/schemas/CreatePermissionsAttributes" }, "type": { - "$ref": "#/components/schemas/Types" + "example": "permission", + "type": "string" } }, "required": [ @@ -17886,8 +19220,7 @@ "type": "object" } } - }, - "required": true + } }, "responses": { "201": { @@ -17897,22 +19230,25 @@ "properties": { "data": { "additionalProperties": false, - "description": "Create or update Pull Request Template response", + "description": "permissions resource object", "properties": { "attributes": { - "$ref": "#/components/schemas/PullRequestTemplateAttributes" + "$ref": "#/components/schemas/PermissionsAttributes" }, "id": { - "$ref": "#/components/schemas/PullRequsetTemplateId" + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", + "type": "string" }, "type": { - "$ref": "#/components/schemas/Types" + "example": "permission", + "type": "string" } }, "required": [ + "attributes", "id", - "type", - "attributes" + "type" ], "type": "object" }, @@ -17922,12 +19258,11 @@ "links": { "$ref": "#/components/schemas/PaginatedLinks" } - }, - "type": "object" + } } } }, - "description": "Pull Request Template created for group.", + "description": "Created permissions successfully", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -17964,186 +19299,86 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { "$ref": "#/components/responses/500" } }, - "summary": "Create or update pull request template for group", + "summary": "Generate Cloud Provider Permissions", "tags": [ - "Pull Request Templates" + "Cloud" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-10-13~beta", - "2024-05-08" - ], - "x-snyk-api-version": "2024-05-08" - }, - "x-snyk-api-resource": "pull-request-templates" - }, - "/openapi": { - "get": { - "description": "List available versions of OpenAPI specification", - "operationId": "listAPIVersions", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - } - }, - "description": "List of available versions is returned", - "headers": { - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "security": [], - "tags": [ - "OpenAPI" - ] + "2022-04-13~experimental", + "2022-12-21~beta", + "2023-10-19~beta" + ], + "x-snyk-api-resource": "permissions", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-10-19~beta", + "x-stability-level": "beta" } }, - "/openapi/{version}": { + "/orgs/{org_id}/cloud/resources": { "get": { - "description": "Get OpenAPI specification effective at version.", - "operationId": "getAPIVersion", + "description": "List resources for an organization", + "operationId": "listResources", "parameters": [ { - "description": "The requested version of the API", + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", "in": "path", - "name": "version", + "name": "org_id", "required": true, "schema": { + "format": "uuid", "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" + { + "$ref": "#/components/parameters/EnvironmentIdQuery" }, - "401": { - "$ref": "#/components/responses/401" + { + "$ref": "#/components/parameters/ResourceType" }, - "404": { - "$ref": "#/components/responses/404" + { + "$ref": "#/components/parameters/ResourceId" }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "security": [], - "tags": [ - "OpenAPI" - ] - } - }, - "/orgs": { - "get": { - "description": "Get a paginated list of organizations you have access to.", - "operationId": "listOrgs", - "parameters": [ { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/NativeId" }, { - "$ref": "#/components/parameters/StartingAfter" + "$ref": "#/components/parameters/Id" }, { - "$ref": "#/components/parameters/EndingBefore" + "$ref": "#/components/parameters/Platform" }, { - "$ref": "#/components/parameters/Limit" + "$ref": "#/components/parameters/Name" }, { - "description": "If set, only return organizations within the specified group", - "in": "query", - "name": "group_id", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/Kind" }, { - "description": "If true, only return organizations that are not part of a group.", - "in": "query", - "name": "is_personal", - "schema": { - "type": "boolean" - } + "$ref": "#/components/parameters/Location" }, { - "description": "Only return orgs whose slug exactly matches this value.", - "in": "query", - "name": "slug", - "schema": { - "maxLength": 100, - "pattern": "^[\\w.-]+$", - "type": "string" - } + "$ref": "#/components/parameters/Removed" }, { - "description": "Only return orgs whose name contains this value.", - "in": "query", - "name": "name", - "schema": { - "maxLength": 100, - "type": "string" - } + "$ref": "#/components/parameters/Version" }, { - "description": "Expand the specified related resources in the response to include their attributes.", - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "member_role" - ], - "type": "string" - }, - "type": "array" - } + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" } ], "responses": { @@ -18151,11 +19386,31 @@ "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { "items": { - "$ref": "#/components/schemas/OrgWithRelationships" + "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" }, @@ -18166,16 +19421,11 @@ "$ref": "#/components/schemas/PaginatedLinks" } }, - "required": [ - "jsonapi", - "data", - "links" - ], "type": "object" } } }, - "description": "A list of organizations you have access to.", + "description": "Returns a list of resources", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -18209,39 +19459,53 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { "$ref": "#/components/responses/500" } }, - "summary": "List accessible organizations", + "summary": "List Resources", "tags": [ - "Orgs" + "Cloud" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2022-04-06~experimental", - "2022-12-15~beta", - "2023-05-29", - "2024-02-28" - ], - "x-snyk-api-version": "2024-02-28" - }, - "x-snyk-api-resource": "orgs" + "2022-04-13~experimental", + "2022-12-21~beta", + "2023-10-19~beta" + ], + "x-snyk-api-resource": "resources", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-10-19~beta", + "x-stability-level": "beta" + } }, - "/orgs/{org_id}": { + "/orgs/{org_id}/cloud/scans": { "get": { - "description": "Get the full details of an organization.", - "operationId": "getOrg", + "description": "List scans for an organization", + "operationId": "listScan", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "Unique identifier for org", + "$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": { - "example": "b667f176-df52-4b0a-9954-117af6b05ab7", "format": "uuid", "type": "string" } @@ -18254,20 +19518,44 @@ "schema": { "properties": { "data": { - "$ref": "#/components/schemas/Org" + "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/SelfLink" + "$ref": "#/components/schemas/PaginatedLinks" } }, "type": "object" } } }, - "description": "Returns an instance of an organization", + "description": "Returns a list of scan instances", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -18308,26 +19596,37 @@ "$ref": "#/components/responses/500" } }, - "summary": "Get organization", + "summary": "List Scans", "tags": [ - "Orgs" + "Cloud" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2022-04-06~experimental", - "2022-12-15~beta", - "2023-05-29" + "2022-04-13~experimental", + "2022-12-21~beta" ], - "x-snyk-api-version": "2023-05-29" + "x-snyk-api-resource": "scans", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2022-12-21~beta", + "x-stability-level": "beta" }, - "patch": { - "description": "Update the details of an organization", - "operationId": "updateOrg", + "post": { + "description": "Create and trigger a new scan for an environment", + "operationId": "createScan", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/PathOrgId" + "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } } ], "requestBody": { @@ -18339,26 +19638,17 @@ "additionalProperties": false, "properties": { "attributes": { - "$ref": "#/components/schemas/OrgUpdateAttributes" + "$ref": "#/components/schemas/ScanCreateAttributes" }, - "id": { - "description": "The ID of the resource.", - "format": "uuid", - "type": "string" + "relationships": { + "$ref": "#/components/schemas/ScanCreateRelationships" }, "type": { - "description": "The type of the resource.", - "enum": [ - "org" - ], - "example": "org", - "type": "string" + "$ref": "#/components/schemas/ScanType" } }, "required": [ - "id", - "type", - "attributes" + "type" ], "type": "object" } @@ -18372,32 +19662,29 @@ } }, "responses": { - "200": { + "201": { "content": { "application/vnd.api+json": { "schema": { "properties": { "data": { "additionalProperties": false, - "description": "org resource object", + "description": "Scan resource object", "properties": { "attributes": { - "$ref": "#/components/schemas/OrgAttributes" + "$ref": "#/components/schemas/ScanAttributes" }, "id": { + "description": "Scan ID", "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string" }, "relationships": { - "$ref": "#/components/schemas/OrgRelationships" + "$ref": "#/components/schemas/ScanRelationships" }, "type": { - "enum": [ - "org" - ], - "example": "org", - "type": "string" + "$ref": "#/components/schemas/ScanType" } }, "required": [ @@ -18410,18 +19697,20 @@ "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/SelfLink" + "$ref": "#/components/schemas/PaginatedLinks" } - }, - "type": "object" + } } } }, - "description": "Instance of org is updated", + "description": "Created scan successfully", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -18439,9 +19728,6 @@ } } }, - "204": { - "$ref": "#/components/responses/204" - }, "400": { "$ref": "#/components/responses/400" }, @@ -18461,44 +19747,32 @@ "$ref": "#/components/responses/500" } }, - "summary": "Update organization", + "summary": "Create Scan", "tags": [ - "Orgs" + "Cloud" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2022-04-06~experimental", - "2022-12-15~beta", - "2023-05-29", - "2024-02-28" + "2022-04-13~experimental", + "2022-12-21~beta" ], - "x-snyk-api-version": "2024-02-28" - }, - "x-snyk-api-resource": "orgs" + "x-snyk-api-resource": "scans", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2022-12-21~beta", + "x-stability-level": "beta" + } }, - "/orgs/{org_id}/app_bots": { + "/orgs/{org_id}/cloud/scans/{scan_id}": { "get": { - "deprecated": true, - "description": "Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.", - "operationId": "getAppBots", + "description": "Get a single scan for an organization", + "operationId": "getScan", "parameters": [ { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "$ref": "#/components/parameters/Version" }, { "description": "Organization ID", + "example": "9a46d918-8764-458c-1234-0987abcd6543", "in": "path", "name": "org_id", "required": true, @@ -18507,9 +19781,124 @@ "type": "string" } }, + { + "$ref": "#/components/parameters/ScanId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "properties": { + "attributes": { + "$ref": "#/components/schemas/ScanAttributes" + }, + "id": { + "description": "Scan ID", + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", + "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/ScanRelationships" + }, + "type": { + "$ref": "#/components/schemas/ScanType" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "type": "object" + } + } + }, + "description": "Returns a single scan instance", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get scan", + "tags": [ + "Cloud" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-12-21~beta" + ], + "x-snyk-api-resource": "scans", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2022-12-21~beta", + "x-stability-level": "beta" + } + }, + "/orgs/{org_id}/collections": { + "get": { + "description": "Return a list of organization's collections with issues counts and projects count.", + "operationId": "getCollections", + "parameters": [ { "$ref": "#/components/parameters/Version" }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, { "$ref": "#/components/parameters/StartingAfter" }, @@ -18518,6 +19907,51 @@ }, { "$ref": "#/components/parameters/Limit" + }, + { + "description": "Return collections sorted by the specified attributes", + "in": "query", + "name": "sort", + "schema": { + "enum": [ + "name", + "projectsCount", + "issues" + ], + "type": "string" + } + }, + { + "description": "Return collections sorted in the specified direction", + "in": "query", + "name": "direction", + "schema": { + "default": "DESC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Return collections which names include the provided string", + "in": "query", + "name": "name", + "schema": { + "maxLength": 255, + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Return collections where is_generated matches the provided boolean", + "in": "query", + "name": "is_generated", + "schema": { + "type": "boolean" + } } ], "responses": { @@ -18525,11 +19959,10 @@ "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { "items": { - "$ref": "#/components/schemas/AppBot" + "$ref": "#/components/schemas/CollectionResponse" }, "type": "array" }, @@ -18540,16 +19973,11 @@ "$ref": "#/components/schemas/PaginatedLinks" } }, - "required": [ - "data", - "jsonapi", - "links" - ], "type": "object" } } }, - "description": "A list of app bots authorized to the specified organization", + "description": "Returns a list of collections", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -18572,1152 +20000,1220 @@ } }, "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get collections", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + }, + "post": { + "description": "Create a collection", + "operationId": "createCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CreateCollectionRequest" + } + } + } + }, + "responses": { + "201": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { + "data": { "additionalProperties": false, - "example": { - "version": "1.0" - }, + "description": "collection resource object", "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "attributes": { + "$ref": "#/components/schemas/CollectionAttributes" + }, + "id": { + "format": "uuid", "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/CollectionRelationships" + }, + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "attributes", + "relationships" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Returned collection", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "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": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Create a collection", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/collections/{collection_id}": { + "delete": { + "description": "Delete a collection", + "operationId": "deleteCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/CollectionId" + } + ], + "responses": { + "204": { + "description": "Collection was deleted successfully", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete a collection", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + }, + "get": { + "description": "Get a collection", + "operationId": "getCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/CollectionId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { "additionalProperties": false, - "example": { - "version": "1.0" - }, + "description": "collection resource object", "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "attributes": { + "$ref": "#/components/schemas/CollectionAttributes" + }, + "id": { + "format": "uuid", "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/CollectionRelationships" + }, + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "attributes", + "relationships" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Returned collection", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a collection", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + }, + "patch": { + "description": "Edit a collection", + "operationId": "updateCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/CollectionId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/UpdateCollectionRequest" + } + } + } + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { + "data": { "additionalProperties": false, - "example": { - "version": "1.0" - }, + "description": "collection resource object", "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "attributes": { + "$ref": "#/components/schemas/CollectionAttributes" + }, + "id": { + "format": "uuid", "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/CollectionRelationships" + }, + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "attributes", + "relationships" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Returned collection", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "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" - } + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Edit a collection", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/collections/{collection_id}/relationships/projects": { + "delete": { + "description": "Remove projects from a collection by specifying an array of project ids", + "operationId": "deleteProjectsCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/CollectionId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/DeleteProjectsFromCollectionRequest" } - }, - "description": "Not Found: The resource being operated on could not be found.", + } + } + }, + "responses": { + "204": { + "description": "successfully removing projects from a collection", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Remove projects from a collection", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + }, + "get": { + "description": "Return a list of organization's projects that are from the specified collection.", + "operationId": "getProjectsOfCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/CollectionId" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Return projects sorted by the specified attributes", + "in": "query", + "name": "sort", + "schema": { + "enum": [ + "imported", + "last_tested_at", + "issues" + ], + "type": "string" + } + }, + { + "description": "Return projects sorted in the specified direction", + "in": "query", + "name": "direction", + "schema": { + "default": "DESC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + { + "description": "Return projects that belong to the provided targets", + "in": "query", + "name": "target_id", + "schema": { + "items": { + "format": "uuid", + "type": "string" + }, + "maxItems": 25, + "type": "array" + } + }, + { + "description": "Return projects that are with or without issues", + "in": "query", + "name": "show", + "schema": { + "items": { + "enum": [ + "vuln-groups", + "clean-groups" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Return projects that match the provided integration types", + "in": "query", + "name": "integration", + "schema": { + "items": { + "enum": [ + "acr", + "api", + "artifactory-cr", + "aws-lambda", + "azure-functions", + "azure-repos", + "bitbucket-cloud", + "bitbucket-connect-app", + "bitbucket-server", + "cli", + "cloud-foundry", + "digitalocean-cr", + "docker-hub", + "ecr", + "gcr", + "github-cr", + "github-enterprise", + "github", + "gitlab-cr", + "gitlab", + "google-artifact-cr", + "harbor-cr", + "heroku", + "ibm-cloud", + "kubernetes", + "nexus-cr", + "pivotal", + "quay-cr", + "terraform-cloud" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" + "$ref": "#/components/schemas/GetProjectsOfCollectionResponse" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Returns a list of projects from the specified collection", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get projects from the specified collection", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + }, + "post": { + "description": "Add projects to a collection by specifying an array of project ids", + "operationId": "updateCollectionWithProjects", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/CollectionId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/UpdateCollectionWithProjectsRequest" + } + } + } + }, + "responses": { + "204": { + "description": "successfully adding projects to a collection", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Add projects to a collection", + "tags": [ + "Collection" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-resource": "collections", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-12", + "x-stability-level": "stable" + } + }, + "/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" + }, + { + "description": "The image Operating System and processor architecture", + "example": "linux/amd64", + "in": "query", + "name": "platform", + "schema": { + "enum": [ + "aix/ppc64", + "android/386", + "android/amd64", + "android/arm", + "android/arm/v5", + "android/arm/v6", + "android/arm/v7", + "android/arm64", + "android/arm64/v8", + "darwin/amd64", + "darwin/arm", + "darwin/arm/v5", + "darwin/arm/v6", + "darwin/arm/v7", + "darwin/arm64", + "darwin/arm64/v8", + "dragonfly/amd64", + "freebsd/386", + "freebsd/amd64", + "freebsd/arm", + "freebsd/arm/v5", + "freebsd/arm/v6", + "freebsd/arm/v7", + "illumos/amd64", + "ios/arm64", + "ios/arm64/v8", + "js/wasm", + "linux/386", + "linux/amd64", + "linux/arm", + "linux/arm/v5", + "linux/arm/v6", + "linux/arm/v7", + "linux/arm64", + "linux/arm64/v8", + "linux/loong64", + "linux/mips", + "linux/mipsle", + "linux/mips64", + "linux/mips64le", + "linux/ppc64", + "linux/ppc64le", + "linux/riscv64", + "linux/s390x", + "linux/x86_64", + "netbsd/386", + "netbsd/amd64", + "netbsd/arm", + "netbsd/arm/v5", + "netbsd/arm/v6", + "netbsd/arm/v7", + "openbsd/386", + "openbsd/amd64", + "openbsd/arm", + "openbsd/arm/v5", + "openbsd/arm/v6", + "openbsd/arm/v7", + "openbsd/arm64", + "openbsd/arm64/v8", + "plan9/386", + "plan9/amd64", + "plan9/arm", + "plan9/arm/v5", + "plan9/arm/v6", + "plan9/arm/v7", + "solaris/amd64", + "windows/386", + "windows/amd64", + "windows/arm", + "windows/arm/v5", + "windows/arm/v6", + "windows/arm/v7", + "windows/arm64", + "windows/arm64/v8" + ], + "example": "linux/amd64", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Names" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/Image" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Returns a list of container image instances", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Get a list of app bots authorized to an organization.", + "summary": "List instances of container image", "tags": [ - "Apps" + "ContainerImage" ], "x-snyk-api-releases": [ - "2022-03-11" + "2023-03-08~beta", + "2023-08-18~beta", + "2023-11-02" ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" + "x-snyk-api-version": "2023-11-02" }, - "x-snyk-api-resource": "app_bots" + "x-snyk-api-resource": "container_images" }, - "/orgs/{org_id}/app_bots/{bot_id}": { - "delete": { - "deprecated": true, - "description": "Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.", - "operationId": "deleteAppBot", + "/orgs/{org_id}/container_images/{image_id}": { + "get": { + "description": "Get instance of container image", + "operationId": "getContainerImage", "parameters": [ { - "description": "The ID of the app bot", + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", "in": "path", - "name": "bot_id", + "name": "org_id", "required": true, "schema": { + "example": "f59045b3-f093-40c3-871d-a334ae30c568", "format": "uuid", "type": "string" } }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/ImageId20231102" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/Image" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Returns an instance of container image", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get instance of container image", + "tags": [ + "ContainerImage" + ], + "x-snyk-api-releases": [ + "2023-03-08~beta", + "2023-11-02" + ], + "x-snyk-api-version": "2023-11-02" + }, + "x-snyk-api-resource": "container_images" + }, + "/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs": { + "get": { + "description": "List instances of image target references for a container image", + "operationId": "listImageTargetRefs", + "parameters": [ { - "description": "Organization ID", + "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { + "example": "f59045b3-f093-40c3-871d-a334ae30c568", "format": "uuid", "type": "string" } + }, + { + "$ref": "#/components/parameters/ImageId20231102" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" } ], "responses": { - "204": { - "description": "The app bot has been deauthorized", + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ImageTargetRef" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "type": "object" + } + } + }, + "description": "Returns a list of image target references for a container image", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "schema": { - "type": "string" - } - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -19736,15 +21232,400 @@ } }, "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "List instances of image target references for a container image", + "tags": [ + "ContainerImage" + ], + "x-snyk-api-releases": [ + "2023-08-18~beta", + "2023-11-02" + ], + "x-snyk-api-version": "2023-11-02" + }, + "x-snyk-api-resource": "container_images" + }, + "/orgs/{org_id}/invites": { + "get": { + "description": "List pending user invitations to an organization.", + "operationId": "listOrgInvitation", + "parameters": [ + { + "description": "The id of the org the user is being invited to", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/OrgInvitation" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "List of pending invitations to an organization.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "List pending user invitations to an organization.", + "tags": [ + "Invites" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-14" + ], + "x-snyk-api-resource": "org_invitations", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-11-14", + "x-stability-level": "stable" + }, + "post": { + "description": "Invite a user to an organization with a role.", + "operationId": "createOrgInvitation", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org the user is being invited to", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/OrgInvitationPostData" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/OrgInvitation20240621" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" + } + } + }, + "description": "A new organization invitation has been created", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Invite a user to an organization", + "tags": [ + "Invites" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-06-01", + "2023-04-28", + "2024-06-21" + ], + "x-snyk-api-resource": "org_invitations", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-06-21", + "x-stability-level": "stable" + } + }, + "/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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-14" + ], + "x-snyk-api-resource": "org_invitations", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-11-14", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/issues": { + "get": { + "description": "Get a list of an organization's issues.", + "operationId": "listOrgIssues", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/ScanItemId" + }, + { + "$ref": "#/components/parameters/ScanItemType" + }, + { + "$ref": "#/components/parameters/Type" + }, + { + "$ref": "#/components/parameters/UpdatedBefore" + }, + { + "$ref": "#/components/parameters/UpdatedAfter" + }, + { + "$ref": "#/components/parameters/CreatedBefore" + }, + { + "$ref": "#/components/parameters/CreatedAfter" + }, + { + "$ref": "#/components/parameters/EffectiveSeverityLevel" + }, + { + "$ref": "#/components/parameters/Status" + }, + { + "$ref": "#/components/parameters/Ignored" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ListIssues200" + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" } ], "jsonapi": { @@ -19856,10 +21737,10 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -19867,7 +21748,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -19875,7 +21756,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -19890,7 +21771,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -19899,7 +21780,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -19917,7 +21798,7 @@ } } }, - "401": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -20041,7 +21922,7 @@ "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -20049,7 +21930,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -20057,7 +21938,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -20072,7 +21953,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -20081,7 +21962,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -20099,7 +21980,7 @@ } } }, - "403": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -20220,10 +22101,10 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -20231,7 +22112,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -20239,7 +22120,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -20254,7 +22135,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -20263,7 +22144,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -20281,7 +22162,7 @@ } } }, - "404": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -20402,10 +22283,10 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -20413,7 +22294,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -20421,7 +22302,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -20436,7 +22317,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -20445,7 +22326,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -20462,8 +22343,52 @@ } } } + } + }, + "summary": "Get issues by org ID", + "tags": [ + "Issues" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-03-10~experimental", + "2023-09-29~beta", + "2024-01-23" + ], + "x-snyk-api-resource": "issues", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-01-23", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/issues/{issue_id}": { + "get": { + "description": "Get an issue", + "operationId": "getOrgIssueByIssueID", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", + "format": "uuid", + "type": "string" + } }, - "409": { + { + "$ref": "#/components/parameters/PathIssueId20240123" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/GetIssue20020240123" + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -20584,10 +22509,10 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -20595,7 +22520,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -20603,7 +22528,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -20618,7 +22543,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -20627,7 +22552,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -20645,282 +22570,7 @@ } } }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Revoke app bot authorization", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "x-snyk-api-resource": "app_bots" - }, - "/orgs/{org_id}/apps": { - "get": { - "deprecated": true, - "description": "Get a list of apps created by an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", - "operationId": "getApps", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppData20220311" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps created by the specified organization", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -21041,10 +22691,10 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -21052,7 +22702,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -21060,7 +22710,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -21075,7 +22725,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -21084,7 +22734,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -21102,7 +22752,7 @@ } } }, - "401": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -21226,7 +22876,7 @@ "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -21234,7 +22884,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -21242,7 +22892,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -21257,7 +22907,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -21266,7 +22916,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -21284,7 +22934,7 @@ } } }, - "403": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -21405,10 +23055,10 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -21416,7 +23066,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -21424,7 +23074,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -21439,7 +23089,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -21448,7 +23098,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -21466,7 +23116,7 @@ } } }, - "404": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -21587,10 +23237,10 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "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", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -21598,7 +23248,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -21606,7 +23256,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -21621,7 +23271,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -21630,7 +23280,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -21648,7 +23298,7 @@ } } }, - "409": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -21769,10 +23419,10 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "description": "The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", @@ -21780,7 +23430,7 @@ } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "description": "A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", @@ -21788,7 +23438,7 @@ } }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "description": "The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { "enum": [ "wip", @@ -21803,7 +23453,7 @@ } }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", + "description": "The version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", @@ -21812,7 +23462,7 @@ } }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", + "description": "The version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", @@ -21829,210 +23479,108 @@ } } } + } + }, + "summary": "Get an issue", + "tags": [ + "Issues" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-01-23" + ], + "x-snyk-api-resource": "issues", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-01-23", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/learn/assignments": { + "delete": { + "description": "Allows an admin to delete multiple assignments within their organization.", + "operationId": "deleteOrgAssignments", + "parameters": [ + { + "description": "The unique identifier of the organization.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "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" - } + { + "$ref": "#/components/parameters/ApiVersion" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/DeleteAssignmentsRequest" } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Assignments were successfully deleted.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Get a list of apps created by an organization.", + "summary": "Bulk deletion of assignments in an organization", "tags": [ - "Apps" + "Assignment" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2022-03-11" + "2024-05-13~experimental", + "2024-10-13~beta" ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" + "x-snyk-api-resource": "assignments", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-10-13~beta", + "x-stability-level": "beta" }, - "post": { - "deprecated": true, - "description": "Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", - "operationId": "createApp", + "get": { + "description": "Allows an admin to obtain a comprehensive list of all assignments within their organization.", + "operationId": "listOrgAssignments", "parameters": [ { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", + "description": "The unique identifier of the organization.", "in": "path", "name": "org_id", "required": true, @@ -22040,37 +23588,53 @@ "format": "uuid", "type": "string" } + }, + { + "$ref": "#/components/parameters/ApiVersion" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" } ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPostRequest20220311" - } - } - }, - "description": "app to be created" - }, "responses": { - "201": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/AppPostResponse20220311" + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/LessonAssignmentDecoratedResource" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "required": [ + "jsonapi", + "links", + "data" + ], + "type": "object" } } }, - "description": "Created Snyk App successfully", + "description": "A list of assignments was successfully retrieved.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "schema": { - "type": "string" - } - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -22089,1117 +23653,608 @@ } }, "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Retrieve a list of assignments for an organization", + "tags": [ + "Assignment" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-13~experimental", + "2024-10-13~beta" + ], + "x-snyk-api-resource": "assignments", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-10-13~beta", + "x-stability-level": "beta" + } + }, + "/orgs/{org_id}/memberships": { + "get": { + "description": "Returns all memberships of the org", + "operationId": "listOrgMemberships", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/SortBy" + }, + { + "$ref": "#/components/parameters/SortOrder" + }, + { + "$ref": "#/components/parameters/EmailFilter" + }, + { + "$ref": "#/components/parameters/UserIdFilter" + }, + { + "$ref": "#/components/parameters/UsernameFilter" + }, + { + "$ref": "#/components/parameters/RoleFilter" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/OrgMembershipResponseData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "List of org memberships is returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get all memberships of the org", + "tags": [ + "Orgs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-09~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "orgs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + }, + "post": { + "description": "Create a org membership for a user with role", + "operationId": "createOrgMembership", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CreateOrgMembershipRequestBody" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/OrgMembership" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Membership for the user is created on the org", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Create a org membership for a user with role", + "tags": [ + "Orgs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-09~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "orgs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/memberships/{membership_id}": { + "delete": { + "description": "Remove a user's membership of the group.\n", + "operationId": "deleteOrgMembership", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId__0" + }, + { + "$ref": "#/components/parameters/OrgMembershipId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "Org membership for the user was successfully deleted.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Remove user's org membership", + "tags": [ + "Orgs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-06-06~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "org_memberships", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + }, + "patch": { + "description": "Update a org membership for a user with role", + "operationId": "updateOrgMembership", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId__0" + }, + { + "$ref": "#/components/parameters/OrgMembershipId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/UpdateOrgMembershipRequestBody" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "The Membership is updated", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "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" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update a org membership for a user with role", + "tags": [ + "Orgs" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-06-06~experimental", + "2024-08-25" + ], + "x-snyk-api-resource": "org_memberships", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-08-25", + "x-stability-level": "stable" + } + }, + "/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": "Not Found: The resource being operated on could not be found.", + "description": "Returns an array of issues with the purl identifier of the package that caused them", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/Location" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "List issues for a given set of packages (Currently not available to all customers)", + "tags": [ + "Issues" + ], + "x-snyk-api-releases": [ + "2023-01-04~experimental", + "2023-03-29~beta", + "2023-04-17", + "2023-08-21", + "2024-06-26" + ], + "x-snyk-api-version": "2024-06-26" + }, + "x-snyk-api-resource": "issues" + }, + "/orgs/{org_id}/packages/{purl}/issues": { + "get": { + "description": "Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.", + "operationId": "fetchIssuesPerPurl", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/PackageUrl" + }, + { + "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": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" + "$ref": "#/components/schemas/IssuesResponse" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Returns an array of issues", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } + "$ref": "#/components/responses/500" } }, - "summary": "Create a new app for an organization.", + "summary": "List issues for a package", "tags": [ - "Apps" + "Issues" ], "x-snyk-api-releases": [ - "2022-03-11" + "2022-06-29~beta", + "2022-09-15", + "2024-06-26" ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" + "x-snyk-api-version": "2024-06-26" }, - "x-snyk-api-resource": "apps" + "x-snyk-api-resource": "issues" }, - "/orgs/{org_id}/apps/creations": { + "/orgs/{org_id}/projects": { "get": { - "description": "Get a list of apps created by an organization.", - "operationId": "getOrgApps", + "description": "List all Projects for an Org.", + "operationId": "listOrgProjects", "parameters": [ { - "description": "Org ID", + "description": "The ID of the org that the projects belong to.", "in": "path", "name": "org_id", "required": true, @@ -23209,26762 +24264,450 @@ } }, { - "$ref": "#/components/parameters/Version" + "description": "Return projects that belong to the provided targets", + "in": "query", + "name": "target_id", + "schema": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } }, { - "$ref": "#/components/parameters/StartingAfter" + "description": "Return projects that match the provided target reference", + "in": "query", + "name": "target_reference", + "schema": { + "type": "string" + } }, { - "$ref": "#/components/parameters/EndingBefore" + "description": "Return projects that match the provided target file", + "in": "query", + "name": "target_file", + "schema": { + "type": "string" + } }, { - "$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" - } + "description": "Return projects that match the provided target runtime", + "in": "query", + "name": "target_runtime", + "schema": { + "type": "string" } }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } + { + "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" }, - "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" - } + "style": "form" + }, + { + "description": "Return projects that match the provided names.", + "explode": false, + "in": "query", + "name": "names", + "schema": { + "items": { + "type": "string" }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects with names starting with the specified prefix.", + "explode": false, + "in": "query", + "name": "names_start_with", + "schema": { + "items": { + "type": "string" }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match the provided origins.", + "explode": false, + "in": "query", + "name": "origins", + "schema": { + "items": { + "type": "string" }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match the provided types.", + "explode": false, + "in": "query", + "name": "types", + "schema": { + "items": { + "type": "string" }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "target" + ], + "type": "string" }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Include a summary count for the issues found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_issue_counts", + "schema": { + "type": "boolean" } }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Get a list of apps created by an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "post": { - "description": "Create a new Snyk App for an organization.", - "operationId": "createOrgApp", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPostRequest" - } - } - }, - "description": "Snyk App details for app to be created." - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPostResponse" - } - } - }, - "description": "Created Snyk App successfully.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Create a new Snyk App for an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/creations/{app_id}": { - "delete": { - "description": "Delete an app by its App ID.", - "operationId": "deleteAppByID", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/AppId" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "The app has been deleted", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Delete an app by its App ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "get": { - "description": "Get a Snyk App by its App ID.", - "operationId": "getAppByID", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/AppId" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "The requested app", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Get a Snyk App by its App ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "patch": { - "description": "Update app creation attributes with App ID.", - "operationId": "updateAppCreationByID", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/AppId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPatchRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "The update app.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/creations/{app_id}/secrets": { - "post": { - "description": "Manage client secret for the Snyk App.", - "operationId": "manageAppCreationSecret", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/AppId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - }, - "type": { - "enum": [ - "app" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppDataWithSecret" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Secret has been updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Manage client secret for the Snyk App.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/installs": { - "get": { - "description": "Get a list of apps installed for an organization.", - "operationId": "getAppInstallsForOrg", - "parameters": [ - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppInstallData" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps installed for the specified organization.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Get a list of apps installed for an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" - ], - "x-snyk-api-version": "2024-05-23" - }, - "post": { - "description": "Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.", - "operationId": "createOrgAppInstall", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "properties": { - "type": { - "enum": [ - "app_install" - ], - "example": "app_install", - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "additionalProperties": false, - "properties": { - "app": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/components/schemas/Uuid" - }, - "type": { - "enum": [ - "app" - ], - "example": "app", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "required": [ - "app" - ], - "type": "object" - } - }, - "required": [ - "data", - "relationships" - ], - "type": "object" - } - } - }, - "description": "App Install to be created" - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppInstallWithClient" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "The newly created app install.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Install a Snyk Apps to this organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" - ], - "x-snyk-api-version": "2024-05-23" - }, - "x-snyk-api-resource": "app_installs" - }, - "/orgs/{org_id}/apps/installs/{install_id}": { - "delete": { - "description": "Revoke app authorization for an Snyk Organization with install ID.", - "operationId": "deleteAppOrgInstallById", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/InstallId" - } - ], - "responses": { - "204": { - "description": "The app install has been revoked.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Revoke app authorization for an Snyk Organization with install ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" - ], - "x-snyk-api-version": "2024-05-23" - }, - "x-snyk-api-resource": "app_installs" - }, - "/orgs/{org_id}/apps/installs/{install_id}/secrets": { - "post": { - "description": "Manage client secret for non-interactive Snyk App installations.", - "operationId": "updateOrgAppInstallSecret", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/InstallId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - }, - "type": { - "enum": [ - "app" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppInstallDataWithSecret" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Secret has been updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Manage client secret for non-interactive Snyk App installations.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" - ], - "x-snyk-api-version": "2024-05-23" - }, - "x-snyk-api-resource": "app_installs" - }, - "/orgs/{org_id}/apps/{client_id}": { - "delete": { - "deprecated": true, - "description": "Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", - "operationId": "deleteApp", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ClientId" - } - ], - "responses": { - "204": { - "description": "The app has been deleted", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Delete an app", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "get": { - "deprecated": true, - "description": "Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", - "operationId": "getApp", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ClientId" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppData20220311" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "The requested app", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Get an app by client id", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "patch": { - "deprecated": true, - "description": "Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", - "operationId": "updateApp", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ClientId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPatchRequest20220311" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppData20220311" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "The update app.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Update app attributes that are name, redirect URIs, and access token time to live", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/{client_id}/secrets": { - "post": { - "deprecated": true, - "description": "Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead.", - "operationId": "manageSecrets", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ClientId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppDataWithSecret20220311" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Secrets have been updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Manage client secrets for an app.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/audit_logs/search": { - "get": { - "description": "Search audit logs for an Organization. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Supported event types:\n - api.access\n - org.app_bot.create\n - org.app.create\n - org.app.delete\n - org.app.edit\n - org.cloud_config.settings.edit\n - org.collection.create\n - org.collection.delete\n - org.collection.edit\n - org.create\n - org.delete\n - org.edit\n - org.ignore_policy.edit\n - org.integration.create\n - org.integration.delete\n - org.integration.edit\n - org.integration.settings.edit\n - org.language_settings.edit\n - org.notification_settings.edit\n - org.org_source.create\n - org.org_source.delete\n - org.org_source.edit\n - org.policy.edit\n - org.project_filter.create\n - org.project_filter.delete\n - org.project.add\n - org.project.attributes.edit\n - org.project.delete\n - org.project.edit\n - org.project.fix_pr.auto_open\n - org.project.fix_pr.manual_open\n - org.project.ignore.create\n - org.project.ignore.delete\n - org.project.ignore.edit\n - org.project.monitor\n - org.project.pr_check.edit\n - org.project.remove\n - org.project.settings.delete\n - org.project.settings.edit\n - org.project.stop_monitor\n - org.project.tag.add\n - org.project.tag.remove\n - org.project.test\n - org.request_access_settings.edit\n - org.sast_settings.edit\n - org.service_account.create\n - org.service_account.delete\n - org.service_account.edit\n - org.settings.feature_flag.edit\n - org.target.create\n - org.target.delete\n - org.user.add\n - org.user.invite\n - org.user.invite.accept\n - org.user.invite.revoke\n - org.user.invite_link.accept\n - org.user.invite_link.create\n - org.user.invite_link.revoke\n - org.user.leave\n - org.user.provision.accept\n - org.user.provision.create\n - org.user.provision.delete\n - org.user.remove\n - org.user.role.create\n - org.user.role.delete\n - org.user.role.details.edit\n - org.user.role.edit\n - org.user.role.permissions.edit\n - org.webhook.add\n - org.webhook.delete\n - user.org.notification_settings.edit\n", - "operationId": "listOrgAuditLogs", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The ID of the organization.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Cursor" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/Size" - }, - { - "$ref": "#/components/parameters/SortOrder" - }, - { - "description": "Filter logs by user ID.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", - "in": "query", - "name": "user_id", - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Filter logs by project ID.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", - "in": "query", - "name": "project_id", - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Events" - }, - { - "$ref": "#/components/parameters/ExcludeEvents" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AuditLogSearch" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data" - ], - "type": "object" - } - } - }, - "description": "Organization Audit Logs.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Search Organization audit logs.", - "tags": [ - "Audit Logs" - ], - "x-snyk-api-releases": [ - "2023-09-11", - "2024-04-29" - ], - "x-snyk-api-version": "2024-04-29" - }, - "x-snyk-api-resource": "audit-logs", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/collections": { - "get": { - "description": "Return a list of organization's collections with issues counts and projects count.", - "operationId": "getCollections", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Return collections sorted by the specified attributes", - "in": "query", - "name": "sort", - "schema": { - "enum": [ - "name", - "projectsCount", - "issues" - ], - "type": "string" - } - }, - { - "description": "Return collections sorted in the specified direction", - "in": "query", - "name": "direction", - "schema": { - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - { - "allowEmptyValue": true, - "description": "Return collections which names include the provided string", - "in": "query", - "name": "name", - "schema": { - "maxLength": 255, - "type": "string" - } - }, - { - "allowEmptyValue": true, - "description": "Return collections where is_generated matches the provided boolean", - "in": "query", - "name": "is_generated", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/CollectionResponse" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "type": "object" - } - } - }, - "description": "Returns a list of collections", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get collections", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "post": { - "description": "Create a collection", - "operationId": "createCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/CreateCollectionRequest" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "additionalProperties": false, - "description": "collection resource object", - "properties": { - "attributes": { - "$ref": "#/components/schemas/CollectionAttributes" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "relationships": { - "$ref": "#/components/schemas/CollectionRelationships" - }, - "type": { - "$ref": "#/components/schemas/Types" - } - }, - "required": [ - "id", - "attributes", - "relationships" - ], - "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Returned collection", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "x-snyk-api-resource": "collections" - }, - "/orgs/{org_id}/collections/{collection_id}": { - "delete": { - "description": "Delete a collection", - "operationId": "deleteCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "responses": { - "204": { - "description": "Collection was deleted successfully", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "get": { - "description": "Get a collection", - "operationId": "getCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "additionalProperties": false, - "description": "collection resource object", - "properties": { - "attributes": { - "$ref": "#/components/schemas/CollectionAttributes" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "relationships": { - "$ref": "#/components/schemas/CollectionRelationships" - }, - "type": { - "$ref": "#/components/schemas/Types" - } - }, - "required": [ - "id", - "attributes", - "relationships" - ], - "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Returned collection", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "patch": { - "description": "Edit a collection", - "operationId": "updateCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/UpdateCollectionRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "additionalProperties": false, - "description": "collection resource object", - "properties": { - "attributes": { - "$ref": "#/components/schemas/CollectionAttributes" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "relationships": { - "$ref": "#/components/schemas/CollectionRelationships" - }, - "type": { - "$ref": "#/components/schemas/Types" - } - }, - "required": [ - "id", - "attributes", - "relationships" - ], - "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Returned collection", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Edit a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "x-snyk-api-resource": "collections" - }, - "/orgs/{org_id}/collections/{collection_id}/relationships/projects": { - "delete": { - "description": "Remove projects from a collection by specifying an array of project ids", - "operationId": "deleteProjectsCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/DeleteProjectsFromCollectionRequest" - } - } - } - }, - "responses": { - "204": { - "description": "successfully removing projects from a collection", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Remove projects from a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "get": { - "description": "Return a list of organization's projects that are from the specified collection.", - "operationId": "getProjectsOfCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Return projects sorted by the specified attributes", - "in": "query", - "name": "sort", - "schema": { - "enum": [ - "imported", - "last_tested_at", - "issues" - ], - "type": "string" - } - }, - { - "description": "Return projects sorted in the specified direction", - "in": "query", - "name": "direction", - "schema": { - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - { - "description": "Return projects that belong to the provided targets", - "in": "query", - "name": "target_id", - "schema": { - "items": { - "format": "uuid", - "type": "string" - }, - "maxItems": 25, - "type": "array" - } - }, - { - "description": "Return projects that are with or without issues", - "in": "query", - "name": "show", - "schema": { - "items": { - "enum": [ - "vuln-groups", - "clean-groups" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Return projects that match the provided integration types", - "in": "query", - "name": "integration", - "schema": { - "items": { - "enum": [ - "acr", - "api", - "artifactory-cr", - "aws-lambda", - "azure-functions", - "azure-repos", - "bitbucket-cloud", - "bitbucket-connect-app", - "bitbucket-server", - "cli", - "cloud-foundry", - "digitalocean-cr", - "docker-hub", - "ecr", - "gcr", - "github-cr", - "github-enterprise", - "github", - "gitlab-cr", - "gitlab", - "google-artifact-cr", - "harbor-cr", - "heroku", - "ibm-cloud", - "kubernetes", - "nexus-cr", - "pivotal", - "quay-cr", - "terraform-cloud" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/GetProjectsOfCollectionResponse" - } - } - }, - "description": "Returns a list of projects from the specified collection", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get projects from the specified collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "post": { - "description": "Add projects to a collection by specifying an array of project ids", - "operationId": "updateCollectionWithProjects", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/UpdateCollectionWithProjectsRequest" - } - } - } - }, - "responses": { - "204": { - "description": "successfully adding projects to a collection", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Add projects to a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "x-snyk-api-resource": "collections" - }, - "/orgs/{org_id}/container_images": { - "get": { - "description": "List instances of container image", - "operationId": "listContainerImage", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "f59045b3-f093-40c3-871d-a334ae30c568", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ImageIds" - }, - { - "$ref": "#/components/parameters/Platform" - }, - { - "$ref": "#/components/parameters/Names" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/Image" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "type": "object" - } - } - }, - "description": "Returns a list of container image instances", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List instances of container image", - "tags": [ - "ContainerImage" - ], - "x-snyk-api-releases": [ - "2023-03-08~beta", - "2023-08-18~beta", - "2023-11-02" - ], - "x-snyk-api-version": "2023-11-02" - }, - "x-snyk-api-resource": "container_images" - }, - "/orgs/{org_id}/container_images/{image_id}": { - "get": { - "description": "Get instance of container image", - "operationId": "getContainerImage", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "f59045b3-f093-40c3-871d-a334ae30c568", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ImageId20231102" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/Image" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Returns an instance of container image", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get instance of container image", - "tags": [ - "ContainerImage" - ], - "x-snyk-api-releases": [ - "2023-03-08~beta", - "2023-11-02" - ], - "x-snyk-api-version": "2023-11-02" - }, - "x-snyk-api-resource": "container_images" - }, - "/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs": { - "get": { - "description": "List instances of image target references for a container image", - "operationId": "listImageTargetRefs", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "f59045b3-f093-40c3-871d-a334ae30c568", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ImageId20231102" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/ImageTargetRef" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "type": "object" - } - } - }, - "description": "Returns a list of image target references for a container image", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List instances of image target references for a container image", - "tags": [ - "ContainerImage" - ], - "x-snyk-api-releases": [ - "2023-08-18~beta", - "2023-11-02" - ], - "x-snyk-api-version": "2023-11-02" - }, - "x-snyk-api-resource": "container_images" - }, - "/orgs/{org_id}/invites": { - "get": { - "description": "List pending user invitations to an organization.", - "operationId": "listOrgInvitation", - "parameters": [ - { - "description": "The id of the org the user is being invited to", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/OrgInvitation" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "List of pending invitations to an organization.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List pending user invitations to an organization.", - "tags": [ - "Invites" - ], - "x-snyk-api-releases": [ - "2022-11-14" - ], - "x-snyk-api-version": "2022-11-14" - }, - "post": { - "description": "Invite a user to an organization with a role.", - "operationId": "createOrgInvitation", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org the user is being invited to", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/OrgInvitationPostData" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/OrgInvitation20240621" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data" - ], - "type": "object" - } - } - }, - "description": "A new organization invitation has been created", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Invite a user to an organization", - "tags": [ - "Invites" - ], - "x-snyk-api-releases": [ - "2022-06-01", - "2023-04-28", - "2024-06-21" - ], - "x-snyk-api-version": "2024-06-21" - }, - "x-snyk-api-resource": "org_invitations" - }, - "/orgs/{org_id}/invites/{invite_id}": { - "delete": { - "description": "Cancel a pending user invitations to an organization.", - "operationId": "deleteOrgInvitation", - "parameters": [ - { - "description": "The id of the org the user is being invited to", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The id of the pending invite to cancel", - "in": "path", - "name": "invite_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Cancel a pending user invitations to an organization.", - "tags": [ - "Invites" - ], - "x-snyk-api-releases": [ - "2022-11-14" - ], - "x-snyk-api-version": "2022-11-14" - }, - "x-snyk-api-resource": "org_invitations" - }, - "/orgs/{org_id}/issues": { - "get": { - "description": "Get a list of an organization's issues.", - "operationId": "listOrgIssues", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ScanItemId" - }, - { - "$ref": "#/components/parameters/ScanItemType" - }, - { - "$ref": "#/components/parameters/Type" - }, - { - "$ref": "#/components/parameters/UpdatedBefore" - }, - { - "$ref": "#/components/parameters/UpdatedAfter" - }, - { - "$ref": "#/components/parameters/CreatedBefore" - }, - { - "$ref": "#/components/parameters/CreatedAfter" - }, - { - "$ref": "#/components/parameters/EffectiveSeverityLevel" - }, - { - "$ref": "#/components/parameters/Status" - }, - { - "$ref": "#/components/parameters/Ignored" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/ListIssues200" - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Get issues by org ID", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2023-03-10~experimental", - "2023-09-29~beta", - "2024-01-23" - ], - "x-snyk-api-version": "2024-01-23" - }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/issues/{issue_id}": { - "get": { - "description": "Get an issue", - "operationId": "getOrgIssueByIssueID", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/PathIssueId20240123" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/GetIssue20020240123" - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Get an issue", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2024-01-23" - ], - "x-snyk-api-version": "2024-01-23" - }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/memberships": { - "get": { - "description": "Returns all memberships of the org", - "operationId": "listOrgMemberships", - "parameters": [ - { - "description": "The ID of the org", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Which column to sort by.", - "in": "query", - "name": "sort_by", - "schema": { - "enum": [ - "username", - "user_display_name", - "email", - "login_method", - "role" - ], - "type": "string" - } - }, - { - "description": "Order in which results are returned.", - "example": "ASC", - "in": "query", - "name": "sort_order", - "schema": { - "default": "ASC", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - { - "$ref": "#/components/parameters/EmailFilter" - }, - { - "$ref": "#/components/parameters/UserIdFilter" - }, - { - "$ref": "#/components/parameters/UsernameFilter" - }, - { - "$ref": "#/components/parameters/RoleFilter" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/OrgMembershipResponseData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "List of org memberships is returned", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get all memberships of the org", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2024-05-09~experimental", - "2024-08-25" - ], - "x-snyk-api-version": "2024-08-25" - }, - "post": { - "description": "Create a org membership for a user with role", - "operationId": "createOrgMembership", - "parameters": [ - { - "description": "The ID of the org", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/CreateOrgMembershipRequestBody" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/OrgMembership" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "type": "object" - } - } - }, - "description": "Membership for the user is created on the org", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a org membership for a user with role", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2024-05-09~experimental", - "2024-08-25" - ], - "x-snyk-api-version": "2024-08-25" - }, - "x-snyk-api-resource": "orgs" - }, - "/orgs/{org_id}/memberships/{membership_id}": { - "delete": { - "description": "Remove a user's membership of the group.\n", - "operationId": "deleteOrgMembership", - "parameters": [ - { - "$ref": "#/components/parameters/OrgId" - }, - { - "$ref": "#/components/parameters/OrgMembershipId" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "Org membership for the user was successfully deleted.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Remove user's org membership", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2024-06-06~experimental", - "2024-08-25" - ], - "x-snyk-api-version": "2024-08-25" - }, - "patch": { - "description": "Update a org membership for a user with role", - "operationId": "updateOrgMembership", - "parameters": [ - { - "$ref": "#/components/parameters/OrgId" - }, - { - "$ref": "#/components/parameters/OrgMembershipId" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/UpdateOrgMembershipRequestBody" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "The Membership is updated", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update a org membership for a user with role", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2024-06-06~experimental", - "2024-08-25" - ], - "x-snyk-api-version": "2024-08-25" - }, - "x-snyk-api-resource": "org_memberships" - }, - "/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", - "2023-08-21", - "2024-06-26" - ], - "x-snyk-api-version": "2024-06-26" - }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/packages/{purl}/issues": { - "get": { - "description": "Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.", - "operationId": "fetchIssuesPerPurl", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/PackageUrl" - }, - { - "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-06-29~beta", - "2022-09-15", - "2024-06-26" - ], - "x-snyk-api-version": "2024-06-26" - }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/projects": { - "get": { - "description": "List all Projects for an Org.", - "operationId": "listOrgProjects", - "parameters": [ - { - "description": "The ID of the org that the projects belong to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Return projects that belong to the provided targets", - "in": "query", - "name": "target_id", - "schema": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Return projects that match the provided target reference", - "in": "query", - "name": "target_reference", - "schema": { - "type": "string" - } - }, - { - "description": "Return projects that match the provided target file", - "in": "query", - "name": "target_file", - "schema": { - "type": "string" - } - }, - { - "description": "Return projects that match the provided target runtime", - "in": "query", - "name": "target_runtime", - "schema": { - "type": "string" - } - }, - { - "description": "The collection count.", - "in": "query", - "name": "meta_count", - "schema": { - "enum": [ - "only" - ], - "type": "string" - } - }, - { - "description": "Return projects that match the provided IDs.", - "explode": false, - "in": "query", - "name": "ids", - "schema": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match the provided names.", - "explode": false, - "in": "query", - "name": "names", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects with names starting with the specified prefix.", - "explode": false, - "in": "query", - "name": "names_start_with", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match the provided origins.", - "explode": false, - "in": "query", - "name": "origins", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match the provided types.", - "explode": false, - "in": "query", - "name": "types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "target" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include a summary count for the issues found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_issue_counts", - "schema": { - "type": "boolean" - } - }, - { - "description": "Include the total number of dependencies found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_dependency_total", - "schema": { - "type": "boolean" - } - }, - { - "description": "Filter projects uploaded and monitored before this date (encoded value)", - "example": "2021-05-29T09:50:54.014Z", - "in": "query", - "name": "cli_monitored_before", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Filter projects uploaded and monitored after this date (encoded value)", - "example": "2021-05-29T09:50:54.014Z", - "in": "query", - "name": "cli_monitored_after", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Return projects that match the provided importing user public ids.", - "explode": false, - "in": "query", - "name": "importing_user_public_id", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided tags", - "example": [ - "key1:value1", - "key2:value2" - ], - "explode": false, - "in": "query", - "name": "tags", - "schema": { - "items": { - "pattern": "^[a-zA-Z0-9_-]+:[:/?#@\u0026+=%a-zA-Z0-9_.~-]+$", - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided business_criticality value", - "explode": false, - "in": "query", - "name": "business_criticality", - "schema": { - "items": { - "enum": [ - "critical", - "high", - "medium", - "low" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided environment values", - "explode": false, - "in": "query", - "name": "environment", - "schema": { - "items": { - "enum": [ - "frontend", - "backend", - "internal", - "external", - "mobile", - "saas", - "onprem", - "hosted", - "distributed" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided lifecycle values", - "explode": false, - "in": "query", - "name": "lifecycle", - "schema": { - "items": { - "enum": [ - "production", - "development", - "sandbox" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/ProjectAttributes" - }, - "id": { - "description": "Resource ID.", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": false, - "properties": { - "cli_monitored_at": { - "description": "The date that the project was last uploaded and monitored using cli.", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "latest_dependency_total": { - "$ref": "#/components/schemas/LatestDependencyTotal" - }, - "latest_issue_counts": { - "$ref": "#/components/schemas/LatestIssueCounts" - } - }, - "type": "object" - }, - "relationships": { - "$ref": "#/components/schemas/ProjectRelationships" - }, - "type": { - "description": "The Resource type.", - "example": "project", - "type": "string" - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - }, - "meta": { - "properties": { - "count": { - "minimum": 0, - "type": "number" - } - }, - "type": "object" - } - }, - "required": [ - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of projects is returned for the targeted org", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List all Projects for an Org with the given Org ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2021-06-04~beta", - "2022-08-12~experimental", - "2022-12-21~experimental", - "2023-02-15", - "2023-08-28", - "2023-09-11", - "2023-11-06", - "2024-05-31" - ], - "x-snyk-api-version": "2024-05-31" - }, - "x-snyk-api-resource": "projects" - }, - "/orgs/{org_id}/projects/{project_id}": { - "delete": { - "description": "Delete one project in the organization by project ID.", - "operationId": "deleteOrgProject", - "parameters": [ - { - "description": "The ID of the org to which the project belongs to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the project.", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "The project has been deleted", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete project by project ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2023-11-06", - "2024-05-31" - ], - "x-snyk-api-version": "2024-05-31" - }, - "get": { - "description": "Get one project of the organization by project ID.", - "operationId": "getOrgProject", - "parameters": [ - { - "description": "The ID of the org to which the project belongs to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the project.", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "target" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include a summary count for the issues found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_issue_counts", - "schema": { - "type": "boolean" - } - }, - { - "description": "Include the total number of dependencies found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_dependency_total", - "schema": { - "type": "boolean" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/ProjectAttributes" - }, - "id": { - "description": "The Resource ID.", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": false, - "properties": { - "cli_monitored_at": { - "description": "The date that the project was last uploaded and monitored using cli.", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "latest_dependency_total": { - "$ref": "#/components/schemas/LatestDependencyTotal" - }, - "latest_issue_counts": { - "$ref": "#/components/schemas/LatestIssueCounts" - } - }, - "type": "object" - }, - "relationships": { - "$ref": "#/components/schemas/ProjectRelationships" - }, - "type": { - "description": "The Resource type.", - "example": "project", - "type": "string" - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A project is returned for the targeted org", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get project by project ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2022-02-01~experimental", - "2022-08-12~experimental", - "2022-12-21~experimental", - "2023-02-15", - "2023-08-28", - "2023-09-11", - "2023-11-06", - "2024-05-31" - ], - "x-snyk-api-version": "2024-05-31" - }, - "patch": { - "description": "Updates one project of the organization by project ID.", - "operationId": "updateOrgProject", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The ID of the Org the project belongs to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the project to patch.", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "target" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/PatchProjectRequest" - } - } - }, - "description": "The project attributes to be updated." - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/ProjectAttributes" - }, - "id": { - "description": "The Resource ID.", - "example": "331ede0a-de94-456f-b788-166caeca58bf", - "format": "uuid", - "type": "string" - }, - "links": { - "$ref": "#/components/schemas/Links" - }, - "meta": { - "additionalProperties": false, - "properties": { - "cli_monitored_at": { - "description": "The date that the project was last uploaded and monitored using cli.", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "$ref": "#/components/schemas/ProjectRelationships" - }, - "type": { - "description": "The Resource type.", - "example": "project", - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A project is updated for the targeted org", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Updates project by project ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2022-12-21~experimental", - "2023-02-15", - "2023-08-28", - "2023-09-11", - "2023-11-06", - "2024-05-31" - ], - "x-snyk-api-version": "2024-05-31" - }, - "x-snyk-api-resource": "projects" - }, - "/orgs/{org_id}/projects/{project_id}/sbom": { - "get": { - "description": "This endpoint lets you retrieve the SBOM document of a software project.\nIt supports the following formats:\n* CycloneDX version 1.6 in JSON (set `format` to `cyclonedx1.6+json`).\n* CycloneDX version 1.6 in XML (set `format` to `cyclonedx1.6+xml`).\n* CycloneDX version 1.5 in JSON (set `format` to `cyclonedx1.5+json`).\n* CycloneDX version 1.5 in XML (set `format` to `cyclonedx1.5+xml`).\n* CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`).\n* CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`).\n* SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`).\n\nBy default it will respond with an empty JSON:API response.", - "operationId": "getSbom", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Unique identifier for an organization", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ProjectId" - }, - { - "$ref": "#/components/parameters/Format" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SbomDocument" - } - }, - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/SbomResponse" - } - }, - "application/vnd.cyclonedx+json": { - "schema": { - "$ref": "#/components/schemas/SbomDocument" - } - }, - "application/vnd.cyclonedx+xml": { - "schema": { - "$ref": "#/components/schemas/SbomDocument" - } - } - }, - "description": "Returns the SBOM document of a project", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a project’s SBOM document", - "tags": [ - "SBOM" - ], - "x-snyk-api-releases": [ - "2022-03-31~experimental", - "2022-12-06~beta", - "2023-03-20", - "2024-03-12~experimental", - "2024-08-15~beta", - "2024-08-22" - ], - "x-snyk-api-version": "2024-08-22" - }, - "x-snyk-api-resource": "sboms", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/service_accounts": { - "get": { - "description": "Get all service accounts for an organization.", - "operationId": "getManyOrgServiceAccounts", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service accounts.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/ServiceAccount" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of service accounts is returned.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a list of organization service accounts.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "post": { - "description": "Create a service account for an organization. The service account can be used to access the Snyk API.", - "operationId": "createOrgServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Organization that is creating and will own the service account.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", - "maximum": 86400, - "minimum": 3600, - "type": "number" - }, - "auth_type": { - "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "jwks_url": { - "description": "A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "name": { - "description": "A human-friendly name for the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the created service account should use. Obtained in the Snyk UI, via \"Group Page\" -\u003e \"Settings\" -\u003e \"Member Roles\" -\u003e \"Create new Role\". Can be shared among multiple accounts.", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "name", - "role_id", - "auth_type" - ], - "type": "object" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } - }, - "required": [ - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/ServiceAccount" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A new service account has been created", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a service account for an organization.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/orgs/{org_id}/service_accounts/{serviceaccount_id}": { - "delete": { - "description": "Delete a service account in an organization.", - "operationId": "deleteServiceAccount", - "parameters": [ - { - "description": "The ID of org to which the service account belongs.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "The service account has been deleted.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete a service account in an organization.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "get": { - "description": "Get an organization-level service account by its ID.", - "operationId": "getOneOrgServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service account.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/ServiceAccount" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "Service account is returned.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get an organization service account.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "patch": { - "description": "Update the name of an organization-level service account by its ID.", - "operationId": "updateOrgServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service account.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "name": { - "description": "A human-friendly name for the service account. Must be unique within the organization.", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The ID of the service account. Must match the id in the url path.", - "format": "uuid", - "type": "string" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/ServiceAccount" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "Service account is returned.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update an organization service account.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets": { - "post": { - "description": "Manage the client secret of an organization service account by the service account ID.", - "operationId": "updateOrgServiceAccountSecret", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service account.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/ServiceAccount" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data" - ], - "type": "object" - } - } - }, - "description": "Service account client secret has been updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Manage an organization service account's client secret.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/orgs/{org_id}/settings/iac": { - "get": { - "description": "Get the Infrastructure as Code Settings for an org.", - "operationId": "getIacSettingsForOrg", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org whose Infrastructure as Code settings are requested.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/OrgIacSettingsResponse" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "The Infrastructure as Code Settings of the org.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get the Infrastructure as Code Settings for an org.", - "tags": [ - "IacSettings" - ], - "x-snyk-api-releases": [ - "2021-12-09" - ], - "x-snyk-api-version": "2021-12-09" - }, - "patch": { - "description": "Update the Infrastructure as Code Settings for an org.", - "operationId": "updateIacSettingsForOrg", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org whose Infrastructure as Code settings are getting updated", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/OrgIacSettingsRequest" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/OrgIacSettingsResponse" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "The Infrastructure as Code Settings of the org were updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update the Infrastructure as Code Settings for an org", - "tags": [ - "IacSettings" - ], - "x-snyk-api-releases": [ - "2021-12-09" - ], - "x-snyk-api-version": "2021-12-09" - }, - "x-snyk-api-resource": "iac_settings", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/settings/sast": { - "get": { - "description": "Retrieves the SAST settings for an org", - "operationId": "getSastSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org for which we want to retrieve the SAST settings", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/SastEnablement" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "The SAST settings for the org are being retrieved", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Retrieves the SAST settings for an org", - "tags": [ - "SastSettings" - ], - "x-snyk-api-releases": [ - "2023-06-22" - ], - "x-snyk-api-version": "2023-06-22" - }, - "patch": { - "description": "Enable/Disable the Snyk Code settings for an org", - "operationId": "updateOrgSastSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org for which we want to update the Snyk Code setting", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "sast_enabled": { - "description": "The value of the updated settings for sastEnabled setting", - "type": "boolean" - } - }, - "required": [ - "sast_enabled" - ], - "type": "object" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/SastEnablement" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "The SAST settings for the org are being updated", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Enable/Disable the Snyk Code settings for an org", - "tags": [ - "SastSettings" - ], - "x-snyk-api-releases": [ - "2023-08-24~experimental", - "2023-09-11" - ], - "x-snyk-api-version": "2023-09-11" - }, - "x-snyk-api-resource": "sast_settings", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/slack_app/{bot_id}": { - "delete": { - "description": "Remove the given Slack App integration", - "operationId": "deleteSlackDefaultNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "204": { - "description": "Slack App integration successfully removed", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Remove the given Slack App integration", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "get": { - "description": "Get Slack integration default notification settings for the provided tenant ID and bot ID.", - "operationId": "getSlackDefaultNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/SlackDefaultSettingsData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Default settings created successfully", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get Slack integration default notification settings.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "post": { - "description": "Create new Slack notification default settings for a given tenant.", - "operationId": "createSlackDefaultNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/SettingsRequest" - } - } - }, - "description": "Create new Slack notification default settings for a tenant." - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/SlackDefaultSettingsData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Default settings created successfully", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create new Slack notification default settings.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "x-snyk-api-resource": "settings" - }, - "/orgs/{org_id}/slack_app/{bot_id}/projects": { - "get": { - "description": "Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.", - "operationId": "getSlackProjectNotificationSettingsCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/GetProjectSettingsCollection" - } - } - }, - "description": "Return default settings for a tenant", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Slack notification settings overrides for projects", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "x-snyk-api-resource": "settings" - }, - "/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}": { - "delete": { - "description": "Remove Slack settings override for a project.", - "operationId": "deleteSlackProjectNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Project ID", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "204": { - "description": "Slack settings override for the project removed successfully.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Remove Slack settings override for a project.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "patch": { - "description": "Update Slack notification settings for a project.", - "operationId": "updateSlackProjectNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - }, - { - "description": "Project ID", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/ProjectSettingsPatchRequest" - } - } - }, - "description": "Update existing project specific settings for a project." - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/ProjectSettingsData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Slack notification settings for a project updated successfully.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update Slack notification settings for a project.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "post": { - "description": "Create Slack settings override for a project.", - "operationId": "createSlackProjectNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Project ID", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/SettingsRequest" - } - } - }, - "description": "Create new Slack notification default settings for a tenant." - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/ProjectSettingsData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Project settings created successfully", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a new Slack settings override for a given project.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "x-snyk-api-resource": "settings" - }, - "/orgs/{org_id}/slack_app/{tenant_id}/channels": { - "get": { - "description": "Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can access. Note that it is currently only possible to page forwards through this collection, no prev links will be generated and the ending_before parameter will not function.", - "operationId": "listChannels", - "parameters": [ - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/ChannelLimit" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/TenantId" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/SlackChannel" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "List of Slack channels", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a list of Slack channels", - "tags": [ - "Slack" - ], - "x-snyk-api-releases": [ - "2022-11-07" - ], - "x-snyk-api-version": "2022-11-07" - }, - "x-snyk-api-resource": "channels" - }, - "/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}": { - "get": { - "description": "Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.", - "operationId": "getChannelNameById", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ChannelId" - }, - { - "$ref": "#/components/parameters/TenantId" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/SlackChannel" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "List of Slack channels", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get Slack Channel name by Slack Channel ID.", - "tags": [ - "Slack" - ], - "x-snyk-api-releases": [ - "2022-11-07" - ], - "x-snyk-api-version": "2022-11-07" - }, - "x-snyk-api-resource": "channels" - }, - "/orgs/{org_id}/targets": { - "get": { - "description": "Get a list of an organization's targets.", - "operationId": "getOrgsTargets", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "description": "Calculate total amount of filtered results", - "in": "query", - "name": "count", - "schema": { - "type": "boolean" - } - }, - { - "description": "Number of results to return per page", - "example": 10, - "in": "query", - "name": "limit", - "schema": { - "default": 10, - "format": "int32", - "maximum": 100, - "minimum": 1, - "type": "integer" - } - }, - { - "description": "The id of the org to return a list of targets", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Return targets that match the provided value of is_private", - "in": "query", - "name": "is_private", - "schema": { - "type": "boolean" - } - }, - { - "description": "Return only the targets that has projects", - "in": "query", - "name": "exclude_empty", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "Return targets that match the provided remote_url.", - "in": "query", - "name": "url", - "schema": { - "type": "string" - } - }, - { - "description": "Return targets that match the provided source_types", - "explode": false, - "in": "query", - "name": "source_types", - "schema": { - "items": { - "enum": [ - "bitbucket-server", - "gitlab", - "github-enterprise", - "bitbucket-cloud", - "bitbucket-connect-app", - "azure-repos", - "github", - "github-cloud-app", - "github-server-app", - "cli", - "docker-hub", - "in-memory-fs", - "acr", - "ecr", - "gcr", - "artifactory-cr", - "harbor-cr", - "quay-cr", - "github-cr", - "nexus-cr", - "nexus-private-repo", - "digitalocean-cr", - "gitlab-cr", - "google-artifact-cr", - "heroku", - "kubernetes", - "api", - "aws-lambda", - "azure-functions", - "cloud-foundry", - "pivotal", - "ibm-cloud", - "terraform-cloud" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return targets with display names starting with the provided string", - "in": "query", - "name": "display_name", - "schema": { - "type": "string" - } - }, - { - "description": "Return only targets which have been created at or after the specified date.\n", - "example": "2022-01-01T16:00:00Z", - "in": "query", - "name": "created_gte", - "schema": { - "format": "date-time", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/PublicTarget" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - }, - "meta": { - "additionalProperties": false, - "example": { - "count": 3 - }, - "properties": { - "count": { - "type": "number" - } - }, - "type": "object" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of targets is returned for the targeted org", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get targets by org ID", - "tags": [ - "Targets" - ], - "x-snyk-api-releases": [ - "2021-08-20~beta", - "2024-02-21" - ], - "x-snyk-api-version": "2024-02-21" - }, - "x-snyk-api-resource": "targets" - }, - "/orgs/{org_id}/targets/{target_id}": { - "delete": { - "description": "Delete the specified target.", - "operationId": "deleteOrgsTarget", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org to delete", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The id of the target to delete", - "in": "path", - "name": "target_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The target is deleted with all projects, if it is found in the specified org.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete target by target ID", - "tags": [ - "Targets" - ], - "x-snyk-api-releases": [ - "2021-09-29~beta", - "2023-06-23~beta", - "2024-02-21" - ], - "x-snyk-api-version": "2024-02-21" - }, - "get": { - "description": "Get a specified target for an organization.", - "operationId": "getOrgsTarget", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org to return the target from", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The id of the target to return", - "in": "path", - "name": "target_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/PublicTarget" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data" - ], - "type": "object" - } - } - }, - "description": "A single target is returned if it is found in the specified org", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get target by target ID", - "tags": [ - "Targets" - ], - "x-snyk-api-releases": [ - "2021-08-20~beta", - "2024-02-21" - ], - "x-snyk-api-version": "2024-02-21" - }, - "x-snyk-api-resource": "targets" - }, - "/self": { - "get": { - "description": "Retrieves information about the the user making the request.", - "operationId": "getSelf", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/Principal20240422" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "Current user is returned", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "My User Details", - "tags": [ - "Users" - ], - "x-snyk-api-releases": [ - "2022-03-01~experimental", - "2022-09-14~experimental", - "2024-04-22" - ], - "x-snyk-api-version": "2024-04-22" - }, - "x-snyk-api-resource": "self", - "x-snyk-resource-singleton": true - }, - "/self/apps": { - "get": { - "description": "Get a list of apps that can act on your behalf.", - "operationId": "getUserInstalledApps", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/PublicApp" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps install that can act on your behalf", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - } - }, - "summary": "Get a list of apps that can act on your behalf.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11" - }, - "x-snyk-api-resource": "user_app_installs" - }, - "/self/apps/installs": { - "get": { - "description": "Get a list of apps installed for an user.", - "operationId": "getAppInstallsForUser", - "parameters": [ - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppInstallData" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps installed for the specified organization.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } - }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } + { + "description": "Include the total number of dependencies found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_dependency_total", + "schema": { + "type": "boolean" } }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } + { + "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" } }, - "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" - } + { + "description": "Filter projects uploaded and monitored after this date (encoded value)", + "example": "2021-05-29T09:50:54.014Z", + "in": "query", + "name": "cli_monitored_after", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Return projects that match the provided importing user public ids.", + "explode": false, + "in": "query", + "name": "importing_user_public_id", + "schema": { + "items": { + "type": "string" }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided tags", + "example": [ + "key1:value1", + "key2:value2" + ], + "explode": false, + "in": "query", + "name": "tags", + "schema": { + "items": { + "pattern": "^[a-zA-Z0-9_-]+:[:/?#@\u0026+=%a-zA-Z0-9_.~-]+$", + "type": "string" }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided business_criticality value", + "explode": false, + "in": "query", + "name": "business_criticality", + "schema": { + "items": { + "enum": [ + "critical", + "high", + "medium", + "low" + ], + "type": "string" }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided environment values", + "explode": false, + "in": "query", + "name": "environment", + "schema": { + "items": { + "enum": [ + "frontend", + "backend", + "internal", + "external", + "mobile", + "saas", + "onprem", + "hosted", + "distributed" + ], + "type": "string" }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided lifecycle values", + "explode": false, + "in": "query", + "name": "lifecycle", + "schema": { + "items": { + "enum": [ + "production", + "development", + "sandbox" + ], + "type": "string" }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } + "type": "array" + }, + "style": "form" }, - "500": { + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" + "attributes": { + "$ref": "#/components/schemas/ProjectAttributes" }, "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", + "description": "Resource ID.", "format": "uuid", "type": "string" }, "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", + "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" }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" + "latest_dependency_total": { + "$ref": "#/components/schemas/LatestDependencyTotal" + }, + "latest_issue_counts": { + "$ref": "#/components/schemas/LatestIssueCounts" } }, "type": "object" }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" + "relationships": { + "$ref": "#/components/schemas/ProjectRelationships" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "type": { + "description": "The Resource type.", + "example": "project", "type": "string" } }, "required": [ - "status", - "detail" + "id", + "type", + "attributes" ], "type": "object" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + }, + "meta": { "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" + "count": { + "minimum": 0, + "type": "number" } }, - "required": [ - "version" - ], "type": "object" } }, "required": [ "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "A list of projects is returned for the targeted org", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Get a list of apps installed for an user.", + "summary": "List all Projects for an Org with the given Org ID.", "tags": [ - "Apps" + "Projects" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" + "2021-06-04~beta", + "2022-08-12~experimental", + "2022-12-21~experimental", + "2023-02-15", + "2023-08-28", + "2023-09-11", + "2023-11-06", + "2024-05-31" ], - "x-snyk-api-version": "2024-05-23" - }, - "x-snyk-api-resource": "app_installs" + "x-snyk-api-resource": "projects", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" + } }, - "/self/apps/installs/{install_id}": { + "/orgs/{org_id}/projects/{project_id}": { "delete": { - "description": "Revoke access for an app by install ID.", - "operationId": "deleteUserAppInstallById", + "description": "Delete one project in the organization by project ID.", + "operationId": "deleteOrgProject", "parameters": [ { - "$ref": "#/components/parameters/Version" + "description": "The ID of the org to which the project belongs to.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "$ref": "#/components/parameters/InstallId" + "description": "The ID of the project.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" } ], "responses": { "204": { - "description": "The app install has been revoked.", + "description": "The project has been deleted", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "schema": { - "type": "string" - } - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -49983,1134 +24726,1347 @@ } }, "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete project by project ID.", + "tags": [ + "Projects" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-11-06", + "2024-05-31" + ], + "x-snyk-api-resource": "projects", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" + }, + "get": { + "description": "Get one project of the organization by project ID.", + "operationId": "getOrgProject", + "parameters": [ + { + "description": "The ID of the org to which the project belongs to.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the project.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "target" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include a summary count for the issues found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_issue_counts", + "schema": { + "type": "boolean" + } + }, + { + "description": "Include the total number of dependencies found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_dependency_total", + "schema": { + "type": "boolean" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProjectAttributes" + }, + "id": { + "description": "The Resource ID.", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": false, + "properties": { + "cli_monitored_at": { + "description": "The date that the project was last uploaded and monitored using cli.", + "example": "2021-05-29T09:50:54.014Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "latest_dependency_total": { + "$ref": "#/components/schemas/LatestDependencyTotal" + }, + "latest_issue_counts": { + "$ref": "#/components/schemas/LatestIssueCounts" + } + }, + "type": "object" + }, + "relationships": { + "$ref": "#/components/schemas/ProjectRelationships" + }, + "type": { + "description": "The Resource type.", + "example": "project", + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, "jsonapi": { - "version": "1.0" + "$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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-02-01~experimental", + "2022-08-12~experimental", + "2022-12-21~experimental", + "2023-02-15", + "2023-08-28", + "2023-09-11", + "2023-11-06", + "2024-05-31" + ], + "x-snyk-api-resource": "projects", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" + }, + "patch": { + "description": "Updates one project of the organization by project ID.", + "operationId": "updateOrgProject", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The ID of the Org the project belongs to.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the project to patch.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "target" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/PatchProjectRequest" + } + } + }, + "description": "The project attributes to be updated." + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProjectAttributes" + }, + "id": { + "description": "The Resource ID.", + "example": "331ede0a-de94-456f-b788-166caeca58bf", + "format": "uuid", + "type": "string" }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "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" + } }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } + "type": "object" }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "relationships": { + "$ref": "#/components/schemas/ProjectRelationships" + }, + "type": { + "description": "The Resource type.", + "example": "project", "type": "string" } }, "required": [ - "version" + "type", + "id", + "attributes" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "A project is updated for the targeted org", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Updates project by project ID.", + "tags": [ + "Projects" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-12-21~experimental", + "2023-02-15", + "2023-08-28", + "2023-09-11", + "2023-11-06", + "2024-05-31" + ], + "x-snyk-api-resource": "projects", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-31", + "x-stability-level": "stable" + } + }, + "/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.6 in JSON (set `format` to `cyclonedx1.6+json`).\n* CycloneDX version 1.6 in XML (set `format` to `cyclonedx1.6+xml`).\n* CycloneDX version 1.5 in JSON (set `format` to `cyclonedx1.5+json`).\n* CycloneDX version 1.5 in XML (set `format` to `cyclonedx1.5+xml`).\n* CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`).\n* CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`).\n* SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`).\n\nBy default it will respond with an empty JSON:API response.", + "operationId": "getSbom", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "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/SbomDocument" + } + }, "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" + "$ref": "#/components/schemas/SbomResponse" + } + }, + "application/vnd.cyclonedx+json": { + "schema": { + "$ref": "#/components/schemas/SbomDocument" + } + }, + "application/vnd.cyclonedx+xml": { + "schema": { + "$ref": "#/components/schemas/SbomDocument" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Returns the SBOM document of a project", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a project’s SBOM document", + "tags": [ + "SBOM" + ], + "x-snyk-api-releases": [ + "2022-03-31~experimental", + "2022-12-06~beta", + "2023-03-20", + "2024-03-12~experimental", + "2024-08-15~beta", + "2024-08-22" + ], + "x-snyk-api-version": "2024-08-22" + }, + "x-snyk-api-resource": "sboms", + "x-snyk-resource-singleton": true + }, + "/orgs/{org_id}/sbom_tests": { + "post": { + "description": "Create an SBOM test run by supplying an SBOM document. The components contained in the given document will get analyzed for known vulnerabilities. In order for component identification to be successful, they must have a PackageURL (purl) of a supported purl type assigned. Analysis will be skipped for any component that does not fulfill this requirement.\nSupported SBOM formats: CycloneDX 1.4 JSON, CycloneDX 1.5 JSON, CycloneDX 1.6 JSON, SPDX 2.3 JSON\nSupported purl types: apk, deb, cargo, cocoapods, composer, gem, generic, golang, hex, maven, npm, nuget, pypi, rpm, swift\n", + "operationId": "createSbomTestRun", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/SbomTestCreateAttributes" }, - "minItems": 1, - "type": "array" + "type": { + "$ref": "#/components/schemas/Types" + } }, - "jsonapi": { + "required": [ + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { "additionalProperties": false, - "example": { - "version": "1.0" - }, + "description": "SBOM test resource object", "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "id": { + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", "type": "string" + }, + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "type" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Created SBOM test successfully", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Create an SBOM test run", + "tags": [ + "SBOM" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-02~experimental", + "2023-08-31~beta", + "2024-04-22~beta", + "2024-07-10~beta" + ], + "x-snyk-api-resource": "sbom_tests", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-07-10~beta", + "x-stability-level": "beta" + } + }, + "/orgs/{org_id}/sbom_tests/{job_id}": { + "get": { + "description": "Get an SBOM test run status", + "operationId": "getSbomTestStatus", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/JobId" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" + "data": { + "description": "SBOM test resource object", + "properties": { + "attributes": { + "properties": { + "status": { + "enum": [ + "processing", + "error", + "finished" + ], + "type": "string" + } }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } + "type": "object" }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "id": { + "format": "uuid", "type": "string" + }, + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "type", + "attributes" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "SBOM test run status", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Gets an SBOM test run status", + "tags": [ + "SBOM" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-02~experimental", + "2023-08-31~beta", + "2024-04-22~beta", + "2024-07-10~beta" + ], + "x-snyk-api-resource": "sbom_tests", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-07-10~beta", + "x-stability-level": "beta" + } + }, + "/orgs/{org_id}/sbom_tests/{job_id}/results": { + "get": { + "description": "Get an SBOM test run result", + "operationId": "getSbomTestResult", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/JobId" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { + "data": { "additionalProperties": false, - "example": { - "version": "1.0" - }, + "description": "SBOM test resource object", "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "attributes": { + "$ref": "#/components/schemas/SbomTestResultsAttributes" + }, + "id": { + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", "type": "string" + }, + "relationships": { + "properties": { + "affected_packages": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResourceReference" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "$ref": "#/components/schemas/Types" } }, "required": [ - "version" + "id", + "type" ], "type": "object" + }, + "included": { + "items": { + "additionalProperties": true, + "type": "object" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "SBOM test results", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + } + }, + "summary": "Gets an SBOM test run result", + "tags": [ + "SBOM" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-02~experimental", + "2023-08-31~beta", + "2024-04-22~beta", + "2024-07-10~beta" + ], + "x-snyk-api-resource": "sbom_tests", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-07-10~beta", + "x-stability-level": "beta" + } + }, + "/orgs/{org_id}/service_accounts": { + "get": { + "description": "Get all service accounts for an organization.", + "operationId": "getManyOrgServiceAccounts", + "parameters": [ + { + "description": "The ID of the Snyk Organization that owns the service accounts.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, - "500": { + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ServiceAccount" + }, + "type": "array" + }, "jsonapi": { - "version": "1.0" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of service accounts is returned.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of organization service accounts.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + }, + "post": { + "description": "Create a service account for an organization. The service account can be used to access the Snyk API.", + "operationId": "createOrgServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Organization that is creating and will own the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", + "maximum": 86400, + "minimum": 3600, + "type": "number" }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", + "auth_type": { + "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], "type": "string" }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", + "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" }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", + "name": { + "description": "A human-friendly name for the service account.", "type": "string" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "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": [ - "status", - "detail" + "name", + "role_id", + "auth_type" ], "type": "object" }, - "minItems": 1, - "type": "array" + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/ServiceAccount" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "A new service account has been created", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$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": "Revoke access for an app by install ID.", + "summary": "Create a service account for an organization.", "tags": [ - "Apps" + "ServiceAccounts" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03", - "2024-05-23" + "2023-09-07" ], - "x-snyk-api-version": "2024-05-23" - }, - "x-snyk-api-resource": "app_installs" + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + } }, - "/self/apps/{app_id}": { + "/orgs/{org_id}/service_accounts/{serviceaccount_id}": { "delete": { - "description": "Revoke access for an app by app id", - "operationId": "revokeUserInstalledApp", + "description": "Delete a service account in an organization.", + "operationId": "deleteServiceAccount", + "parameters": [ + { + "description": "The ID of org to which the service account belongs.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "The service account has been deleted.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete a service account in an organization.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + }, + "get": { + "description": "Get an organization-level service account by its ID.", + "operationId": "getOneOrgServiceAccount", "parameters": [ { - "$ref": "#/components/parameters/Version" + "description": "The ID of the Snyk Organization that owns the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "$ref": "#/components/parameters/AppId" + "$ref": "#/components/parameters/Version" } ], "responses": { - "204": { - "description": "The app has been revoked", + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/ServiceAccount" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "Service account is returned.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, "location": { - "schema": { - "type": "string" - } + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" @@ -51130,1163 +26086,1041 @@ } }, "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": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get an organization service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + }, + "patch": { + "description": "Update the name of an organization-level service account by its ID.", + "operationId": "updateOrgServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Organization that owns the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "name": { + "description": "A human-friendly name for the service account. Must be unique within the organization.", "type": "string" } }, "required": [ - "status", - "detail" + "name" ], "type": "object" }, - "minItems": 1, - "type": "array" + "id": { + "description": "The ID of the service account. Must match the id in the url path.", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/ServiceAccount" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Service account is returned.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "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": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update an organization service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets": { + "post": { + "description": "Manage the client secret of an organization service account by the service account ID.", + "operationId": "updateOrgServiceAccountSecret", + "parameters": [ + { + "description": "The ID of the Snyk Organization that owns the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", + "enum": [ + "replace", + "create", + "delete" + ], "type": "string" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "secret": { + "description": "Secret to delete when using `delete` mode", "type": "string" } }, "required": [ - "status", - "detail" + "mode" ], "type": "object" }, - "minItems": 1, - "type": "array" + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/ServiceAccount" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Service account client secret has been updated.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Manage an organization service account's client secret.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-resource": "service_accounts", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-07", + "x-stability-level": "stable" + } + }, + "/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, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/OrgIacSettingsResponse" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "The Infrastructure as Code Settings of the org.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get the Infrastructure as Code Settings for an org.", + "tags": [ + "IacSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-resource": "iac_settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2021-12-09", + "x-stability-level": "stable" + }, + "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, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrgIacSettingsResponse" + }, "jsonapi": { - "version": "1.0" + "$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-lifecycle": "released", + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-resource": "iac_settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2021-12-09", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/settings/sast": { + "get": { + "description": "Retrieves the SAST settings for an org", + "operationId": "getSastSettings", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org for which we want to retrieve the SAST settings", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "data": { + "$ref": "#/components/schemas/SastEnablement" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "The SAST settings for the org are being retrieved", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, - "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": { + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Retrieves the SAST settings for an org", + "tags": [ + "SastSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-22" + ], + "x-snyk-api-resource": "sast_settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-06-22", + "x-stability-level": "stable" + }, + "patch": { + "description": "Enable/Disable the Snyk Code settings for an org", + "operationId": "updateOrgSastSettings", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org for which we want to update the Snyk Code setting", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" + "sast_enabled": { + "description": "The value of the updated settings for sastEnabled setting", + "type": "boolean" } }, "required": [ - "status", - "detail" + "sast_enabled" ], "type": "object" }, - "minItems": 1, - "type": "array" + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/SastEnablement" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "The SAST settings for the org are being updated", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "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" + "$ref": "#/components/responses/500" + } + }, + "summary": "Enable/Disable the Snyk Code settings for an org", + "tags": [ + "SastSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-08-24~experimental", + "2023-09-11" + ], + "x-snyk-api-resource": "sast_settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-09-11", + "x-stability-level": "stable" + } + }, + "/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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-resource": "settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-12-14", + "x-stability-level": "stable" + }, + "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": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Default settings created successfully", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Revoke an app", + "summary": "Get Slack integration default notification settings.", "tags": [ - "Apps" + "SlackSettings" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2022-03-11" + "2022-11-07~experimental", + "2022-12-14" ], - "x-snyk-api-version": "2022-03-11" + "x-snyk-api-resource": "settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-12-14", + "x-stability-level": "stable" }, - "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", + "post": { + "description": "Create new Slack notification default settings for a given tenant.", + "operationId": "createSlackDefaultNotificationSettings", "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/AppId" + "$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": { - "200": { + "201": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { - "items": { - "$ref": "#/components/schemas/SessionData" - }, - "type": "array" + "$ref": "#/components/schemas/SlackDefaultSettingsData" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "data", - "jsonapi" - ], "type": "object" } } }, - "description": "A list of active OAuth sessions for the app.", + "description": "Default settings created successfully", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -52305,1125 +27139,950 @@ } }, "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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-resource": "settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-12-14", + "x-stability-level": "stable" + } + }, + "/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": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" + "$ref": "#/components/schemas/GetProjectSettingsCollection" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Return default settings for a tenant", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Slack notification settings overrides for projects", + "tags": [ + "SlackSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-resource": "settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-12-14", + "x-stability-level": "stable" + } + }, + "/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-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-resource": "settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-12-14", + "x-stability-level": "stable" + }, + "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" } } }, - "401": { + "description": "Update existing project specific settings for a project." + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/ProjectSettingsData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Slack notification settings for a project updated successfully.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update Slack notification settings for a project.", + "tags": [ + "SlackSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-resource": "settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-12-14", + "x-stability-level": "stable" + }, + "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, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/ProjectSettingsData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Project settings created successfully", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Create a new Slack settings override for a given project.", + "tags": [ + "SlackSettings" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-resource": "settings", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-12-14", + "x-stability-level": "stable" + } + }, + "/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" + } + }, + { + "description": "Tenant ID", + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/SlackChannel" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "List of Slack channels", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of Slack channels", + "tags": [ + "Slack" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07" + ], + "x-snyk-api-resource": "channels", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-11-07", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}": { + "get": { + "description": "Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.", + "operationId": "getChannelNameById", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/ChannelId" + }, + { + "description": "Tenant ID", + "in": "path", + "name": "tenant_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/SlackChannel" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "List of Slack channels", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, - "500": { + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get Slack Channel name by Slack Channel ID.", + "tags": [ + "Slack" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-11-07" + ], + "x-snyk-api-resource": "channels", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-11-07", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/targets": { + "get": { + "description": "Get a list of an organization's targets.", + "operationId": "getOrgsTargets", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "description": "Calculate total amount of filtered results", + "in": "query", + "name": "count", + "schema": { + "type": "boolean" + } + }, + { + "description": "Number of results to return per page", + "example": 10, + "in": "query", + "name": "limit", + "schema": { + "default": 10, + "format": "int32", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "The id of the org to return a list of targets", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Return targets that match the provided value of is_private", + "in": "query", + "name": "is_private", + "schema": { + "type": "boolean" + } + }, + { + "description": "Return only the targets that has projects", + "in": "query", + "name": "exclude_empty", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "Return targets that match the provided remote_url.", + "in": "query", + "name": "url", + "schema": { + "type": "string" + } + }, + { + "description": "Return targets that match the provided source_types", + "explode": false, + "in": "query", + "name": "source_types", + "schema": { + "items": { + "enum": [ + "bitbucket-server", + "gitlab", + "github-enterprise", + "bitbucket-cloud", + "bitbucket-connect-app", + "azure-repos", + "github", + "github-cloud-app", + "github-server-app", + "cli", + "docker-hub", + "in-memory-fs", + "acr", + "ecr", + "gcr", + "artifactory-cr", + "harbor-cr", + "quay-cr", + "github-cr", + "nexus-cr", + "nexus-private-repo", + "digitalocean-cr", + "gitlab-cr", + "google-artifact-cr", + "heroku", + "kubernetes", + "api", + "aws-lambda", + "azure-functions", + "cloud-foundry", + "pivotal", + "ibm-cloud", + "terraform-cloud" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return targets with display names starting with the provided string", + "in": "query", + "name": "display_name", + "schema": { + "type": "string" + } + }, + { + "description": "Return only targets which have been created at or after the specified date.\n", + "example": "2022-01-01T16:00:00Z", + "in": "query", + "name": "created_gte", + "schema": { + "format": "date-time", + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/PublicTarget" }, - "minItems": 1, "type": "array" }, "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + }, + "meta": { "additionalProperties": false, "example": { - "version": "1.0" + "count": 3 }, "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" + "count": { + "type": "number" } }, - "required": [ - "version" - ], "type": "object" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "A list of targets is returned for the targeted org", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Get a list of active OAuth sessions for the app.", + "summary": "Get targets by org ID", "tags": [ - "Apps" + "Targets" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-03-30~experimental", - "2023-11-03" + "2021-08-20~beta", + "2024-02-21" ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "sessions" + "x-snyk-api-resource": "targets", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-02-21", + "x-stability-level": "stable" + } }, - "/self/apps/{app_id}/sessions/{session_id}": { + "/orgs/{org_id}/targets/{target_id}": { "delete": { - "description": "Revoke an active user app session.", - "operationId": "revokeUserAppSession", + "description": "Delete the specified target.", + "operationId": "deleteOrgsTarget", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/AppId" + "description": "The id of the org to delete", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "description": "Session ID", + "description": "The id of the target to delete", "in": "path", - "name": "session_id", + "name": "target_id", "required": true, "schema": { "format": "uuid", @@ -53433,15 +28092,113 @@ ], "responses": { "204": { - "description": "The user app sessions has been revoked.", + "description": "The target is deleted with all projects, if it is found in the specified org.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "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" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete target by target ID", + "tags": [ + "Targets" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2021-09-29~beta", + "2023-06-23~beta", + "2024-02-21" + ], + "x-snyk-api-resource": "targets", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-02-21", + "x-stability-level": "stable" + }, + "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": { - "type": "string" + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/PublicTarget" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" } + } + }, + "description": "A single target is returned if it is found in the specified org", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" @@ -53461,1109 +28218,1204 @@ } }, "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get target by target ID", + "tags": [ + "Targets" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2021-08-20~beta", + "2024-02-21" + ], + "x-snyk-api-resource": "targets", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-02-21", + "x-stability-level": "stable" + } + }, + "/orgs/{org_id}/users/{id}": { + "get": { + "description": "Get a summary of user.\n\nNote that Service Accounts are not returned by this endpoint. Please use the Service Accounts endpoints.\n", + "operationId": "getUser", + "parameters": [ + { + "description": "The id of the org", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The id of the user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "$ref": "#/components/schemas/User" + }, "jsonapi": { - "version": "1.0" + "$ref": "#/components/schemas/JsonApi" } }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "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-lifecycle": "released", + "x-snyk-api-releases": [ + "2021-09-13~beta" + ], + "x-snyk-api-resource": "users", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2021-09-13~beta", + "x-stability-level": "beta" + } + }, + "/self": { + "get": { + "description": "Retrieves information about the the user making the request.", + "operationId": "getSelf", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/Principal20240422" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Current user is returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "My User Details", + "tags": [ + "Users" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-03-01~experimental", + "2022-09-14~experimental", + "2024-04-22" + ], + "x-snyk-api-resource": "self", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-04-22", + "x-stability-level": "stable" + } + }, + "/self/access_requests": { + "get": { + "description": "Get a list of user's access requests", + "operationId": "getAccessRequests", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/OrgIdFilter" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AccessRequest" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "A list of access requests are returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get access requests", + "tags": [ + "AccessRequests" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-12-01~experimental", + "2023-12-21~beta" + ], + "x-snyk-api-resource": "self", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2023-12-21~beta", + "x-stability-level": "beta" + } + }, + "/self/apps": { + "get": { + "description": "Get a list of apps that can act on your behalf.", + "operationId": "getUserInstalledApps", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/PublicApp" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "A list of apps install that can act on your behalf", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Get a list of apps that can act on your behalf.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-resource": "user_app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-stability-level": "stable" + } + }, + "/self/apps/installs": { + "get": { + "description": "Get a list of apps installed for an user.", + "operationId": "getAppInstallsForUser", + "parameters": [ + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } - } - } + "type": "array" + }, + "style": "form" }, - "404": { + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppInstallData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "A list of apps installed for the specified organization.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Get a list of apps installed for an user.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } + }, + "/self/apps/installs/{install_id}": { + "delete": { + "description": "Revoke access for an app by install ID.", + "operationId": "deleteUserAppInstallById", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/InstallId" + } + ], + "responses": { + "204": { + "description": "The app install has been revoked.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "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": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Revoke access for an app by install ID.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-resource": "app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2024-05-23", + "x-stability-level": "stable" + } + }, + "/self/apps/{app_id}": { + "delete": { + "description": "Revoke access for an app by app id", + "operationId": "revokeUserInstalledApp", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/AppId" + } + ], + "responses": { + "204": { + "description": "The app has been revoked", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date", "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__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Revoke an app", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-resource": "user_app_installs", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2022-03-11", + "x-stability-level": "stable" + } + }, + "/self/apps/{app_id}/sessions": { + "get": { + "description": "Get a list of active OAuth sessions for the app.", + "operationId": "getUserAppSessions", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/AppId" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/SessionData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ - "jsonapi", - "errors" + "data", + "jsonapi" ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "A list of active OAuth sessions for the app.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Get a list of active OAuth sessions for the app.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-03-30~experimental", + "2023-11-03" + ], + "x-snyk-api-resource": "sessions", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" + } + }, + "/self/apps/{app_id}/sessions/{session_id}": { + "delete": { + "description": "Revoke an active user app session.", + "operationId": "revokeUserAppSession", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/AppId" + }, + { + "description": "Session ID", + "in": "path", + "name": "session_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The user app sessions has been revoked.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400__0" + }, + "401": { + "$ref": "#/components/responses/401__0" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404__0" + }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { + "$ref": "#/components/responses/500__0" + } + }, + "summary": "Revoke an active user app session.", + "tags": [ + "Apps" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2023-03-30~experimental", + "2023-11-03" + ], + "x-snyk-api-resource": "sessions", + "x-snyk-api-stability": "ga", + "x-snyk-api-version": "2023-11-03", + "x-stability-level": "stable" + } + }, + "/tenants/{tenant_id}/memberships": { + "get": { + "description": "Returns all memberships of the tenant", + "operationId": "getTenantMemberships", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/TenantId" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Which column to sort by.", + "in": "query", + "name": "sort_by", + "schema": { + "enum": [ + "username", + "user_display_name", + "email", + "login_method", + "role_name" + ], + "type": "string" + } + }, + { + "$ref": "#/components/parameters/SortOrder" + }, + { + "$ref": "#/components/parameters/EmailFilter" + }, + { + "$ref": "#/components/parameters/UserIdSearchFilter" + }, + { + "$ref": "#/components/parameters/NameFilter" + }, + { + "$ref": "#/components/parameters/UsernameFilter" + }, + { + "$ref": "#/components/parameters/ConnectionTypeFilter" + }, + { + "$ref": "#/components/parameters/RoleFilter" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/ListTenantMembershipResponseData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "List of tenant memberships is returned", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD", - "example": "2021-08-02", + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get all memberships of the tenant", + "tags": [ + "Tenants" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-05-09~experimental", + "2024-09-03~beta" + ], + "x-snyk-api-resource": "memberships", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-09-03~beta", + "x-stability-level": "beta" + } + }, + "/tenants/{tenant_id}/memberships/{membership_id}": { + "delete": { + "description": "Delete an individual tenant membership for a single user.", + "operationId": "deleteTenantMembership", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Unique identifier of the tenant membership.", + "in": "path", + "name": "membership_id", + "required": true, + "schema": { + "description": "Unique identifier for a tenant membership.", + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/TenantId" + } + ], + "responses": { + "204": { + "description": "successfully deleting an individual membership for a single user", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete an individual tenant membership for a single user.", + "tags": [ + "Tenants" + ], + "x-snyk-api-lifecycle": "released", + "x-snyk-api-releases": [ + "2024-06-04~experimental", + "2024-09-03~beta" + ], + "x-snyk-api-resource": "memberships", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-09-03~beta", + "x-stability-level": "beta" + }, + "patch": { + "description": "Update the tenant membership with the new role\n", + "operationId": "updateTenantMembership", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/TenantId" + }, + { + "description": "Unique identifier of the tenant membership.", + "in": "path", + "name": "membership_id", + "required": true, + "schema": { + "description": "Unique identifier for a tenant membership.", + "example": "00000000-0000-0000-0000-000000000000", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/UpdateTenantMembershipRequestData" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "successfully updated the tenant membership", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date", "type": "string" } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Revoke an active user app session.", + "summary": "Update tenant membership", "tags": [ - "Apps" + "Tenants" ], + "x-snyk-api-lifecycle": "released", "x-snyk-api-releases": [ - "2023-03-30~experimental", - "2023-11-03" + "2024-06-09~experimental", + "2024-09-03~beta" ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "sessions" + "x-snyk-api-resource": "memberships", + "x-snyk-api-stability": "beta", + "x-snyk-api-version": "2024-09-03~beta", + "x-stability-level": "beta" + } } }, "security": [ @@ -54581,85 +29433,21 @@ } ], "tags": [ - { - "description": "Third-party Apps that integrate with the Snyk platform. See our [overview documentation](https://docs.snyk.io/integrations/snyk-apps) for more details.", - "name": "Apps" - }, - { - "description": "Audit Logs", - "name": "Audit Logs" - }, - { - "description": "User-defined collections of projects", - "name": "Collection" - }, { "description": "Container Image resource", "name": "ContainerImage" }, { - "description": "Through the Custom Base Image Recommendation feature, Snyk can recommend an image upgrade from a pool of the your internal images. \nThis allows your teams to be notified of newer and more secure versions of internal base images.\n\nNotable changes to this API resource:\n- starting with version \"2023-09-20\", the `GET` `/custom_base_images` endpoint requires the `repository` filter when sorting by `version`.\n- starting with version \"2024-01-04\", `VersioningSchema` objects with `type` `\"date\"` are no longer supported. Snyk recommends updating custom base images with the deprecated type to `\"single-selection\"`.\n", - "name": "Custom Base Images" - }, - { - "description": "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": "Organization Invites.", - "name": "Invites" - }, - { - "description": "Issues discovered in projects.", + "description": "Issues relevant to a particular package", "name": "Issues" }, { - "description": "The OpenAPI specification for slack-app.", + "description": "The OpenAPI specification for container-image-service.", "name": "OpenAPI" }, - { - "description": "An Organization is the lowest level of Snyk's tenancy hierarchy, and may contain projects and other data.", - "name": "Orgs" - }, - { - "description": "A project is a single external resource which has been scanned by Snyk such as a manifest file or a container image. It may also be continuously monitored by Snyk.\n", - "name": "Projects" - }, - { - "description": "Snyk pull request templates allow you to control title, description, commit message.", - "name": "Pull Request Templates" - }, { "description": "A Software Bill of Materials document", "name": "SBOM" - }, - { - "description": "SAST Settings modifications for an org", - "name": "SastSettings" - }, - { - "description": "Service accounts can be used for continuous integration (CI) and other automation purposes, without using an actual Snyk user’s token.", - "name": "ServiceAccounts" - }, - { - "description": "Slack integration configuration.", - "name": "Slack" - }, - { - "description": "Slack app integration settings.", - "name": "SlackSettings" - }, - { - "description": "Snyk Users", - "name": "Users" } ], "x-cerberus": { @@ -54669,10 +29457,8 @@ "InternalJWT": {} } ] - }, - "enableAccessAudit": true + } }, - "x-optic-url": "https://app.useoptic.com/organizations/390ef489-882c-48ba-acb3-4e0b73e48767/apis/5Tz5UMTNEIuz5-FZ6J2ki", "x-snyk-api-lifecycle": "released", - "x-snyk-api-version": "2024-08-25" + "x-snyk-api-version": "2024-10-15" } \ No newline at end of file diff --git a/docs/snyk-api/reference/containerimage.md b/docs/snyk-api/reference/containerimage.md deleted file mode 100644 index 192cb520a3cf..000000000000 --- a/docs/snyk-api/reference/containerimage.md +++ /dev/null @@ -1,17 +0,0 @@ -# ContainerImage - -{% hint style="info" %} -This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page. -{% endhint %} - -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/container_images" method="get" %} -[rest-spec.json](../../.gitbook/assets/rest-spec.json) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/container_images/{image_id}" method="get" %} -[rest-spec.json](../../.gitbook/assets/rest-spec.json) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs" method="get" %} -[rest-spec.json](../../.gitbook/assets/rest-spec.json) -{% endswagger %} diff --git a/docs/snyk-api/reference/dependencies-v1.md b/docs/snyk-api/reference/dependencies-v1.md deleted file mode 100644 index 2a2c6ab2a4d2..000000000000 --- a/docs/snyk-api/reference/dependencies-v1.md +++ /dev/null @@ -1,9 +0,0 @@ -# Dependencies (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/dependencies" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/entitlements-v1.md b/docs/snyk-api/reference/entitlements-v1.md deleted file mode 100644 index 6b3919c8f662..000000000000 --- a/docs/snyk-api/reference/entitlements-v1.md +++ /dev/null @@ -1,13 +0,0 @@ -# Entitlements (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/entitlements" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/entitlement/{entitlementKey}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/groups-v1.md b/docs/snyk-api/reference/groups-v1.md deleted file mode 100644 index 458b162cb494..000000000000 --- a/docs/snyk-api/reference/groups-v1.md +++ /dev/null @@ -1,37 +0,0 @@ -# Groups (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/tags" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/tags/delete" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/settings" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/settings" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/roles" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/orgs" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/org/{orgId}/members" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/members" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/ignores-v1.md b/docs/snyk-api/reference/ignores-v1.md deleted file mode 100644 index 7cb9fdaaff56..000000000000 --- a/docs/snyk-api/reference/ignores-v1.md +++ /dev/null @@ -1,25 +0,0 @@ -# Ignores (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/ignores" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/ignore/{issueId}" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/ignore/{issueId}" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/ignore/{issueId}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/ignore/{issueId}" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/import-projects-v1.md b/docs/snyk-api/reference/import-projects-v1.md deleted file mode 100644 index 2118eea740c9..000000000000 --- a/docs/snyk-api/reference/import-projects-v1.md +++ /dev/null @@ -1,13 +0,0 @@ -# Import Projects (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/import" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/import/{jobId}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/integrations-v1.md b/docs/snyk-api/reference/integrations-v1.md deleted file mode 100644 index 09d27b5c6e23..000000000000 --- a/docs/snyk-api/reference/integrations-v1.md +++ /dev/null @@ -1,45 +0,0 @@ -# Integrations (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{type}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/settings" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/settings" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/clone" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication/switch-token" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication/provision-token" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/issues.md b/docs/snyk-api/reference/issues.md index 37852a1e76e7..903691ae0a06 100644 --- a/docs/snyk-api/reference/issues.md +++ b/docs/snyk-api/reference/issues.md @@ -4,14 +4,6 @@ This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page. {% endhint %} -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/packages/{purl}/issues" method="get" %} -[rest-spec.json](../../.gitbook/assets/rest-spec.json) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/packages/issues" method="post" %} -[rest-spec.json](../../.gitbook/assets/rest-spec.json) -{% endswagger %} - {% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/issues" method="get" %} [rest-spec.json](../../.gitbook/assets/rest-spec.json) {% endswagger %} diff --git a/docs/snyk-api/reference/jira-v1.md b/docs/snyk-api/reference/jira-v1.md deleted file mode 100644 index fbc5c995a918..000000000000 --- a/docs/snyk-api/reference/jira-v1.md +++ /dev/null @@ -1,13 +0,0 @@ -# Jira (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/jira-issues" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/issue/{issueId}/jira-issue" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/licenses-v1.md b/docs/snyk-api/reference/licenses-v1.md deleted file mode 100644 index 7dad7de1e0ca..000000000000 --- a/docs/snyk-api/reference/licenses-v1.md +++ /dev/null @@ -1,11 +0,0 @@ -# Licenses (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -**Note:** When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay. - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/licenses" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/monitor-v1.md b/docs/snyk-api/reference/monitor-v1.md deleted file mode 100644 index 7879f5d06557..000000000000 --- a/docs/snyk-api/reference/monitor-v1.md +++ /dev/null @@ -1,9 +0,0 @@ -# Monitor (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/monitor/dep-graph" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/organizations-v1.md b/docs/snyk-api/reference/organizations-v1.md deleted file mode 100644 index 0d5c6b3aa74c..000000000000 --- a/docs/snyk-api/reference/organizations-v1.md +++ /dev/null @@ -1,65 +0,0 @@ -# Organizations (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/orgs" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/settings" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/settings" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/provision" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/provision" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/provision" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/notification-settings" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/notification-settings" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members/{userId}" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members/{userId}" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members/update/{userId}" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/invite" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/orgs.md b/docs/snyk-api/reference/orgs.md index 2f219c76a53b..584942511f85 100644 --- a/docs/snyk-api/reference/orgs.md +++ b/docs/snyk-api/reference/orgs.md @@ -12,10 +12,6 @@ This document uses the REST API. For more details, see the [Authentication for A [rest-spec.json](../../.gitbook/assets/rest-spec.json) {% endswagger %} -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}" method="get" %} -[rest-spec.json](../../.gitbook/assets/rest-spec.json) -{% endswagger %} - {% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/memberships" method="post" %} [rest-spec.json](../../.gitbook/assets/rest-spec.json) {% endswagger %} diff --git a/docs/snyk-api/reference/projects-v1.md b/docs/snyk-api/reference/projects-v1.md deleted file mode 100644 index 9208a3cf4bd9..000000000000 --- a/docs/snyk-api/reference/projects-v1.md +++ /dev/null @@ -1,65 +0,0 @@ -# Projects (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/tags" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/tags/remove" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/settings" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/settings" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/settings" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/move" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/issue/{issueId}/paths" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/dep-graph" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/deactivate" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/attributes" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/aggregated-issues" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/activate" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/reporting-api-v1.md b/docs/snyk-api/reference/reporting-api-v1.md deleted file mode 100644 index 3f36ffd535b0..000000000000 --- a/docs/snyk-api/reference/reporting-api-v1.md +++ /dev/null @@ -1,33 +0,0 @@ -# Reporting API (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/reporting/issues/latest" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/reporting/issues/" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/reporting/counts/tests" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/reporting/counts/projects" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/reporting/counts/projects/latest" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/reporting/counts/issues" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/reporting/counts/issues/latest" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/sbom.md b/docs/snyk-api/reference/sbom.md deleted file mode 100644 index a92bcfb468b3..000000000000 --- a/docs/snyk-api/reference/sbom.md +++ /dev/null @@ -1,9 +0,0 @@ -# SBOM - -{% hint style="info" %} -This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page. -{% endhint %} - -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/projects/{project_id}/sbom" method="get" %} -[rest-spec.json](../../.gitbook/assets/rest-spec.json) -{% endswagger %} diff --git a/docs/snyk-api/reference/snapshots-v1.md b/docs/snyk-api/reference/snapshots-v1.md deleted file mode 100644 index 952c5b24c8cf..000000000000 --- a/docs/snyk-api/reference/snapshots-v1.md +++ /dev/null @@ -1,17 +0,0 @@ -# Snapshots (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/history" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/history/{snapshotId}/issue/{issueId}/paths" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}/history/{snapshotId}/aggregated-issues" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/test-v1.md b/docs/snyk-api/reference/test-v1.md deleted file mode 100644 index e6e13803e5cb..000000000000 --- a/docs/snyk-api/reference/test-v1.md +++ /dev/null @@ -1,73 +0,0 @@ -# Test (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/yarn" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/sbt" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/sbt/{groupId}/{artifactId}/{version}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/rubygems" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/rubygems/{gemName}/{version}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/pip" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/pip/{packageName}/{version}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/npm" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/npm/{packageName}/{version}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/maven" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/maven/{groupId}/{artifactId}/{version}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/gradle" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/gradle/{group}/{name}/{version}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/govendor" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/golangdep" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/dep-graph" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/test/composer" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/users-v1.md b/docs/snyk-api/reference/users-v1.md deleted file mode 100644 index ffe760f65253..000000000000 --- a/docs/snyk-api/reference/users-v1.md +++ /dev/null @@ -1,29 +0,0 @@ -# Users (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/user/{userId}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/user/me" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/user/me/notification-settings/org/{orgId}" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/user/me/notification-settings/org/{orgId}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/user/me/notification-settings/org/{orgId}/project/{projectId}" method="put" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/user/me/notification-settings/org/{orgId}/project/{projectId}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/reference/webhooks-v1.md b/docs/snyk-api/reference/webhooks-v1.md deleted file mode 100644 index f056a65360e3..000000000000 --- a/docs/snyk-api/reference/webhooks-v1.md +++ /dev/null @@ -1,25 +0,0 @@ -# Webhooks (v1) - -{% hint style="info" %} -This document uses the v1 API. For more details, see the [v1 API](../v1-api.md). -{% endhint %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/webhooks" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/webhooks" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/webhooks/{webhookId}" method="get" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/webhooks/{webhookId}" method="delete" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/webhooks/{webhookId}/ping" method="post" %} -[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml) -{% endswagger %} diff --git a/docs/snyk-api/rest-api/changelog.md b/docs/snyk-api/rest-api/changelog.md index 150d91b7fe0a..41c94749071e 100644 --- a/docs/snyk-api/rest-api/changelog.md +++ b/docs/snyk-api/rest-api/changelog.md @@ -1,3 +1,445 @@ +## 2024-10-15 + +### GET - `/self/apps` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/self/apps/{app_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/self/apps/{app_id}/sessions` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/self/apps/{app_id}/sessions/{session_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/self/apps/installs` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/self/apps/installs/{install_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/orgs/{org_id}/projects` - Updated +- added `#/components/schemas/ProjectRelationshipsTarget` to the `data/items/relationships/target` response property `oneOf` list for the response status `200` + +- removed `#/components/schemas/ProjectRelationshipsTarget20230215` from the `data/items/relationships/target` response property `oneOf` list for the response status `200` + + + +### PATCH - `/orgs/{org_id}/projects/{project_id}` - Updated +- added `#/components/schemas/ProjectRelationshipsTarget` to the `data/relationships/target` response property `oneOf` list for the response status `200` + +- removed `#/components/schemas/ProjectRelationshipsTarget20230215` from the `data/relationships/target` response property `oneOf` list for the response status `200` + + + +### GET - `/orgs/{org_id}/projects/{project_id}` - Updated +- added `#/components/schemas/ProjectRelationshipsTarget` to the `data/relationships/target` response property `oneOf` list for the response status `200` + +- removed `#/components/schemas/ProjectRelationshipsTarget20230215` from the `data/relationships/target` response property `oneOf` list for the response status `200` + + + +### POST - `/orgs/{org_id}/apps` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/orgs/{org_id}/apps` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### PATCH - `/orgs/{org_id}/apps/{client_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/orgs/{org_id}/apps/{client_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/orgs/{org_id}/apps/{client_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### POST - `/orgs/{org_id}/apps/{client_id}/secrets` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### POST - `/orgs/{org_id}/apps/installs` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/orgs/{org_id}/apps/installs` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/orgs/{org_id}/apps/installs/{install_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### POST - `/orgs/{org_id}/apps/installs/{install_id}/secrets` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### POST - `/orgs/{org_id}/apps/creations` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/orgs/{org_id}/apps/creations` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### PATCH - `/orgs/{org_id}/apps/creations/{app_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/orgs/{org_id}/apps/creations/{app_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/orgs/{org_id}/apps/creations/{app_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### POST - `/orgs/{org_id}/apps/creations/{app_id}/secrets` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/orgs/{org_id}/app_bots` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/orgs/{org_id}/app_bots/{bot_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### POST - `/groups/{group_id}/apps/installs` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### GET - `/groups/{group_id}/apps/installs` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### DELETE - `/groups/{group_id}/apps/installs/{install_id}` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + + +### POST - `/groups/{group_id}/apps/installs/{install_id}/secrets` - Updated +- added the optional property `errors/items/links` to the response with the `400` status + +- added the optional property `errors/items/links` to the response with the `401` status + +- added the optional property `errors/items/links` to the response with the `403` status + +- added the optional property `errors/items/links` to the response with the `404` status + +- added the optional property `errors/items/links` to the response with the `409` status + +- added the optional property `errors/items/links` to the response with the `500` status + + ## 2024-08-25 - Updated 2024-10-10 ### GET - `/self` - Updated diff --git a/tools/api-docs-generator/sync-state.yml b/tools/api-docs-generator/sync-state.yml index a8259879ad74..2fd6cb83e5d1 100644 --- a/tools/api-docs-generator/sync-state.yml +++ b/tools/api-docs-generator/sync-state.yml @@ -1 +1 @@ -lastSyncedVersion: "2024-08-25" +lastSyncedVersion: "2024-10-15"