ProjectMeta
{
"type": "object",
"required": [
"imported",
"last_tested_at",
"issues_critical_count",
"issues_high_count",
"issues_medium_count",
"issues_low_count"
],
"properties": {
"imported": {
"type": "string",
"format": "date-time",
"example": "2021-05-29T09:50:54.014Z",
"description": "The time the project was imported"
},
"last_tested_at": {
"type": "string",
"format": "date-time",
"example": "2021-05-29T09:50:54.014Z",
"description": "The time the project was last tested"
},
"issues_low_count": {
"type": "number",
"example": 10,
"description": "The sum of low severity issues of the project"
},
"issues_high_count": {
"type": "number",
"example": 10,
"description": "The sum of high severity issues of the project"
},
"issues_medium_count": {
"type": "number",
"example": 10,
"description": "The sum of medium severity issues of the project"
},
"issues_critical_count": {
"type": "number",
"example": 10,
"description": "The sum of critical severity issues of the project"
}
}
}
ProjectOfCollection
{
"type": "object",
"required": [
"id",
"type",
"meta",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"meta": {
"$ref": "#/components/schemas/ProjectMeta"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"relationships": {
"$ref": "#/components/schemas/ProjectRelationships"
}
}
}
ProjectRelationships
{
"type": "object",
"required": [
"target"
],
"properties": {
"target": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "331ede0a-de94-456f-b788-166caeca58bf",
"description": "ID of the target that owns the project"
},
"type": {
"enum": [
"target"
],
"type": "string"
}
}
}
}
}
}
}
ProjectRelationshipsTarget
{
"type": "object",
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The Resource ID."
},
"meta": {
"type": "object",
"properties": {
"integration_data": {
"type": "object",
"description": "A collection of properties regarding integration data"
}
}
},
"type": {
"type": "string",
"example": "target",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "http://github.com/snyk/local-goof",
"nullable": true,
"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"
},
"display_name": {
"type": "string",
"example": "snyk-fixtures/goof",
"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"
}
}
}
}
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
ProjectSettings
{
"type": "object",
"required": [
"recurring_tests",
"pull_requests"
],
"properties": {
"pull_requests": {
"$ref": "#/components/schemas/PullRequestsSettings"
},
"recurring_tests": {
"$ref": "#/components/schemas/RecurringTestsSettings"
},
"auto_remediation_prs": {
"$ref": "#/components/schemas/AutoRemediationPRsSettings"
},
"manual_remediation_prs": {
"$ref": "#/components/schemas/ManualRemediationPRsSettings"
},
"auto_dependency_upgrade": {
"$ref": "#/components/schemas/AutoDependencyUpgradeSettings"
},
"pull_request_assignment": {
"$ref": "#/components/schemas/PullRequestAssignmentSettings"
}
}
}
ProjectSettingsData
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"type": "string",
"example": "slack"
},
"attributes": {
"type": "object",
"required": [
"target_channel_id",
"target_channel_name",
"severity_threshold",
"target_project_name",
"is_active"
],
"properties": {
"is_active": {
"$ref": "#/components/schemas/IsActive"
},
"target_channel_id": {
"$ref": "#/components/schemas/TargetChannelId"
},
"severity_threshold": {
"$ref": "#/components/schemas/SeverityThreshold"
},
"target_channel_name": {
"$ref": "#/components/schemas/TargetChannelName"
},
"target_project_name": {
"type": "string",
"example": "snyk/goof:package.json",
"description": "The target file name for the project."
}
}
}
}
}
ProjectSettingsPatchRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"enum": [
"slack"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"is_active": {
"$ref": "#/components/schemas/IsActive"
},
"target_channel_id": {
"$ref": "#/components/schemas/TargetChannelId"
},
"severity_threshold": {
"$ref": "#/components/schemas/SeverityThreshold"
}
},
"minProperties": 1
}
}
}
}
}
ProjectsGetByProjectIdResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The Resource ID."
},
"meta": {
"type": "object",
"properties": {
"cli_monitored_at": {
"type": "string",
"format": "date-time",
"example": "2021-05-29T09:50:54.014Z",
"nullable": true,
"description": "The date that the project was last uploaded and monitored using cli."
},
"latest_issue_counts": {
"$ref": "#/components/schemas/LatestIssueCounts"
},
"latest_dependency_total": {
"$ref": "#/components/schemas/LatestDependencyTotal"
}
}
},
"type": {
"type": "string",
"example": "project",
"description": "The Resource type."
},
"attributes": {
"$ref": "#/components/schemas/ProjectAttributes"
},
"relationships": {
"type": "object",
"required": [
"target",
"organization"
],
"properties": {
"owner": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
"target": {
"oneOf": [
{
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
{
"type": "object",
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The Resource ID."
},
"meta": {
"type": "object",
"properties": {
"integration_data": {
"type": "object",
"description": "A collection of properties regarding integration data"
}
}
},
"type": {
"type": "string",
"example": "target",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "http://github.com/snyk/local-goof",
"nullable": true,
"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"
},
"display_name": {
"type": "string",
"example": "snyk-fixtures/goof",
"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"
}
}
}
}
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
]
},
"importer": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
"organization": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ProjectsListForOrgResponse
{
"type": "object",
"required": [
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Resource ID."
},
"meta": {
"type": "object",
"properties": {
"cli_monitored_at": {
"type": "string",
"format": "date-time",
"example": "2021-05-29T09:50:54.014Z",
"nullable": true,
"description": "The date that the project was last uploaded and monitored using cli."
},
"latest_issue_counts": {
"$ref": "#/components/schemas/LatestIssueCounts"
},
"latest_dependency_total": {
"$ref": "#/components/schemas/LatestDependencyTotal"
}
}
},
"type": {
"type": "string",
"example": "project",
"description": "The Resource type."
},
"attributes": {
"$ref": "#/components/schemas/ProjectAttributes"
},
"relationships": {
"type": "object",
"required": [
"target",
"organization"
],
"properties": {
"owner": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
"target": {
"oneOf": [
{
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
{
"type": "object",
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The Resource ID."
},
"meta": {
"type": "object",
"properties": {
"integration_data": {
"type": "object",
"description": "A collection of properties regarding integration data"
}
}
},
"type": {
"type": "string",
"example": "target",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "http://github.com/snyk/local-goof",
"nullable": true,
"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"
},
"display_name": {
"type": "string",
"example": "snyk-fixtures/goof",
"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"
}
}
}
}
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
]
},
"importer": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
"organization": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"count": {
"type": "number",
"minimum": 0
}
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ProjectsUpdateByProjectIdResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "331ede0a-de94-456f-b788-166caeca58bf",
"description": "The Resource ID."
},
"meta": {
"type": "object",
"properties": {
"cli_monitored_at": {
"type": "string",
"format": "date-time",
"example": "2021-05-29T09:50:54.014Z",
"nullable": true,
"description": "The date that the project was last uploaded and monitored using cli."
}
}
},
"type": {
"type": "string",
"example": "project",
"description": "The Resource type."
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"$ref": "#/components/schemas/ProjectAttributes"
},
"relationships": {
"type": "object",
"required": [
"target",
"organization"
],
"properties": {
"owner": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
"target": {
"oneOf": [
{
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
{
"type": "object",
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The Resource ID."
},
"meta": {
"type": "object",
"properties": {
"integration_data": {
"type": "object",
"description": "A collection of properties regarding integration data"
}
}
},
"type": {
"type": "string",
"example": "target",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "http://github.com/snyk/local-goof",
"nullable": true,
"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"
},
"display_name": {
"type": "string",
"example": "snyk-fixtures/goof",
"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"
}
}
}
}
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
]
},
"importer": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
},
"organization": {
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06aX",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
PublicApp
{
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"$ref": "#/components/schemas/PublicAppAttributes"
}
}
}
PublicAppAttributes
{
"type": "object",
"required": [
"name",
"client_id"
],
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"scopes": {
"$ref": "#/components/schemas/Scopes"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"client_id": {
"$ref": "#/components/schemas/ClientId"
}
}
}
PublicAppData
{
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object",
"required": [
"name",
"client_id"
],
"properties": {
"name": {
"type": "string",
"example": "My App",
"minLength": 1,
"description": "New name of the app to display to users during authorization flow."
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "The scopes this app is allowed to request during authorization."
},
"context": {
"enum": [
"tenant",
"user"
],
"type": "string",
"description": "Allow installing the app to a org/group or to a user, default tenant."
},
"client_id": {
"type": "string",
"format": "uuid"
}
}
}
}
}
PublicFacingRiskFactor
{
"type": "object",
"required": [
"name",
"updated_at",
"value"
],
"properties": {
"name": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/RiskFactorLinks"
},
"value": {
"type": "boolean"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"included_in_score": {
"type": "boolean",
"default": false
}
}
}
PublicTarget
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "55a348e2-c3ad-4bbc-b40e-9b232d1f4121",
"description": "The id of this target"
},
"type": {
"type": "string",
"example": "target",
"description": "Content type."
},
"attributes": {
"type": "object",
"required": [
"display_name",
"url",
"is_private"
],
"properties": {
"url": {
"type": "string",
"example": "http://github.com/snyk/local-goof",
"nullable": true,
"description": "The URL for the resource."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-09-01T00:00:00Z",
"description": "The creation date of the target"
},
"is_private": {
"type": "boolean",
"example": false,
"description": "If the target is private, or publicly accessible"
},
"display_name": {
"type": "string",
"example": "snyk-fixtures/goof",
"description": "The human readable name that represents this target. These are generated based on the provided properties, and the source.\n"
}
}
},
"relationships": {
"type": "object",
"required": [
"organization",
"integration"
],
"properties": {
"integration": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "7667dae6-602c-45d9-baa9-79e1a640f199",
"nullable": true
},
"type": {
"type": "string",
"example": "integration",
"description": "Content type."
},
"attributes": {
"type": "object",
"required": [
"integration_type"
],
"properties": {
"integration_type": {
"type": "string",
"example": "gitlab",
"description": "The human readable name for this type of integration"
}
}
}
}
}
},
"description": "The configured integration which this target relates to"
},
"organization": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "e661d4ef-5ad5-4cef-ad16-5157cefa83f5"
},
"type": {
"type": "string",
"example": "organization",
"description": "Content type."
}
}
}
},
"description": "The organization which owns this target"
}
}
}
}
}
PullRequestAssignmentSettings
{
"type": "object",
"properties": {
"type": {
"enum": [
"auto",
"manual"
],
"type": "string",
"example": "auto",
"description": "Automatically assign the last user to change the manifest file (\"auto\"), or manually specify a list of users (\"manual\")."
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"my-github-username"
],
"description": "Manually specify users to assign (and all will be assigned)."
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Automatically assign pull requests created by Snyk."
}
},
"description": "Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Project's integration."
}
PullRequestsSettings
{
"type": "object",
"properties": {
"policy": {
"enum": [
"all",
"only_new"
],
"type": "string",
"example": "all",
"description": "Fail if the project has any issues (\"all\"), or fail if a PR is introducing a new dependency with issues (\"only_new\"). If this value is unset, the setting is inherited from the org default."
},
"severity_threshold": {
"enum": [
"low",
"medium",
"high",
"critical"
],
"type": "string",
"example": "high",
"description": "Only fail for issues greater than or equal to the specified severity. If this value is unset, the setting is inherited from the org default."
},
"fail_only_for_issues_with_fix": {
"type": "boolean",
"example": true,
"description": "Only fail when the issues found have a fix available."
}
},
"description": "Settings which describe how pull requests for a project are tested."
}
QueryVersion
{
"type": "string",
"pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$",
"description": "Requested API version"
}
RecurringTestsSettings
{
"type": "object",
"properties": {
"frequency": {
"enum": [
"daily",
"weekly",
"never"
],
"type": "string",
"example": "daily",
"description": "Test frequency of a project. Also controls when automated PRs may be created."
}
},
"description": "Settings which describe how recurring tests are run for a project."
}
RedirectUris
{
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"example": [
"https://example.com/callback"
],
"minItems": 1,
"description": "List of allowed redirect URIs to call back after authentication."
}
RedirectUrisNoMin
{
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"example": [
"https://example.com/callback"
],
"description": "List of allowed redirect URIs to call back after authentication."
}
Region
{
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"end": {
"$ref": "#/components/schemas/FilePosition"
},
"start": {
"$ref": "#/components/schemas/FilePosition"
}
}
}
RelatedLink
{
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
Relationship
{
"type": "object",
"example": {
"data": {
"id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
"type": "resource"
},
"links": {
"related": {
"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
}
}
},
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "4a72d1db-b465-4764-99e1-ecedad03b06a"
},
"type": {
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$",
"description": "Type of the related resource"
}
}
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
},
"links": {
"type": "object",
"example": {
"related": "https://example.com/api/other_resource"
},
"properties": {
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
}
}
}
Remedy
{
"type": "object",
"required": [
"type"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/RemedyMetadata"
},
"type": {
"enum": [
"indeterminate",
"manual",
"automated",
"rule_result_message",
"terraform",
"cloudformation",
"cli",
"kubernetes",
"arm"
],
"type": "string"
},
"description": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "A markdown-formatted optional description of this remedy. Links are not permitted."
},
"correlation_id": {
"type": "string",
"maxLength": 256,
"minLength": 1,
"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"
}
}
}
RemedyMetadata
{
"type": "object",
"required": [
"data",
"schema_version"
],
"properties": {
"data": {
"type": "object",
"description": "Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.",
"additionalProperties": true
},
"schema_version": {
"type": "string",
"maxLength": 256,
"minLength": 1,
"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"
}
}
}
Resolution
{
"type": "object",
"required": [
"type",
"resolved_at"
],
"properties": {
"type": {
"$ref": "#/components/schemas/ResolutionTypeDef"
},
"details": {
"type": "string",
"description": "Optional details about the resolution. Used by Snyk Cloud so far."
},
"resolved_at": {
"type": "string",
"format": "date-time",
"description": "The time when this issue was resolved."
}
},
"description": "An optional field recording when and via what means an issue was resolved, if it was resolved.\nResolved issues are retained for XX days.\n"
}
ResolutionTypeDef
{
"enum": [
"disappeared",
"fixed"
],
"type": "string"
}
Resource
{
"type": "object",
"required": [
"input_type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Internal ID for a resource."
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 256
}
},
"type": {
"enum": [
"cloud",
"iac"
],
"type": "string"
},
"location": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"platform": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"native_id": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "An optional native identifier for this resource. For example, a cloud resource id."
},
"input_type": {
"enum": [
"cloud_scan",
"arm",
"k8s",
"tf",
"tf_hcl",
"tf_plan",
"tf_state",
"cfn"
],
"type": "string"
},
"resource_type": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"iac_mappings_count": {
"type": "integer",
"format": "int64",
"minimum": 0,
"description": "Amount of IaC resources this resource maps to."
}
}
}
ResourcePath
{
"type": "string",
"example": ",5.4.0),[6.0.0.pr1,6.4.0)",
"maxLength": 2024,
"minLength": 1
}
ResourcePathRepresentation
{
"type": "object",
"required": [
"resource_path"
],
"properties": {
"resource_path": {
"$ref": "#/components/schemas/ResourcePath"
}
},
"description": "An object that contains an opaque identifying string."
}
Risk
{
"type": "object",
"example": {
"score": {
"model": "v4",
"value": 700
},
"factors": [
{
"name": "deployed",
"value": true,
"updated_at": "2023-09-07T13:36:37Z"
}
]
},
"required": [
"factors"
],
"properties": {
"score": {
"$ref": "#/components/schemas/RiskScore"
},
"factors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskFactor"
},
"description": "Risk factors identified for an issue"
}
},
"description": "Risk prioritization information for an issue"
}
RiskFactor
{
"oneOf": [
{
"$ref": "#/components/schemas/DeployedRiskFactor"
},
{
"$ref": "#/components/schemas/OSConditionRiskFactor"
},
{
"$ref": "#/components/schemas/PublicFacingRiskFactor"
}
],
"discriminator": {
"mapping": {
"deployed": "#/components/schemas/DeployedRiskFactor",
"os_condition": "#/components/schemas/OSConditionRiskFactor",
"public_facing": "#/components/schemas/PublicFacingRiskFactor"
},
"propertyName": "name"
}
}
RiskFactorLinks
{
"type": "object",
"properties": {
"evidence": {
"$ref": "#/components/schemas/LinkProperty"
}
}
}
RiskScore
{
"type": "object",
"example": {
"model": "v1",
"value": 700
},
"required": [
"value",
"model"
],
"properties": {
"model": {
"type": "string",
"description": "Risk scoring model used to calculate the score value"
},
"value": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "Risk score value, which may be used for overall prioritization"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Risk prioritization score based on an analysis model"
}
SastEnablement
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"sast_enabled"
],
"properties": {
"sast_enabled": {
"type": "boolean"
},
"autofix_enabled": {
"type": "boolean"
}
}
}
}
}
SastSettingsGetForOrgResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/SastEnablement"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
SastSettingsToggleSnykCodeSettingsRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"sast_enabled"
],
"properties": {
"sast_enabled": {
"type": "boolean",
"description": "The value of the updated settings for sastEnabled setting"
}
}
}
}
}
}
}
SastSettingsToggleSnykCodeSettingsResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/SastEnablement"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
SbomResource
{
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "b68b0b85-d039-4c05-abc0-04eb50ca0fe9"
},
"type": {
"$ref": "#/components/schemas/Types"
}
}
}
SbomResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/SbomResource"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ScanItemType
{
"enum": [
"project",
"environment"
],
"type": "string",
"example": "project"
}
Scopes
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "The scopes this app is allowed to request during authorization."
}
SelfLink
{
"type": "object",
"example": {
"self": "https://example.com/api/this_resource"
},
"properties": {
"self": {
"$ref": "#/components/schemas/LinkProperty"
}
}
}
ServiceAccount
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"last": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"next": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"prev": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"self": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"first": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
},
"attributes": {
"type": "object",
"required": [
"name",
"auth_type",
"role_id"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name of the service account."
},
"level": {
"enum": [
"Group",
"Org"
],
"type": "string",
"description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level."
},
"api_key": {
"type": "string",
"description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the role which the Service Account is associated with."
},
"jwks_url": {
"type": "string",
"description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
},
"auth_type": {
"enum": [
"api_key",
"oauth_client_secret",
"oauth_private_key_jwt"
],
"type": "string",
"description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
},
"client_id": {
"type": "string",
"description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
},
"client_secret": {
"type": "string",
"description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
},
"access_token_ttl_seconds": {
"type": "number",
"description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
}
}
}
}
}
ServiceAccountsCreateForOrganizationRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"type": {
"enum": [
"service_account"
],
"type": "string",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"required": [
"name",
"role_id",
"auth_type"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name for the service account."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the role which the created service account should use. Obtained in the Snyk UI, via \"Group Page\" -> \"Settings\" -> \"Member Roles\" -> \"Create new Role\". Can be shared among multiple accounts."
},
"jwks_url": {
"type": "string",
"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."
},
"auth_type": {
"enum": [
"api_key",
"oauth_client_secret",
"oauth_private_key_jwt"
],
"type": "string",
"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."
},
"access_token_ttl_seconds": {
"type": "number",
"maximum": 86400,
"minimum": 3600,
"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."
}
}
}
}
}
}
}
ServiceAccountsCreateForOrganizationResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"last": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"next": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"prev": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"self": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"first": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
},
"attributes": {
"type": "object",
"required": [
"name",
"auth_type",
"role_id"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name of the service account."
},
"level": {
"enum": [
"Group",
"Org"
],
"type": "string",
"description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level."
},
"api_key": {
"type": "string",
"description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the role which the Service Account is associated with."
},
"jwks_url": {
"type": "string",
"description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
},
"auth_type": {
"enum": [
"api_key",
"oauth_client_secret",
"oauth_private_key_jwt"
],
"type": "string",
"description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
},
"client_id": {
"type": "string",
"description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
},
"client_secret": {
"type": "string",
"description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
},
"access_token_ttl_seconds": {
"type": "number",
"description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ServiceAccountsCreateGroupRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"service_account"
],
"type": "string",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"required": [
"name",
"auth_type",
"role_id"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name for the service account."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the role which the created service account should use."
},
"jwks_url": {
"type": "string",
"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."
},
"auth_type": {
"enum": [
"api_key",
"oauth_client_secret",
"oauth_private_key_jwt"
],
"type": "string",
"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."
},
"access_token_ttl_seconds": {
"type": "number",
"maximum": 86400,
"minimum": 3600,
"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."
}
}
}
}
}
}
}
ServiceAccountsCreateGroupResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"last": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"next": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"prev": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"self": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"first": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
},
"attributes": {
"type": "object",
"required": [
"name",
"auth_type",
"role_id"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name of the service account."
},
"level": {
"enum": [
"Group",
"Org"
],
"type": "string",
"description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level."
},
"api_key": {
"type": "string",
"description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the role which the Service Account is associated with."
},
"jwks_url": {
"type": "string",
"description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
},
"auth_type": {
"enum": [
"api_key",
"oauth_client_secret",
"oauth_private_key_jwt"
],
"type": "string",
"description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
},
"client_id": {
"type": "string",
"description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
},
"client_secret": {
"type": "string",
"description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
},
"access_token_ttl_seconds": {
"type": "number",
"description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ServiceAccountsGetGroupServiceAccountResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"last": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"next": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"prev": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"self": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"first": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
},
"related": {
"oneOf": [
{
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
{
"type": "object",
"example": {
"href": "https://example.com/api/resource"
},
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "https://example.com/api/resource",
"description": "A string containing the link’s URL."
},
"meta": {
"type": "object",
"example": {
"key1": "value1",
"key2": {
"sub_key": "sub_value"
},
"key3": [
"array_value1",
"array_value2"
]
},
"description": "Free-form object that may contain non-standard information.",
"additionalProperties": true
}
}
}
],
"example": "https://example.com/api/resource"
}
}
},
"attributes": {
"type": "object",
"required": [
"name",
"auth_type",
"role_id"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name of the service account."
},
"level": {
"enum": [
"Group",
"Org"
],
"type": "string",
"description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level."
},
"api_key": {
"type": "string",
"description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
},
"role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the role which the Service Account is associated with."
},
"jwks_url": {
"type": "string",
"description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
},
"auth_type": {
"enum": [
"api_key",
"oauth_client_secret",
"oauth_private_key_jwt"
],
"type": "string",
"description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
},
"client_id": {
"type": "string",
"description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
},
"client_secret": {
"type": "string",
"description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
},
"access_token_ttl_seconds": {
"type": "number",
"description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}