Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.snyk.io/rest
/groups/{group_id}/apps/installs
Get a list of apps installed for a group.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| expand | query | optional | array | Expand relationships. |
| group_id | path | required | string | Group ID |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /groups/{group_id}/apps/installs
/groups/{group_id}/apps/installs
Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | Group ID |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AppsInstallGroupAppRequest"
}
}
},
"description": "App Install to be created"
}
POST /groups/{group_id}/apps/installs
/groups/{group_id}/apps/installs/{install_id}
Revoke app authorization for an Snyk Group with install ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | Group ID |
| optional |
DELETE /groups/{group_id}/apps/installs/{install_id}
/groups/{group_id}/apps/installs/{install_id}/secrets
Manage client secret for non-interactive Snyk App installations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | Group ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AppsCreateInstallSecretRequest"
}
}
}
}
POST /groups/{group_id}/apps/installs/{install_id}/secrets
/orgs/{org_id}/apps/creations
Get a list of apps created by an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | Org ID |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/apps/creations
/orgs/{org_id}/apps/creations
Create a new Snyk App for an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AppPostRequest"
}
}
},
"description": "Snyk App details for app to be created."
}
POST /orgs/{org_id}/apps/creations
/orgs/{org_id}/apps/creations/{app_id}
Delete an app by its App ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | Org ID |
| optional | ||||
| optional |
DELETE /orgs/{org_id}/apps/creations/{app_id}
/orgs/{org_id}/apps/creations/{app_id}
Get a Snyk App by its App ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | Org ID |
| optional | ||||
| optional |
GET /orgs/{org_id}/apps/creations/{app_id}
/orgs/{org_id}/apps/creations/{app_id}
Update app creation attributes with App ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AppPatchRequest"
}
}
}
}
PATCH /orgs/{org_id}/apps/creations/{app_id}
/orgs/{org_id}/apps/creations/{app_id}/secrets
Manage client secret for the Snyk App.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AppsManageClientSecretForSnykAppRequest"
}
}
}
}
POST /orgs/{org_id}/apps/creations/{app_id}/secrets
/orgs/{org_id}/apps/installs
Get a list of apps installed for an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| expand | query | optional | array | Expand relationships. |
| org_id | path | required | string | Org ID |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/apps/installs
/orgs/{org_id}/apps/installs
Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AppsInstallSnykAppToOrgRequest"
}
}
},
"description": "App Install to be created"
}
POST /orgs/{org_id}/apps/installs
/orgs/{org_id}/apps/installs/{install_id}
Revoke app authorization for an Snyk Organization with install ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
DELETE /orgs/{org_id}/apps/installs/{install_id}
/orgs/{org_id}/apps/installs/{install_id}/secrets
Manage client secret for non-interactive Snyk App installations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AppsManageClientSecretForSnykAppRequest1"
}
}
}
}
POST /orgs/{org_id}/apps/installs/{install_id}/secrets
/self/apps
Get a list of apps that can act on your behalf.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /self/apps
/self/apps/installs
Get a list of apps installed for an user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| expand | query | optional | array | Expand relationships. |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /self/apps/installs
/self/apps/installs/{install_id}
Revoke access for an app by install ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
DELETE /self/apps/installs/{install_id}
/self/apps/{app_id}
Revoke access for an app by app id
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
DELETE /self/apps/{app_id}
/self/apps/{app_id}/sessions
Get a list of active OAuth sessions for the app.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /self/apps/{app_id}/sessions
/self/apps/{app_id}/sessions/{session_id}
Revoke an active user app session.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| session_id | path | required | string | Session ID |
DELETE /self/apps/{app_id}/sessions/{session_id}
/groups/{group_id}/audit_logs/search
Search audit logs for a Group. Some Organization level events are supported as well as the following Group level events: - api.access - group.cloud_config.settings.edit - group.create - group.delete - group.edit - group.notification_settings.edit - group.org.add - group.org.remove - group.policy.create - group.policy.delete - group.policy.edit - group.request_access_settings.edit - group.role.create - group.role.delete - group.role.edit - group.service_account.create - group.service_account.delete - group.service_account.edit - group.settings.edit - group.settings.feature_flag.edit - group.sso.add - group.sso.auth0_connection.create - group.sso.auth0_connection.edit - group.sso.create - group.sso.delete - group.sso.edit - group.sso.membership.sync - group.sso.remove - group.tag.create - group.tag.delete - group.user.add - group.user.remove - group.user.role.edit
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | The ID of the Group. |
| cursor | query | optional | string | The ID for the next page of results. |
| from | query | optional | string | The start date (inclusive) of the audit logs search. If this is not specified, the start of yesterday is used. Example: 2023-07-27 |
| to | query | optional | string | The end date (inclusive) of the audit logs search. Example: 2023-07-27 |
| size | query | optional | integer | Number of results to return per page. |
| sort_order | query | optional | string | Order in which results are returned. |
| user_id | query | optional | string | Filter logs by user ID. |
| project_id | query | optional | string | Filter logs by project ID. |
| event | query | optional | string | Filter logs by event type, cannot be used in conjunction with exclude_event parameter. |
| exclude_event | query | optional | string | Exclude event type from results, cannot be used in conjunctions with event parameter. |
GET /groups/{group_id}/audit_logs/search
/orgs/{org_id}/audit_logs/search
Search audit logs for an Organization. Supported event types: - api.access - org.app_bot.create - org.app.create - org.app.delete - org.app.edit - org.cloud_config.settings.edit - org.collection.create - org.collection.delete - org.collection.edit - org.create - org.delete - org.edit - org.ignore_policy.edit - org.integration.create - org.integration.delete - org.integration.edit - org.integration.settings.edit - org.language_settings.edit - org.notification_settings.edit - org.org_source.create - org.org_source.delete - org.org_source.edit - org.policy.edit - org.project_filter.create - org.project_filter.delete - org.project.add - org.project.attributes.edit - org.project.delete - org.project.edit - org.project.fix_pr.auto_open - org.project.fix_pr.manual_open - org.project.ignore.create - org.project.ignore.delete - org.project.ignore.edit - org.project.monitor - org.project.pr_check.edit - org.project.remove - org.project.settings.delete - org.project.settings.edit - org.project.stop_monitor - org.project.tag.add - org.project.tag.remove - org.project.test - org.request_access_settings.edit - org.sast_settings.edit - org.service_account.create - org.service_account.delete - org.service_account.edit - org.settings.feature_flag.edit - org.target.create - org.target.delete - org.user.add - org.user.invite - org.user.invite.accept - org.user.invite.revoke - org.user.invite_link.accept - org.user.invite_link.create - org.user.invite_link.revoke - org.user.leave - org.user.provision.accept - org.user.provision.create - org.user.provision.delete - org.user.remove - org.user.role.create - org.user.role.delete - org.user.role.details.edit - org.user.role.edit - org.user.role.permissions.edit - org.webhook.add - org.webhook.delete - user.org.notification_settings.edit
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The ID of the organization. |
| cursor | query | optional | string | The ID for the next page of results. |
| from | query | optional | string | The start date (inclusive) of the audit logs search. If this is not specified, the start of yesterday is used. Example: 2023-07-27 |
| to | query | optional | string | The end date (inclusive) of the audit logs search. Example: 2023-07-27 |
| size | query | optional | integer | Number of results to return per page. |
| sort_order | query | optional | string | Order in which results are returned. |
| user_id | query | optional | string | Filter logs by user ID. |
| project_id | query | optional | string | Filter logs by project ID. |
| event | query | optional | string | Filter logs by event type, cannot be used in conjunction with exclude_event parameter. |
| exclude_event | query | optional | string | Exclude event type from results, cannot be used in conjunctions with event parameter. |
GET /orgs/{org_id}/audit_logs/search
/orgs/{org_id}/collections
Return a list of organization's collections with issues counts and projects count.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional | ||||
| optional | ||||
| optional | ||||
| sort | query | optional | string | Return collections sorted by the specified attributes |
| direction | query | optional | string | Return collections sorted in the specified direction |
| name | query | optional | string | Return collections which names include the provided string |
| is_generated | query | optional | boolean | Return collections where is_generated matches the provided boolean |
GET /orgs/{org_id}/collections
/orgs/{org_id}/collections
Create a collection
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CreateCollectionRequest"
}
}
}
}
POST /orgs/{org_id}/collections
/orgs/{org_id}/collections/{collection_id}
Delete a collection
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
DELETE /orgs/{org_id}/collections/{collection_id}
/orgs/{org_id}/collections/{collection_id}
Get a collection
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
GET /orgs/{org_id}/collections/{collection_id}
/orgs/{org_id}/collections/{collection_id}
Edit a collection
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionRequest"
}
}
}
}
PATCH /orgs/{org_id}/collections/{collection_id}
/orgs/{org_id}/collections/{collection_id}/relationships/projects
Remove projects from a collection by specifying an array of either project ids or target ids (for targets, the respective projects will be removed)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectsFromCollectionRequest"
}
}
}
}
DELETE /orgs/{org_id}/collections/{collection_id}/relationships/projects
/orgs/{org_id}/collections/{collection_id}/relationships/projects
Return a list of organization's projects that are from the specified collection.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| sort | query | optional | string | Return projects sorted by the specified attributes |
| direction | query | optional | string | Return projects sorted in the specified direction |
| target_id | query | optional | array | Return projects that belong to the provided targets |
| show | query | optional | array | Return projects that are with or without issues |
| integration | query | optional | array | Return projects that match the provided integration types |
GET /orgs/{org_id}/collections/{collection_id}/relationships/projects
/orgs/{org_id}/collections/{collection_id}/relationships/projects
Add projects to a collection by specifying an array of either project ids or target ids (for targets, the respective projects will be added, but they won't be updated when the target changes)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionWithProjectsRequest"
}
}
}
}
POST /orgs/{org_id}/collections/{collection_id}/relationships/projects
/orgs/{org_id}/container_images
List instances of container image
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | Org ID |
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/container_images
/orgs/{org_id}/container_images/{image_id}
Get instance of container image
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
GET /orgs/{org_id}/container_images/{image_id}
/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs
List instances of image target references for a container image
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | Org ID |
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs
/custom_base_images
Get a list of custom base images with support for ordering and filtering. Either the org_id or group_id parameters must be set to authorize successfully. If sorting by version, the repository filter is required.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| project_id | query | optional | string | The ID of the container project that the custom base image is based off of. |
| org_id | query | optional | string | The organization ID of the custom base image |
| group_id | query | optional | string | The group ID of the custom base image |
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /custom_base_images
/custom_base_images
In order to create a custom base image, you first need to import your base images into Snyk. You can do this through the CLI, UI, or API. This endpoint marks an image as a custom base image. This means that the image will get added to the pool of images from which Snyk can recommend base image upgrades. Note, after the first image in a repository gets added, a versioning schema cannot be passed in this endpoint. To update the versioning schema, the PATCH endpoint must be used.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CustomBaseImagePostRequest"
}
}
},
"description": "The properties used in the creation of a custom base image"
}
POST /custom_base_images
/custom_base_images/{custombaseimage_id}
Delete a custom base image resource. (the related container project is unaffected)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
DELETE /custom_base_images/{custombaseimage_id}
/custom_base_images/{custombaseimage_id}
Get a custom base image
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
GET /custom_base_images/{custombaseimage_id}
/custom_base_images/{custombaseimage_id}
Updates a custom base image's attributes
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CustomBaseImagePatchRequest"
}
}
},
"description": "custom base image to be updated"
}
PATCH /custom_base_images/{custombaseimage_id}
/groups/{group_id}/settings/iac
Get the Infrastructure as Code Settings for a group.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | The id of the group whose Infrastructure as Code settings are requested |
GET /groups/{group_id}/settings/iac
/groups/{group_id}/settings/iac
Update the Infrastructure as Code Settings for a group.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| group_id | path | required | string | The id of the group whose Infrastructure as Code settings are getting updated |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/IacSettingsUpdateForGroupRequest"
}
}
}
}
PATCH /groups/{group_id}/settings/iac
/orgs/{org_id}/settings/iac
Get the Infrastructure as Code Settings for an org.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The id of the org whose Infrastructure as Code settings are requested. |
GET /orgs/{org_id}/settings/iac
/orgs/{org_id}/settings/iac
Update the Infrastructure as Code Settings for an org.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The id of the org whose Infrastructure as Code settings are getting updated |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/IacSettingsUpdateForOrgRequest"
}
}
}
}
PATCH /orgs/{org_id}/settings/iac
/orgs/{org_id}/invites
List pending user invitations to an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The id of the org the user is being invited to |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/invites
/orgs/{org_id}/invites
Invite a user to an organization with a role.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The id of the org the user is being invited to |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/InvitesUserToOrganizationRequest"
}
}
}
}
POST /orgs/{org_id}/invites
/orgs/{org_id}/invites/{invite_id}
Cancel a pending user invitations to an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The id of the org the user is being invited to |
| invite_id | path | required | string | The id of the pending invite to cancel |
| optional |
DELETE /orgs/{org_id}/invites/{invite_id}
/groups/{group_id}/issues
Get a list of a group's issues.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /groups/{group_id}/issues
/groups/{group_id}/issues/{issue_id}
Get an issue
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional |
GET /groups/{group_id}/issues/{issue_id}
/orgs/{org_id}/issues
Get a list of an organization's issues.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| org_id | path | required | string | Org ID |
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/issues
/orgs/{org_id}/issues/{issue_id}
Get an issue
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
GET /orgs/{org_id}/issues/{issue_id}
/orgs/{org_id}/packages/issues
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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Unique identifier for an organization |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/BulkPackageUrlsRequestBody"
}
}
},
"required": true
}
POST /orgs/{org_id}/packages/issues
/orgs/{org_id}/packages/{purl}/issues
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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| org_id | path | required | string | Unique identifier for an organization |
| offset | query | optional | number | Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0. |
| limit | query | optional | number | Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000. |
GET /orgs/{org_id}/packages/{purl}/issues
/openapi
List available versions of OpenAPI specification
GET /openapi
/openapi/{version}
Get OpenAPI specification effective at version.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| version | path | required | string | The requested version of the API |
GET /openapi/{version}
/groups/{group_id}/orgs
Get a paginated list of all the organizations belonging to the group. By default, this endpoint returns the organizations in alphabetical order of their name.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /groups/{group_id}/orgs
/orgs
Get a paginated list of organizations you have access to.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| group_id | query | optional | string | If set, only return organizations within the specified group |
| is_personal | query | optional | boolean | If true, only return organizations that are not part of a group. |
| slug | query | optional | string | Only return orgs whose slug exactly matches this value. |
| name | query | optional | string | Only return orgs whose name contains this value. |
| expand | query | optional | array | Expand the specified related resources in the response to include their attributes. |
GET /orgs
/orgs/{org_id}
Get the full details of an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Unique identifier for org |
GET /orgs/{org_id}
/orgs/{org_id}
Update the details of an organization
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Unique identifier for org |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/OrgsUpdateDetailsRequest"
}
}
}
}
PATCH /orgs/{org_id}
/orgs/{org_id}/projects
List all Projects for an Org.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the org that the projects belong to. |
| target_id | query | optional | array | Return projects that belong to the provided targets |
| target_reference | query | optional | string | Return projects that match the provided target reference |
| target_file | query | optional | string | Return projects that match the provided target file |
| target_runtime | query | optional | string | Return projects that match the provided target runtime |
| meta_count | query | optional | string | The collection count. |
| ids | query | optional | array | Return projects that match the provided IDs. |
| names | query | optional | array | Return projects that match the provided names. |
| names_start_with | query | optional | array | Return projects with names starting with the specified prefix. |
| origins | query | optional | array | Return projects that match the provided origins. |
| types | query | optional | array | Return projects that match the provided types. |
| expand | query | optional | array | Expand relationships. |
| meta.latest_issue_counts | query | optional | boolean | Include a summary count for the issues found in the most recent scan of this project |
| meta.latest_dependency_total | query | optional | boolean | Include the total number of dependencies found in the most recent scan of this project |
| cli_monitored_before | query | optional | string | Filter projects uploaded and monitored before this date (encoded value) |
| cli_monitored_after | query | optional | string | Filter projects uploaded and monitored after this date (encoded value) |
| importing_user_public_id | query | optional | array | Return projects that match the provided importing user public ids. |
| tags | query | optional | array | Return projects that match all the provided tags |
| business_criticality | query | optional | array | Return projects that match all the provided business_criticality value |
| environment | query | optional | array | Return projects that match all the provided environment values |
| lifecycle | query | optional | array | Return projects that match all the provided lifecycle values |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/projects
/orgs/{org_id}/projects/{project_id}
Delete one project in the organization by project ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the org to which the project belongs to. |
| project_id | path | required | string | The ID of the project. |
| optional |
DELETE /orgs/{org_id}/projects/{project_id}
/orgs/{org_id}/projects/{project_id}
Get one project of the organization by project ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the org to which the project belongs to. |
| project_id | path | required | string | The ID of the project. |
| expand | query | optional | array | Expand relationships. |
| meta.latest_issue_counts | query | optional | boolean | Include a summary count for the issues found in the most recent scan of this project |
| meta.latest_dependency_total | query | optional | boolean | Include the total number of dependencies found in the most recent scan of this project |
| optional |
GET /orgs/{org_id}/projects/{project_id}
/orgs/{org_id}/projects/{project_id}
Updates one project of the organization by project ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The ID of the Org the project belongs to. |
| project_id | path | required | string | The ID of the project to patch. |
| expand | query | optional | array | Expand relationships. |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchProjectRequest"
}
}
},
"description": "The project attributes to be updated."
}
PATCH /orgs/{org_id}/projects/{project_id}
/orgs/{org_id}/projects/{project_id}/sbom
This endpoint lets you retrieve the SBOM document of a software project. It supports the following formats: * CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`). * CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`). * SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`). By default it will respond with an empty JSON:API response.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Unique identifier for an organization |
| optional | ||||
| optional |
GET /orgs/{org_id}/projects/{project_id}/sbom
/orgs/{org_id}/settings/sast
Retrieves the SAST settings for an org
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The id of the org for which we want to retrieve the SAST settings |
GET /orgs/{org_id}/settings/sast
/orgs/{org_id}/settings/sast
Enable/Disable the Snyk Code settings for an org
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The id of the org for which we want to update the Snyk Code setting |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SastSettingsToggleSnykCodeSettingsRequest"
}
}
},
"required": true
}
PATCH /orgs/{org_id}/settings/sast
/groups/{group_id}/service_accounts
Get all service accounts for a group.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that owns the service accounts. |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /groups/{group_id}/service_accounts
/groups/{group_id}/service_accounts
Create a service account for a group. The service account can be used to generate access tokens. Currently, we only allow group service accounts using default group roles.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that is creating and owns the service account |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountsCreateGroupRequest"
}
}
},
"required": true
}
POST /groups/{group_id}/service_accounts
/groups/{group_id}/service_accounts/{serviceaccount_id}
Permanently delete a group-level service account by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
DELETE /groups/{group_id}/service_accounts/{serviceaccount_id}
/groups/{group_id}/service_accounts/{serviceaccount_id}
Get a group-level service account by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
GET /groups/{group_id}/service_accounts/{serviceaccount_id}
/groups/{group_id}/service_accounts/{serviceaccount_id}
Update the name of a group's service account by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountsUpdateGroupNameByIdRequest"
}
}
},
"required": true
}
PATCH /groups/{group_id}/service_accounts/{serviceaccount_id}
/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets
Manage the client secret of a group service account by the service account ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_id | path | required | string | The ID of the Snyk Group that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountsManageClientSecretRequest"
}
}
},
"required": true
}
POST /groups/{group_id}/service_accounts/{serviceaccount_id}/secrets
/orgs/{org_id}/service_accounts
Get all service accounts for an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the Snyk Organization that owns the service accounts. |
| optional | ||||
| optional | ||||
| optional | ||||
| optional |
GET /orgs/{org_id}/service_accounts
/orgs/{org_id}/service_accounts
Create a service account for an organization. The service account can be used to generate access tokens.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the Snyk Organization that is creating and will own the service account. |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountsCreateForOrganizationRequest"
}
}
},
"required": true
}
POST /orgs/{org_id}/service_accounts
/orgs/{org_id}/service_accounts/{serviceaccount_id}
Delete a service account in an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of org to which the service account belongs. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
DELETE /orgs/{org_id}/service_accounts/{serviceaccount_id}
/orgs/{org_id}/service_accounts/{serviceaccount_id}
Get an organization-level service account by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the Snyk Organization that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
GET /orgs/{org_id}/service_accounts/{serviceaccount_id}
/orgs/{org_id}/service_accounts/{serviceaccount_id}
Update the name of an organization-level service account by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the Snyk Organization that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountsUpdateOrganizationServiceAccountNameRequest"
}
}
},
"required": true
}
PATCH /orgs/{org_id}/service_accounts/{serviceaccount_id}
/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets
Manage the client secret of an organization-level service account by the service account ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | required | string | The ID of the Snyk Organization that owns the service account. |
| serviceaccount_id | path | required | string | The ID of the service account. |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ServiceAccountsManageClientSecretForOrganizationServiceAccountRequest"
}
}
},
"required": true
}
POST /orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets
/orgs/{org_id}/slack_app/{tenant_id}/channels
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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
GET /orgs/{org_id}/slack_app/{tenant_id}/channels
/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}
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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional | ||||
| optional |
GET /orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}
/orgs/{org_id}/slack_app/{bot_id}
Remove the given Slack App integration
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
DELETE /orgs/{org_id}/slack_app/{bot_id}
/orgs/{org_id}/slack_app/{bot_id}
Get Slack integration default notification settings for the provided tenant ID and bot ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
GET /orgs/{org_id}/slack_app/{bot_id}
/orgs/{org_id}/slack_app/{bot_id}
Create new Slack notification default settings for a given tenant.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SettingsRequest"
}
}
},
"description": "Create new Slack notification default settings for a tenant."
}
POST /orgs/{org_id}/slack_app/{bot_id}
/orgs/{org_id}/slack_app/{bot_id}/projects
Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| org_id | path | required | string | Org ID |
| optional |
GET /orgs/{org_id}/slack_app/{bot_id}/projects
/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
Remove Slack settings override for a project.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| project_id | path | required | string | Project ID |
| optional |
DELETE /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
Update Slack notification settings for a project.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| optional | ||||
| project_id | path | required | string | Project ID |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ProjectSettingsPatchRequest"
}
}
},
"description": "Update existing project specific settings for a project."
}
PATCH /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
Create Slack settings override for a project.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | Org ID |
| project_id | path | required | string | Project ID |
| optional |
{
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SettingsRequest"
}
}
},
"description": "Create new Slack notification default settings for a tenant."
}
POST /orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}
/orgs/{org_id}/targets
Get a list of an organization's targets.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| count | query | optional | boolean | Calculate total amount of filtered results |
| limit | query | optional | integer | Number of results to return per page |
| org_id | path | required | string | The id of the org to return a list of targets |
| is_private | query | optional | boolean | Return targets that match the provided value of is_private |
| exclude_empty | query | optional | boolean | Return only the targets that has projects |
| url | query | optional | string | Return targets that match the provided remote_url. |
| source_types | query | optional | array | Return targets that match the provided source_types |
| display_name | query | optional | string | Return targets with display names starting with the provided string |
| created_gte | query | optional | string | Return only targets which have been created at or after the specified date. |
GET /orgs/{org_id}/targets
/orgs/{org_id}/targets/{target_id}
Delete the specified target.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The id of the org to delete |
| target_id | path | required | string | The id of the target to delete |
DELETE /orgs/{org_id}/targets/{target_id}
/orgs/{org_id}/targets/{target_id}
Get a specified target for an organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| org_id | path | required | string | The id of the org to return the target from |
| target_id | path | required | string | The id of the target to return |
GET /orgs/{org_id}/targets/{target_id}
AccessTokenTtlSeconds
{
"type": "number",
"example": 3600,
"maximum": 86400,
"minimum": 3600,
"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."
}
ActualVersion
{
"type": "string",
"pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$",
"description": "Resolved API version"
}
AppBot
{
"type": "object",
"required": [
"type",
"id",
"relationships"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object"
},
"relationships": {
"type": "object",
"required": [
"app"
],
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PublicApp"
}
}
}
}
}
}
}
AppData
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"attributes": {
"$ref": "#/components/schemas/AppResourceAttributes"
}
}
}
AppDataWithSecret
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"attributes": {
"$ref": "#/components/schemas/AppResourceAttributesWithSecret"
}
}
}
AppInstallData
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object",
"properties": {
"client_id": {
"$ref": "#/components/schemas/ClientId"
}
}
},
"relationships": {
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PublicAppData"
}
}
}
}
}
}
}
AppInstallDataWithSecret
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object",
"required": [
"client_id",
"client_secret"
],
"properties": {
"client_id": {
"$ref": "#/components/schemas/ClientId"
},
"client_secret": {
"$ref": "#/components/schemas/ClientSecret"
}
}
},
"relationships": {
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PublicAppData"
}
}
}
}
}
}
}
AppInstallWithClient
{
"type": "object",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"attributes": {
"type": "object",
"required": [
"client_id",
"client_secret"
],
"properties": {
"client_id": {
"type": "string",
"format": "uuid"
},
"client_secret": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"$ref": "#/components/schemas/Type"
}
}
}
}
}
}
}
}
}
AppName
{
"type": "string",
"example": "My App",
"minLength": 1,
"description": "New name of the app to display to users during authorization flow."
}
AppPatchRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
},
"minProperties": 1
}
}
}
}
}
AppPostRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"name",
"redirect_uris",
"scopes",
"context"
],
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"scopes": {
"$ref": "#/components/schemas/Scopes"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
}
}
}
}
}
}
AppPostResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppDataWithSecret"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppResourceAttributes
{
"type": "object",
"required": [
"name",
"scopes",
"access_token_ttl_seconds",
"is_public",
"is_confidential",
"context",
"grant_type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"scopes": {
"$ref": "#/components/schemas/Scopes"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"client_id": {
"$ref": "#/components/schemas/ClientId"
},
"is_public": {
"$ref": "#/components/schemas/IsPublic"
},
"grant_type": {
"$ref": "#/components/schemas/GrantType"
},
"org_public_id": {
"$ref": "#/components/schemas/Uuid"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"is_confidential": {
"$ref": "#/components/schemas/IsConfidential"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
}
}
AppResourceAttributesWithSecret
{
"type": "object",
"required": [
"client_id",
"name",
"redirect_uris",
"scopes",
"access_token_ttl_seconds",
"is_public",
"is_confidential",
"client_secret",
"context",
"grant_type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/AppName"
},
"scopes": {
"$ref": "#/components/schemas/Scopes"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"client_id": {
"$ref": "#/components/schemas/ClientId"
},
"is_public": {
"$ref": "#/components/schemas/IsPublic"
},
"grant_type": {
"$ref": "#/components/schemas/GrantType"
},
"client_secret": {
"$ref": "#/components/schemas/ClientSecret"
},
"org_public_id": {
"$ref": "#/components/schemas/Uuid"
},
"redirect_uris": {
"$ref": "#/components/schemas/RedirectUris"
},
"is_confidential": {
"$ref": "#/components/schemas/IsConfidential"
},
"access_token_ttl_seconds": {
"$ref": "#/components/schemas/AccessTokenTtlSeconds"
}
}
}
AppsByInstallId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsByInstallIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecret500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateInstallSecretRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"replace",
"create",
"delete"
],
"type": "string",
"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"
},
"secret": {
"type": "string",
"description": "Secret to delete when using `delete` mode"
}
}
}
}
}
}
}
AppsCreateInstallSecretResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppInstallDataWithSecret"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsCreateNewAppForOrganization401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganization500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateNewAppForOrganizationResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationApp500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsCreateOrganizationAppResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppById500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteAppByIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsDeleteByAppIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetActiveSessions400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetActiveSessions401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetActiveSessions403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetActiveSessions404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetActiveSessions409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetActiveSessions500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetActiveSessionsResponse
{
"type": "object",
"required": [
"data",
"jsonapi"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionData"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsGetByAppId400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByAppId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByAppId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByAppId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByAppId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByAppId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByAppIdResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsGetByClientId400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByClientId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByClientId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByClientId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByClientId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByClientId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsGetByClientIdResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsInstallGroupApp400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallGroupApp401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallGroupApp403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallGroupApp404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallGroupApp409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallGroupApp500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallGroupAppRequest
{
"type": "object",
"required": [
"data",
"relationships"
],
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"app_install"
],
"type": "string",
"example": "app_install"
}
}
},
"relationships": {
"type": "object",
"required": [
"app"
],
"properties": {
"app": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"enum": [
"app"
],
"type": "string",
"example": "app"
}
}
}
}
}
}
}
}
}
AppsInstallGroupAppResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AppInstallWithClient"
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsInstallSnykAppToOrg400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallSnykAppToOrg401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallSnykAppToOrg403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallSnykAppToOrg404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallSnykAppToOrg409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallSnykAppToOrg500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsInstallSnykAppToOrgRequest
{
"type": "object",
"required": [
"data",
"relationships"
],
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"app_install"
],
"type": "string",
"example": "app_install"
}
}
},
"relationships": {
"type": "object",
"required": [
"app"
],
"properties": {
"app": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"type": {
"enum": [
"app"
],
"type": "string",
"example": "app"
}
}
}
}
}
}
}
}
}
AppsInstallSnykAppToOrgResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AppInstallWithClient"
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsListAppBots400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListAppBots401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListAppBots403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListAppBots404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListAppBots409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListAppBots500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListAppBotsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppBot"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsListApps400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListApps401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListApps403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListApps404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListApps409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListApps500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListAppsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicApp"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsListGroupAppInstalls400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListGroupAppInstalls401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListGroupAppInstalls403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListGroupAppInstalls404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListGroupAppInstalls409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListGroupAppInstalls500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListGroupAppInstallsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppInstallData"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsListOrgApps400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgApps401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgApps403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgApps404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgApps409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgApps500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgAppsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppData"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsListOrgCreations400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgCreations401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgCreations403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgCreations404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgCreations409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgCreations500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgCreationsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppData"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsListOrgInstalls400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgInstalls401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgInstalls403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgInstalls404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgInstalls409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgInstalls500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListOrgInstallsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppInstallData"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsListUserInstalledApps400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListUserInstalledApps401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListUserInstalledApps403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListUserInstalledApps404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListUserInstalledApps409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListUserInstalledApps500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsListUserInstalledAppsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppInstallData"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsManageClientSecretForSnykApp200Response
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppInstallDataWithSecret"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsManageClientSecretForSnykApp400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecretForSnykApp401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecretForSnykApp403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecretForSnykApp404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecretForSnykApp409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecretForSnykApp500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecretForSnykAppRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"replace",
"create",
"delete"
],
"type": "string",
"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"
},
"secret": {
"type": "string",
"description": "Secret to delete when using `delete` mode"
}
}
}
}
}
}
}
AppsManageClientSecretForSnykAppRequest1
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"app"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"replace",
"create",
"delete"
],
"type": "string",
"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"
},
"secret": {
"type": "string",
"description": "Secret to delete when using `delete` mode"
}
}
}
}
}
}
}
AppsManageClientSecretForSnykAppResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppDataWithSecret"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsManageClientSecrets400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecrets401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecrets403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecrets404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecrets409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecrets500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsManageClientSecretsRequest
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"replace",
"create",
"delete"
],
"type": "string",
"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"
},
"secret": {
"type": "string",
"description": "Secret to delete when using `delete` mode"
}
}
}
AppsManageClientSecretsResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppDataWithSecret"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsRevokeAppById401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeAppById403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeAppById404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeAppById409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeAppById500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeAppByIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeBotAuthorization401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeBotAuthorization403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeBotAuthorization404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeBotAuthorization409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeBotAuthorization500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeBotAuthorizationResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeByInstallId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeByInstallId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeByInstallId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeByInstallId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeByInstallId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeByInstallIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeGroupAppInstall401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeGroupAppInstall403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeGroupAppInstall404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeGroupAppInstall409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeGroupAppInstall500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeGroupAppInstallResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeUserAppSession401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeUserAppSession403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeUserAppSession404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeUserAppSession409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeUserAppSession500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsRevokeUserAppSessionResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateAttributes400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateAttributes401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateAttributes403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateAttributes404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateAttributes409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateAttributes500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateAttributesResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AppsUpdateCreationAttributesById400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateCreationAttributesById401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateCreationAttributesById403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateCreationAttributesById404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateCreationAttributesById409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateCreationAttributesById500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
AppsUpdateCreationAttributesByIdResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AuditLogSearch
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"created",
"event"
],
"properties": {
"event": {
"type": "string",
"example": "api.access"
},
"org_id": {
"type": "string",
"format": "uuid",
"example": "0d3728ec-eebf-484d-9907-ba238019f10b"
},
"content": {
"type": "object"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2021-07-01T00:00:00Z"
},
"group_id": {
"type": "string",
"format": "uuid",
"example": "0d3728ec-eebf-484d-9907-ba238019f10b"
},
"project_id": {
"type": "string",
"format": "uuid",
"example": "0d3728ec-eebf-484d-9907-ba238019f10b"
}
}
}
}
}
}
AuditLogsSearchGroupAuditLogsResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AuditLogSearch"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AuditLogsSearchOrganizationAuditLogsResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AuditLogSearch"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
AutoDependencyUpgradeSettings
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"example": 10,
"maximum": 10,
"minimum": 1,
"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."
},
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Automatically raise pull requests to update out-of-date dependencies."
},
"minimum_age": {
"type": "number",
"example": 365,
"description": "Minimum dependency maturity period in days. If specified, must be between 1 and 365."
},
"is_inherited": {
"type": "boolean",
"example": true,
"description": "Apply the auto dependency integration settings of the Organization to this project."
},
"ignored_dependencies": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"typescript"
],
"description": "Dependencies which should NOT be included in an automatic upgrade operation."
},
"is_major_upgrade_enabled": {
"type": "boolean",
"example": true,
"description": "Include major version in dependency upgrade recommendation."
}
},
"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."
}
AutoRemediationPRsSettings
{
"type": "object",
"properties": {
"is_fresh_prs_enabled": {
"type": "boolean",
"example": true,
"description": "Automatically create pull requests on scheduled tests for new vulnerabilities."
},
"is_backlog_prs_enabled": {
"type": "boolean",
"example": true,
"description": "Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities."
},
"is_patch_remediation_enabled": {
"type": "boolean",
"example": true,
"description": "Include vulnerability patches in automatic pull requests."
}
},
"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."
}
BulkPackageUrlsRequestBody
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"type": "object",
"required": [
"purls"
],
"properties": {
"purls": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of Package URLs (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required."
}
}
}
}
}
}
}
Class
{
"type": "object",
"example": {
"id": "CWE-190",
"type": "weakness",
"source": "CWE"
},
"required": [
"id",
"type",
"source"
],
"properties": {
"id": {
"type": "string",
"maxLength": 1024,
"minLength": 1
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096,
"minLength": 1,
"description": "An optional URL for this class."
},
"type": {
"$ref": "#/components/schemas/ClassTypeDef"
},
"source": {
"type": "string",
"example": "CWE",
"maxLength": 64,
"minLength": 1
}
}
}
ClassTypeDef
{
"enum": [
"rule-category",
"compliance",
"weakness"
],
"type": "string",
"example": "compliance"
}
ClientId
{
"type": "string",
"format": "uuid",
"example": "941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf",
"description": "The oauth2 client id for the app."
}
ClientSecret
{
"type": "string",
"example": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1",
"minLength": 1,
"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."
}
CloudResource
{
"type": "object",
"required": [
"environment"
],
"properties": {
"resource": {
"$ref": "#/components/schemas/Resource"
},
"environment": {
"$ref": "#/components/schemas/Environment"
}
}
}
CollectionAttributes
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/components/schemas/name"
},
"is_generated": {
"type": "boolean"
}
}
}
CollectionCreateNewResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
},
"description": "collection resource object"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionEditCollectionResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
},
"description": "collection resource object"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionGetByIdResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
},
"description": "collection resource object"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionGetListResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionResponse"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CollectionMeta
{
"type": "object",
"required": [
"projects_count",
"issues_critical_count",
"issues_high_count",
"issues_medium_count",
"issues_low_count"
],
"properties": {
"projects_count": {
"type": "number",
"example": 7,
"description": "The amount of projects belonging to this collection"
},
"issues_low_count": {
"type": "number",
"example": 10,
"description": "The sum of low severity issues of the collection's projects"
},
"issues_high_count": {
"type": "number",
"example": 10,
"description": "The sum of high severity issues of the collection's projects"
},
"issues_medium_count": {
"type": "number",
"example": 10,
"description": "The sum of medium severity issues of the collection's projects"
},
"issues_critical_count": {
"type": "number",
"example": 10,
"description": "The sum of critical severity issues of the collection's projects"
}
}
}
CollectionRelationships
{
"type": "object",
"required": [
"org",
"created_by_user"
],
"properties": {
"org": {
"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 org that this collection belongs to"
},
"type": {
"enum": [
"org"
],
"type": "string"
}
}
}
}
},
"created_by_user": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "331ede0a-de94-456f-b788-166caeca58bf",
"nullable": true,
"description": "ID of the user that created the collection. Null for auto-collections."
},
"type": {
"enum": [
"user"
],
"type": "string"
}
}
}
}
}
}
}
CollectionResponse
{
"type": "object",
"required": [
"id",
"type",
"meta",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"meta": {
"$ref": "#/components/schemas/CollectionMeta"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/CollectionAttributes"
},
"relationships": {
"$ref": "#/components/schemas/CollectionRelationships"
}
}
}
CommonIssueModel
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754",
"description": "The Snyk ID of the vulnerability."
},
"type": {
"type": "string",
"example": "issue",
"description": "The type of the REST resource. Always ‘issue’."
},
"attributes": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754",
"description": "The Snyk vulnerability ID."
},
"type": {
"type": "string",
"example": "package_vulnerability",
"description": "The issue type"
},
"slots": {
"$ref": "#/components/schemas/Slots"
},
"title": {
"type": "string",
"example": "XML External Entity (XXE) Injection",
"description": "A human-readable title for this issue."
},
"problems": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"source"
],
"properties": {
"id": {
"type": "string",
"example": "CWE-61",
"maxLength": 1024,
"minLength": 1
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096,
"minLength": 1,
"description": "An optional URL for this problem."
},
"source": {
"type": "string",
"example": "CVE",
"maxLength": 64,
"minLength": 1
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was last updated."
},
"disclosed_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was disclosed to the public."
},
"discovered_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was first discovered."
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T13:51:13Z"
},
"severities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Severity"
},
"description": "The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’."
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T14:00:24.315507Z",
"description": "When the vulnerability information was last modified."
},
"coordinates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"remedies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "indeterminate",
"description": "The type of the remedy. Always ‘indeterminate’."
},
"details": {
"type": "object",
"properties": {
"upgrade_package": {
"type": "string",
"example": "5.4.0,6.4.0",
"description": "A minimum version to upgrade to in order to remedy the issue."
}
}
},
"description": {
"type": "string",
"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."
}
}
}
},
"representation": {
"type": "array",
"items": {
"type": "string",
"example": "5.3.0"
},
"description": "The affected versions of this vulnerability."
}
}
}
},
"description": {
"type": "string",
"example": "## Overview\\n\\n\\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.",
"description": "A description of the issue in Markdown format"
},
"effective_severity_level": {
"enum": [
"info",
"low",
"medium",
"high",
"critical"
],
"type": "string",
"description": "The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies."
}
}
}
}
}
CommonIssueModelVTwo
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754",
"description": "The Snyk ID of the vulnerability."
},
"type": {
"type": "string",
"example": "issue",
"description": "The type of the REST resource. Always ‘issue’."
},
"attributes": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "package_vulnerability",
"description": "The issue type"
},
"slots": {
"$ref": "#/components/schemas/Slots"
},
"title": {
"type": "string",
"example": "XML External Entity (XXE) Injection",
"description": "A human-readable title for this issue."
},
"problems": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"source"
],
"properties": {
"id": {
"type": "string",
"example": "CWE-61",
"maxLength": 1024,
"minLength": 1
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096,
"minLength": 1,
"description": "An optional URL for this problem."
},
"source": {
"type": "string",
"example": "CVE",
"maxLength": 64,
"minLength": 1
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was last updated."
},
"disclosed_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was disclosed to the public."
},
"discovered_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was first discovered."
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T13:51:13Z"
},
"severities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Severity"
},
"description": "The severity level of the vulnerability: ‘low’, ‘medium’, ‘high’ or ‘critical’."
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T14:00:24.315507Z",
"description": "When the vulnerability information was last modified."
},
"coordinates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoordinateVTwo"
}
},
"description": {
"type": "string",
"example": "## Overview\\n\\n\\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.",
"description": "A description of the issue in Markdown format"
},
"effective_severity_level": {
"enum": [
"info",
"low",
"medium",
"high",
"critical"
],
"type": "string",
"description": "The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies."
}
}
}
}
}
ContainerBuildArgs
{
"type": "object",
"required": [
"platform"
],
"properties": {
"platform": {
"type": "string"
}
}
}
ContainerImageGetInstanceResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Image"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ContainerImageListImageTargetRefsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageTargetRef"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ContainerImageListInstancesOfContainerImageResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
Context
{
"enum": [
"tenant",
"user"
],
"type": "string",
"description": "Allow installing the app to a org/group or to a user, default tenant."
}
Coordinate
{
"type": "object",
"properties": {
"remedies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Remedy"
},
"maxItems": 5,
"minItems": 1
},
"is_pinnable": {
"type": "boolean"
},
"is_patchable": {
"type": "boolean"
},
"reachability": {
"type": "string"
},
"is_upgradeable": {
"type": "boolean"
},
"is_fixable_snyk": {
"type": "boolean"
},
"representations": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"resourcePath"
],
"properties": {
"resourcePath": {
"type": "string",
"maxLength": 2024,
"minLength": 1
}
},
"description": "An object that contains an opaque identifying string."
},
{
"type": "object",
"required": [
"dependency"
],
"properties": {
"dependency": {
"$ref": "#/components/schemas/Dependency"
}
},
"description": "An object that contains a list of opaque identifying strings."
},
{
"type": "object",
"required": [
"cloud_resource"
],
"properties": {
"cloud_resource": {
"$ref": "#/components/schemas/CloudResource"
}
},
"description": "A resource location to some service, like a cloud resource."
},
{
"type": "object",
"required": [
"sourceLocation"
],
"properties": {
"sourceLocation": {
"$ref": "#/components/schemas/SourceLocation"
}
},
"description": "A location within a file."
}
]
},
"maxItems": 5,
"minItems": 1,
"description": "A list of precise locations that surface an issue. A coordinate may have multiple representations.\n"
},
"is_fixable_manually": {
"type": "boolean"
},
"is_fixable_upstream": {
"type": "boolean"
}
}
}
CoordinateVTwo
{
"type": "object",
"required": [
"representations"
],
"properties": {
"remedies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "indeterminate",
"description": "The type of the remedy. Always ‘indeterminate’."
},
"details": {
"type": "object",
"properties": {
"upgrade_package": {
"type": "string",
"example": "5.4.0,6.4.0",
"description": "A minimum version to upgrade to in order to remedy the issue."
}
}
},
"description": {
"type": "string",
"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."
}
}
}
},
"representations": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourcePathRepresentation"
},
{
"$ref": "#/components/schemas/PackageRepresentation"
}
]
},
"description": "The affected versions of this vulnerability."
}
}
}
CreateCollectionRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/components/schemas/name"
}
}
}
}
}
}
}
CustomBaseImageAttributes
{
"type": "object",
"required": [
"project_id",
"include_in_recommendations"
],
"properties": {
"project_id": {
"type": "string",
"format": "uuid",
"example": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
"description": "The ID of the container project that the custom base image is based off of.\nThe attributes of this custom base image are taken from the latest snapshot at the time of creation.\nThis means that no changes should be made to the original project after the creation of the custom base image,\nas new snapshots created from any changes will NOT be picked up.\n"
},
"versioning_schema": {
"$ref": "#/components/schemas/VersioningSchema"
},
"include_in_recommendations": {
"type": "boolean",
"example": true,
"description": "Whether this image should be recommended as a base image upgrade. \nIf set to true, this image could be shown as a base image upgrade to other projects.\nIf set to false this image will never be recommended as an upgrade.\n"
}
}
}
CustomBaseImageCollectionResponse
{
"type": "object",
"required": [
"data",
"jsonapi"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/CustomBaseImageSnapshot"
}
}
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CustomBaseImagePatchRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the custom base image that should be updated. (Same one used in the URI)"
},
"type": {
"type": "string",
"example": "custom_base_image",
"description": "This should always be \"custom_base_image\""
},
"attributes": {
"type": "object",
"properties": {
"versioning_schema": {
"$ref": "#/components/schemas/VersioningSchema"
},
"include_in_recommendations": {
"type": "boolean",
"example": true
}
},
"minProperties": 1
}
}
}
}
}
CustomBaseImagePostRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"example": "custom_base_image",
"description": "This should always be \"custom_base_image\""
},
"attributes": {
"$ref": "#/components/schemas/CustomBaseImageAttributes"
}
}
}
}
}
CustomBaseImageResource
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "2cab3939-d112-4ef0-836d-e09c87cbe69b"
},
"type": {
"type": "string",
"example": "custom_base_image"
},
"attributes": {
"$ref": "#/components/schemas/CustomBaseImageAttributes"
}
}
}
CustomBaseImageResponse
{
"type": "object",
"required": [
"data",
"jsonapi"
],
"properties": {
"data": {
"$ref": "#/components/schemas/CustomBaseImageResource"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
CustomBaseImageSnapshot
{
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"org_id": {
"type": "string",
"format": "uuid"
},
"group_id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"repository": {
"type": "string"
},
"include_in_recommendations": {
"type": "boolean"
}
}
}
CycloneDxComponent
{
"xml": {
"name": "component"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "acme-lib"
},
"purl": {
"type": "string",
"example": "pkg:golang/golang.org/x/text@v0.3.7"
},
"type": {
"xml": {
"attribute": true
},
"type": "string",
"example": "library"
},
"bom-ref": {
"xml": {
"attribute": true
},
"type": "string",
"example": "common-util@3.0.0"
},
"version": {
"type": "string",
"example": "1.0.0"
}
}
}
CycloneDxDependency
{
"xml": {
"name": "dependency"
},
"type": "object",
"properties": {
"ref": {
"xml": {
"attribute": true
},
"type": "string",
"example": "common-util@3.0.0"
},
"dependsOn": {
"xml": {
"name": "dependency"
},
"type": "array",
"items": {
"type": "string"
},
"example": [
"web-framework@1.0.0",
"persistence@3.1.0"
]
}
}
}
CycloneDxDocument
{
"type": "object",
"required": [
"bomFormat",
"specVersion",
"version",
"metadata",
"dependencies"
],
"properties": {
"version": {
"type": "integer",
"example": 1
},
"metadata": {
"$ref": "#/components/schemas/CycloneDxMetadata"
},
"bomFormat": {
"enum": [
"CycloneDX"
],
"type": "string",
"example": "CycloneDX"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxComponent"
},
"description": "A list of included software components"
},
"specVersion": {
"type": "string",
"example": "1.4"
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxDependency"
}
}
}
}
CycloneDxMetadata
{
"type": "object",
"properties": {
"tools": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxTool"
}
},
"component": {
"$ref": "#/components/schemas/CycloneDxComponent"
},
"timestamp": {
"type": "string",
"example": "2021-02-09T20:40:32Z"
},
"properties": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxProperty"
}
}
}
}
CycloneDxProperty
{
"xml": {
"name": "property"
},
"type": "object",
"properties": {
"name": {
"xml": {
"attribute": true
},
"type": "string",
"example": "snyk:org_id"
},
"value": {
"type": "string",
"example": "f1bb66d1-a94e-4574-aea1-9697d794e04d"
}
}
}
CycloneDxTool
{
"xml": {
"name": "tool"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Snyk Open Source"
},
"vendor": {
"type": "string",
"example": "Snyk"
}
}
}
CycloneDxXmlDocument
{
"xml": {
"name": "bom"
},
"type": "object",
"required": [
"metadata",
"components",
"dependencies"
],
"properties": {
"metadata": {
"$ref": "#/components/schemas/CycloneDxMetadata"
},
"components": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxComponent"
},
"description": "A list of included software components"
},
"dependencies": {
"xml": {
"wrapped": true
},
"type": "array",
"items": {
"$ref": "#/components/schemas/CycloneDxDependency"
}
}
}
}
DeleteProjectsFromCollectionRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"enum": [
"project"
],
"type": "string",
"description": "Type of the item id"
}
}
},
"maxItems": 100,
"description": "IDs of items to remove from a collection"
}
}
}
Dependency
{
"type": "object",
"required": [
"package_name",
"package_version"
],
"properties": {
"package_name": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "The package name the issue was found in"
},
"package_version": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "The package version the issue was found in"
}
}
}
DeployedRiskFactor
{
"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
}
}
}
Environment
{
"type": "object",
"required": [
"id",
"type",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Internal ID for an environment."
},
"name": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"type": {
"$ref": "#/components/schemas/EnvironmentTypeDef"
},
"native_id": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "An optional native identifier for this environment. For example, a cloud account id."
}
}
}
EnvironmentTypeDef
{
"enum": [
"aws",
"azure",
"azure_ad",
"google",
"scm",
"cli",
"tfc"
],
"type": "string"
}
Error
{
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"links": {
"$ref": "#/components/schemas/ErrorLink"
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
}
ErrorDocument
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
ErrorLink
{
"type": "object",
"example": {
"about": "https://example.com/about_this_error"
},
"properties": {
"about": {
"$ref": "#/components/schemas/LinkProperty"
}
},
"description": "A link that leads to further details about this particular occurrance of the problem."
}
FilePosition
{
"type": "object",
"required": [
"line",
"column"
],
"properties": {
"line": {
"type": "integer",
"minimum": 0
},
"column": {
"type": "integer",
"minimum": 0
}
}
}
GetProjectSettingsCollection
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectSettingsData"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
GetProjectsOfCollectionResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectOfCollection"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
GrantType
{
"enum": [
"authorization_code",
"client_credentials"
],
"type": "string",
"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."
}
GroupIacSettingsRequest
{
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"example": "iac_settings",
"description": "Content type"
},
"attributes": {
"type": "object",
"properties": {
"custom_rules": {
"type": "object",
"properties": {
"is_enabled": {
"$ref": "#/components/schemas/IsEnabled"
},
"oci_registry_tag": {
"$ref": "#/components/schemas/OciRegistryTag"
},
"oci_registry_url": {
"$ref": "#/components/schemas/OciRegistryUrl"
}
},
"description": "The Infrastructure as Code custom rules settings for a group.",
"minProperties": 1
}
}
}
},
"description": "The Infrastructure as Code settings for a group."
}
GroupIacSettingsResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "ea536a06-0566-40ca-b96b-155568aa2027",
"description": "ID"
},
"type": {
"type": "string",
"example": "iac_settings",
"description": "Content type"
},
"attributes": {
"type": "object",
"properties": {
"updated": {
"$ref": "#/components/schemas/Updated"
},
"custom_rules": {
"type": "object",
"properties": {
"is_enabled": {
"$ref": "#/components/schemas/IsEnabled"
},
"oci_registry_tag": {
"$ref": "#/components/schemas/OciRegistryTag"
},
"oci_registry_url": {
"$ref": "#/components/schemas/OciRegistryUrl"
}
},
"description": "The Infrastructure as Code custom rules settings for a group."
}
}
}
},
"description": "The Infrastructure as Code settings for a group."
}
HelloWorld
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"message",
"requestSubject"
],
"properties": {
"message": {
"type": "string"
},
"requestSubject": {
"type": "object",
"required": [
"publicId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"clientId": {
"type": "string",
"format": "uuid"
},
"publicId": {
"type": "string",
"format": "uuid"
}
}
}
}
}
}
}
IacSettingsGetForGroupResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/GroupIacSettingsResponse"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
IacSettingsGetForOrgIacResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/OrgIacSettingsResponse"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
IacSettingsUpdateForGroupRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GroupIacSettingsRequest"
}
}
}
IacSettingsUpdateForGroupResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/GroupIacSettingsResponse"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
IacSettingsUpdateForOrgRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrgIacSettingsRequest"
}
}
}
IacSettingsUpdateForOrgResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/OrgIacSettingsResponse"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
Id
{
"type": "string",
"format": "uuid"
}
IgnoreType
{
"enum": [
"ignore"
],
"type": "string",
"example": "ignore"
}
Image
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/ImageDigest"
},
"type": {
"enum": [
"container_image"
],
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/ImageAttributes"
},
"relationships": {
"type": "object",
"properties": {
"image_target_refs": {
"type": "object",
"properties": {
"links": {
"$ref": "#/components/schemas/SelfLink"
}
}
}
}
}
}
}
ImageAttributes
{
"type": "object",
"required": [
"platform",
"layers"
],
"properties": {
"names": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageName"
}
},
"layers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageDigest"
},
"minItems": 1
},
"platform": {
"$ref": "#/components/schemas/Platform"
}
}
}
ImageDigest
{
"type": "string",
"format": "uri",
"example": "sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676",
"pattern": "^sha256(:|%3A)[a-f0-9]{64}$"
}
ImageName
{
"type": "string",
"example": "gcr.io/snyk/redis:5",
"pattern": "^((?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?\\/)?[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?(?:(?:\\/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?)(?::([\\w][\\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][A-Fa-f0-9]{32,}))?$"
}
ImageTargetRef
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "3cd4af4c-fb15-45c4-9acd-8e8fcc6690af"
},
"type": {
"enum": [
"image_target_reference"
],
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/ImageTargetRefAttributes"
}
}
}
ImageTargetRefAttributes
{
"type": "object",
"properties": {
"platform": {
"$ref": "#/components/schemas/Platform"
},
"target_id": {
"type": "string",
"format": "uuid"
},
"target_reference": {
"type": "string"
}
}
}
InheritFromParent
{
"enum": [
"group"
],
"type": "string",
"description": "Which parent to inherit settings from."
}
InvitesListPendingUserInvitationsResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrgInvitation"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
InvitesUserToOrganizationRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/OrgInvitationPostData"
}
}
}
InvitesUserToOrganizationResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/OrgInvitation"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
IsActive
{
"type": "boolean",
"example": true,
"description": "Current status of the project settings."
}
IsConfidential
{
"type": "boolean",
"example": true,
"description": "A boolean to indicate if an app is confidential or not as per the OAuth2 RFC. Confidential apps can securely store secrets. Examples of non-confidential apps are full web-based or CLIs."
}
IsEnabled
{
"type": "boolean",
"example": true,
"description": "Whether the custom rules feature is enabled or not."
}
IsPublic
{
"type": "boolean",
"example": false,
"description": "A boolean to indicate if an app is publicly available or not."
}
Issue
{
"type": "object",
"required": [
"id",
"type",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "73832c6c-19ff-4a92-850c-2e1ff2800c16"
},
"type": {
"$ref": "#/components/schemas/IssueType"
},
"attributes": {
"$ref": "#/components/schemas/IssueAttributes"
},
"relationships": {
"$ref": "#/components/schemas/IssueRelationships"
}
},
"description": "A Snyk Issue."
}
IssueAttributes
{
"type": "object",
"required": [
"key",
"title",
"type",
"effective_severity_level",
"created_at",
"updated_at",
"status",
"ignored"
],
"properties": {
"key": {
"type": "string",
"example": "24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1",
"maxLength": 2048,
"description": "An opaque key used for uniquely identifying this issue across test runs, within a project."
},
"risk": {
"$ref": "#/components/schemas/Risk"
},
"tool": {
"type": "string",
"example": "snyk://npm-deps",
"maxLength": 1024,
"minLength": 1,
"description": "An opaque identifier for corelating across test runs."
},
"type": {
"$ref": "#/components/schemas/TypeDef"
},
"title": {
"type": "string",
"example": "Insecure hash function used",
"maxLength": 2048,
"minLength": 1,
"description": "A human-readable title for this issue."
},
"status": {
"enum": [
"open",
"resolved"
],
"type": "string",
"description": "The issue's status. Derived from the issue's resolution, which provides more details."
},
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Class"
},
"maxItems": 50,
"minItems": 1,
"description": "A list of details for weakness data, policy, etc that are the class of this issue's source."
},
"ignored": {
"type": "boolean",
"description": "A flag indicating if the issue is being ignored. Derived from the issue's ignore, which provides more details."
},
"problems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Problem"
},
"maxItems": 10,
"minItems": 1,
"description": "A list of details for vulnerability data, policy, etc that are the source of this issue."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The creation time of this issue."
},
"resolution": {
"$ref": "#/components/schemas/Resolution"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The time when this issue was last modified."
},
"coordinates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coordinate"
},
"minItems": 1,
"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"
},
"description": {
"type": "string",
"example": "Affected versions of this package are vulnerable to Prototype Pollution.\nThe utilities function allow modification of the `Object` prototype.\nIf an attacker can control part of the structure passed to this function,\nthey could add or modify an existing property.\n",
"maxLength": 4096,
"minLength": 1,
"description": "A markdown-formatted optional description of this issue. Links are not permitted."
},
"effective_severity_level": {
"enum": [
"info",
"low",
"medium",
"high",
"critical"
],
"type": "string",
"description": "The computed effective severity of this issue. This is either the highest level from all included severities,\nor an overridden value set via group level policy.\n"
}
},
"description": "issue attributes"
}
IssueRelationships
{
"type": "object",
"example": {
"ignore": {
"data": {
"id": "a3952187-0d8e-45d8-9aa2-036642857b5d",
"type": "ignore"
}
},
"scan_item": {
"data": {
"id": "a3952187-0d8e-45d8-9aa2-036642857b5cX",
"type": "project"
}
},
"organization": {
"data": {
"id": "a3952187-0d8e-45d8-9aa2-036642857b5bX",
"type": "organization"
}
},
"test_executions": {
"data": [
{
"id": "0086e1bc-7c27-4f2e-9a99-5fe793ba4bef",
"type": "test-workflow-execution"
}
]
}
},
"required": [
"organization",
"scan_item"
],
"properties": {
"ignore": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"example": "5a19d42f-31bc-4ad0-b127-b79a3270db08"
},
"type": {
"$ref": "#/components/schemas/IgnoreType"
}
}
}
},
"description": "An optional reference to an ignore rule that marks this issue as ignored."
},
"scan_item": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5a19d42f-31bc-4ad0-b127-b79a3270db08"
},
"type": {
"$ref": "#/components/schemas/ScanItemType"
}
}
}
}
},
"organization": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "5a19d42f-31bc-4ad0-b127-b79a3270db08"
},
"type": {
"$ref": "#/components/schemas/OrganizationType"
}
}
}
}
},
"test_executions": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"example": "3344947d-a5c3-4e20-928b-385a5d8792a3"
},
"type": {
"$ref": "#/components/schemas/TestExecutionType"
}
}
},
"maxItems": 25,
"description": "List of metadata associated with the test executions that identified this issue"
}
},
"description": "The \"test execution\" that identified this Issues. This ID represents\na grouping of issues, that were identified by some analysis run, to produce\nIssues.\n"
}
},
"description": "issue relationships"
}
IssueType
{
"enum": [
"issue"
],
"type": "string",
"example": "issue"
}
IssuesByGroupId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesByGroupId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesByGroupId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesByGroupId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesByGroupIdResponse
{
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Issue"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
IssuesGetById401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetById403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetById404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetById409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetById500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIssueId400Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIssueId401Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIssueId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIssueId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIssueId409Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIssueId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesGetByIssueIdResponse
{
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Issue"
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
IssuesListByOrgId403Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesListByOrgId404Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesListByOrgId500Response
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesListByOrgIdResponse
{
"type": "object",
"example": {
"errors": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"jsonapi": {
"version": "1.0"
}
},
"required": [
"jsonapi",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"example": {
"detail": "Not Found",
"status": "404"
},
"required": [
"status",
"detail"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f16c31b5-6129-4571-add8-d589da9be524",
"description": "A unique identifier for this particular occurrence of the problem."
},
"code": {
"type": "string",
"example": "entity-not-found",
"description": "An application-specific error code, expressed as a string value."
},
"meta": {
"type": "object",
"example": {
"key": "value"
},
"additionalProperties": true
},
"title": {
"type": "string",
"example": "Bad request",
"description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"example": "The request was missing these required fields: ...",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"source": {
"type": "object",
"example": {
"pointer": "/data/attributes"
},
"properties": {
"pointer": {
"type": "string",
"example": "/data/attributes",
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document."
},
"parameter": {
"type": "string",
"example": "param1",
"description": "A string indicating which URI query parameter caused the error."
}
}
},
"status": {
"type": "string",
"example": "400",
"pattern": "^[45]\\d\\d$",
"description": "The HTTP status code applicable to this problem, expressed as a string value."
}
}
},
"example": [
{
"detail": "Permission denied for this resource",
"status": "403"
}
],
"minItems": 1
},
"jsonapi": {
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
}
}
IssuesMeta
{
"type": "object",
"properties": {
"package": {
"$ref": "#/components/schemas/PackageMeta"
}
}
}
IssuesResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonIssueModel"
}
},
"meta": {
"$ref": "#/components/schemas/IssuesMeta"
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
IssuesWithPurlsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonIssueModelVTwo"
}
},
"meta": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
JsonApi
{
"type": "object",
"example": {
"version": "1.0"
},
"required": [
"version"
],
"properties": {
"version": {
"type": "string",
"example": "1.0",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
"description": "Version of the JSON API specification this server supports."
}
}
}
LatestDependencyTotal
{
"type": "object",
"properties": {
"total": {
"type": "number"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
LatestIssueCounts
{
"type": "object",
"properties": {
"low": {
"type": "number"
},
"high": {
"type": "number"
},
"medium": {
"type": "number"
},
"critical": {
"type": "number"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
LinkProperty
{
"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": {
"$ref": "#/components/schemas/Meta"
}
}
}
],
"example": "https://example.com/api/resource"
}
Links
{
"type": "object",
"properties": {
"last": {
"$ref": "#/components/schemas/LinkProperty"
},
"next": {
"$ref": "#/components/schemas/LinkProperty"
},
"prev": {
"$ref": "#/components/schemas/LinkProperty"
},
"self": {
"$ref": "#/components/schemas/LinkProperty"
},
"first": {
"$ref": "#/components/schemas/LinkProperty"
},
"related": {
"$ref": "#/components/schemas/LinkProperty"
}
}
}
ManualRemediationPRsSettings
{
"type": "object",
"properties": {
"is_patch_remediation_enabled": {
"type": "boolean",
"example": true,
"description": "Include vulnerability patches in manual pull requests."
}
},
"description": "Manually raise pull requests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Project's integration."
}
MemberRoleRelationship
{
"type": "object",
"nullable": true,
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "f60ff965-6889-4db2-8c86-0285d62f35ab",
"description": "The Snyk ID of the organization role."
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/OrgRoleAttributes"
}
}
}
}
}
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
}
NugetBuildArgs
{
"type": "object",
"required": [
"target_framework"
],
"properties": {
"target_framework": {
"type": "string"
}
}
}
OSConditionRiskFactor
{
"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
}
}
}
OciRegistryTag
{
"type": "string",
"example": "latest",
"description": "The tag for an OCI artifact inside an OCI registry."
}
OciRegistryUrl
{
"type": "string",
"example": "https://registry-1.docker.io/account/bundle",
"description": "The URL to an OCI registry."
}
OpenApiGetEffectiveVersionResponse
{
"type": "object",
"example": {},
"properties": {}
}
OpenApiListAvailableVersionsResponse
{
"type": "array",
"items": {
"type": "string"
}
}
Org
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
"description": "The Snyk ID of the organization."
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/OrgAttributes"
}
}
}
OrgAttributes
{
"type": "object",
"required": [
"name",
"slug",
"is_personal"
],
"properties": {
"name": {
"type": "string",
"example": "My Org",
"description": "The display name of the organization."
},
"slug": {
"type": "string",
"example": "my-org",
"description": "The canonical (unique and URL-friendly) name of the organization."
},
"group_id": {
"type": "string",
"format": "uuid",
"example": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
"description": "The Snyk ID of the group to which the organization belongs."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-03-16T00:00:00Z",
"description": "The time the organization was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2022-03-16T00:00:00Z",
"description": "The time the organization was last modified."
},
"is_personal": {
"type": "boolean",
"example": true,
"description": "Whether the organization is independent (that is, not part of a group)."
},
"access_requests_enabled": {
"type": "boolean",
"example": false,
"description": "Whether the organization permits access requests from users who are not members of the organization."
}
}
}
OrgIacSettingsRequest
{
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"example": "iac_settings",
"description": "Content type"
},
"attributes": {
"type": "object",
"properties": {
"custom_rules": {
"type": "object",
"properties": {
"is_enabled": {
"$ref": "#/components/schemas/IsEnabled"
},
"oci_registry_tag": {
"$ref": "#/components/schemas/OciRegistryTag"
},
"oci_registry_url": {
"$ref": "#/components/schemas/OciRegistryUrl"
},
"inherit_from_parent": {
"$ref": "#/components/schemas/InheritFromParent"
}
},
"description": "The Infrastructure as Code custom rules settings for an org.",
"minProperties": 1
}
}
}
},
"description": "The Infrastructure as Code settings for an org."
}
OrgIacSettingsResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "ea536a06-0566-40ca-b96b-155568aa2027",
"description": "ID"
},
"type": {
"type": "string",
"example": "iac_settings",
"description": "Content type"
},
"attributes": {
"type": "object",
"properties": {
"custom_rules": {
"type": "object",
"properties": {
"parents": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"updated": {
"$ref": "#/components/schemas/Updated"
},
"custom_rules": {
"type": "object",
"properties": {
"is_enabled": {
"$ref": "#/components/schemas/IsEnabled"
},
"oci_registry_tag": {
"$ref": "#/components/schemas/OciRegistryTag"
},
"oci_registry_url": {
"$ref": "#/components/schemas/OciRegistryUrl"
}
},
"description": "The Infrastructure as Code custom rules settings for a group."
}
},
"description": "The Infrastructure as Code settings at the group level."
}
},
"description": "Contains all parents the org can inherit settings from."
},
"updated": {
"$ref": "#/components/schemas/Updated"
},
"is_enabled": {
"$ref": "#/components/schemas/IsEnabled"
},
"oci_registry_tag": {
"$ref": "#/components/schemas/OciRegistryTag"
},
"oci_registry_url": {
"$ref": "#/components/schemas/OciRegistryUrl"
},
"inherit_from_parent": {
"$ref": "#/components/schemas/InheritFromParent"
}
},
"description": "The Infrastructure as Code custom rules settings for an org."
}
}
}
},
"description": "The Infrastructure as Code settings for an org."
}
OrgInvitation
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"enum": [
"org_invitation"
],
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/OrgInvitationAttributes"
},
"relationships": {
"type": "object",
"properties": {
"org": {
"$ref": "#/components/schemas/Relationship"
}
}
}
}
}
OrgInvitationAttributes
{
"type": "object",
"required": [
"email",
"is_active",
"role"
],
"properties": {
"role": {
"type": "string",
"format": "uuid",
"example": "f1968726-1dca-42d4-a4dc-80cab99e2b6c",
"description": "The role public ID that will be granted to to invitee on acceptance."
},
"email": {
"type": "string",
"example": "example@email.com",
"description": "The email address of the invitee."
},
"is_active": {
"type": "boolean",
"example": true,
"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"
}
}
}
OrgInvitationPostAttributes
{
"type": "object",
"required": [
"email",
"role"
],
"properties": {
"role": {
"format": "uuid",
"example": "f1968726-1dca-42d4-a4dc-80cab99e2b6c",
"description": "The role public ID that will be granted to to invitee on acceptance."
},
"email": {
"type": "string",
"example": "example@email.com",
"description": "The email address of the invitee."
}
}
}
OrgInvitationPostData
{
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"org_invitation"
],
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/OrgInvitationPostAttributes"
},
"relationships": {
"type": "object",
"properties": {
"org": {
"$ref": "#/components/schemas/Relationship"
}
}
}
}
}
OrgRelationships
{
"type": "object",
"properties": {
"member_role": {
"$ref": "#/components/schemas/MemberRoleRelationship"
}
}
}
OrgRoleAttributes
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Collaborator",
"description": "The display name of the organization role."
}
}
}
OrgUpdateAttributes
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "My Org",
"maxLength": 60,
"minLength": 1,
"description": "The display name of the organization."
}
}
}
OrgWithRelationships
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
"description": "The Snyk ID of the organization."
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/OrgAttributes"
},
"relationships": {
"$ref": "#/components/schemas/OrgRelationships"
}
}
}
OrganizationType
{
"enum": [
"organization"
],
"type": "string",
"example": "organization"
}
OrgsGetDetailsResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Org"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
OrgsListAccessibleOrganizationsResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrgWithRelationships"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
OrgsListGroupOrgsResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Org"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
OrgsUpdateDetailsRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/OrgUpdateAttributes"
}
}
}
}
}
OrgsUpdateDetailsResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"$ref": "#/components/schemas/OrgAttributes"
},
"relationships": {
"$ref": "#/components/schemas/OrgRelationships"
}
},
"description": "org resource object"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
Package
{
"type": "object",
"required": [
"name",
"type",
"url",
"version"
],
"properties": {
"url": {
"type": "string",
"example": "pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0",
"description": "The purl of the package"
},
"name": {
"type": "string",
"example": "spring-core",
"description": "The package’s name"
},
"type": {
"type": "string",
"example": "maven",
"description": "The package type or protocol"
},
"version": {
"type": "string",
"example": "1.0.0",
"description": "The version of the package"
},
"namespace": {
"type": "string",
"example": "org.springframework",
"description": "A name prefix, such as a maven group id or docker image owner"
}
}
}
PackageMeta
{
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0",
"description": "The purl of the package"
},
"name": {
"type": "string",
"example": "woodstox-core",
"description": "The package’s name"
},
"type": {
"type": "string",
"example": "maven",
"description": "The package type or protocol"
},
"version": {
"type": "string",
"example": "5.0.0",
"description": "The version of the package"
},
"namespace": {
"type": "string",
"example": "com.fasterxml.woodstox",
"description": "A name prefix, such as a maven group id or docker image owner"
}
}
}
PackageRepresentation
{
"type": "object",
"properties": {
"package": {
"$ref": "#/components/schemas/PackageMeta"
}
}
}
PaginatedLinks
{
"type": "object",
"example": {
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K",
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K"
},
"properties": {
"last": {
"$ref": "#/components/schemas/LinkProperty"
},
"next": {
"$ref": "#/components/schemas/LinkProperty"
},
"prev": {
"$ref": "#/components/schemas/LinkProperty"
},
"self": {
"$ref": "#/components/schemas/LinkProperty"
},
"first": {
"$ref": "#/components/schemas/LinkProperty"
}
}
}
PatchProjectRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "331ede0a-de94-456f-b788-166caeca58bf",
"description": "The Resource ID."
},
"type": {
"enum": [
"project"
],
"type": "string",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "tag-key"
},
"value": {
"type": "string",
"example": "tag-value"
}
}
},
"example": [
{
"key": "tag-key",
"value": "tag-value"
}
]
},
"lifecycle": {
"type": "array",
"items": {
"enum": [
"production",
"development",
"sandbox"
],
"type": "string"
},
"example": [
"production"
]
},
"environment": {
"type": "array",
"items": {
"enum": [
"frontend",
"backend",
"internal",
"external",
"mobile",
"saas",
"onprem",
"hosted",
"distributed"
],
"type": "string"
},
"example": [
"external",
"hosted"
]
},
"test_frequency": {
"enum": [
"daily",
"weekly",
"never"
],
"type": "string",
"example": "daily",
"description": "Test frequency of a project. Also controls when automated PRs may be created."
},
"business_criticality": {
"type": "array",
"items": {
"enum": [
"critical",
"high",
"medium",
"low"
],
"type": "string"
},
"example": [
"medium"
]
}
}
},
"relationships": {
"type": "object",
"properties": {
"owner": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "331ede0a-de94-456f-b788-166caeca58bf",
"nullable": true,
"description": "The public ID of the user that owns the project"
},
"type": {
"enum": [
"user"
],
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
Platform
{
"enum": [
"aix/ppc64",
"android/386",
"android/amd64",
"android/arm",
"android/arm/v5",
"android/arm/v6",
"android/arm/v7",
"android/arm64",
"android/arm64/v8",
"darwin/amd64",
"darwin/arm",
"darwin/arm/v5",
"darwin/arm/v6",
"darwin/arm/v7",
"darwin/arm64",
"darwin/arm64/v8",
"dragonfly/amd64",
"freebsd/386",
"freebsd/amd64",
"freebsd/arm",
"freebsd/arm/v5",
"freebsd/arm/v6",
"freebsd/arm/v7",
"illumos/amd64",
"ios/arm64",
"ios/arm64/v8",
"js/wasm",
"linux/386",
"linux/amd64",
"linux/arm",
"linux/arm/v5",
"linux/arm/v6",
"linux/arm/v7",
"linux/arm64",
"linux/arm64/v8",
"linux/loong64",
"linux/mips",
"linux/mipsle",
"linux/mips64",
"linux/mips64le",
"linux/ppc64",
"linux/ppc64le",
"linux/riscv64",
"linux/s390x",
"linux/x86_64",
"netbsd/386",
"netbsd/amd64",
"netbsd/arm",
"netbsd/arm/v5",
"netbsd/arm/v6",
"netbsd/arm/v7",
"openbsd/386",
"openbsd/amd64",
"openbsd/arm",
"openbsd/arm/v5",
"openbsd/arm/v6",
"openbsd/arm/v7",
"openbsd/arm64",
"openbsd/arm64/v8",
"plan9/386",
"plan9/amd64",
"plan9/arm",
"plan9/arm/v5",
"plan9/arm/v6",
"plan9/arm/v7",
"solaris/amd64",
"windows/386",
"windows/amd64",
"windows/arm",
"windows/arm/v5",
"windows/arm/v6",
"windows/arm/v7",
"windows/arm64",
"windows/arm64/v8"
],
"type": "string",
"example": "linux/amd64"
}
Problem
{
"type": "object",
"example": {
"id": "SNYK-DEBIAN8-CURL-358558",
"type": "rule",
"source": "snyk"
},
"required": [
"id",
"type",
"source"
],
"properties": {
"id": {
"type": "string",
"maxLength": 1024,
"minLength": 1
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096,
"minLength": 1,
"description": "An optional URL for this problem."
},
"type": {
"$ref": "#/components/schemas/ProblemTypeDef"
},
"source": {
"type": "string",
"example": "CVE",
"maxLength": 64,
"minLength": 1
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was last updated."
},
"disclosed_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was disclosed to the public."
},
"discovered_at": {
"type": "string",
"format": "date-time",
"description": "When this problem was first discovered."
}
}
}
ProblemTypeDef
{
"enum": [
"rule",
"vulnerability"
],
"type": "string"
}
ProjectAttributes
{
"type": "object",
"required": [
"name",
"type",
"target_file",
"target_reference",
"origin",
"created",
"status",
"read_only",
"settings"
],
"properties": {
"name": {
"type": "string",
"example": "snyk/goof",
"description": "Project name."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "tag-key"
},
"value": {
"type": "string",
"example": "tag-value"
}
}
},
"example": [
{
"key": "tag-key",
"value": "tag-value"
}
]
},
"type": {
"type": "string",
"example": "maven",
"description": "The package manager of the project."
},
"origin": {
"type": "string",
"example": "github",
"description": "The origin the project was added from."
},
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"example": "active",
"description": "Describes if a project is currently monitored or it is de-activated."
},
"created": {
"type": "string",
"format": "date-time",
"example": "2021-05-29T09:50:54.014Z",
"description": "The date that the project was created on"
},
"settings": {
"$ref": "#/components/schemas/ProjectSettings"
},
"lifecycle": {
"type": "array",
"items": {
"enum": [
"production",
"development",
"sandbox"
],
"type": "string"
},
"example": [
"production"
]
},
"read_only": {
"type": "boolean",
"description": "Whether the project is read-only"
},
"build_args": {
"oneOf": [
{
"$ref": "#/components/schemas/YarnBuildArgs"
},
{
"$ref": "#/components/schemas/ContainerBuildArgs"
},
{
"$ref": "#/components/schemas/NugetBuildArgs"
}
]
},
"environment": {
"type": "array",
"items": {
"enum": [
"frontend",
"backend",
"internal",
"external",
"mobile",
"saas",
"onprem",
"hosted",
"distributed"
],
"type": "string"
},
"example": [
"external",
"hosted"
]
},
"target_file": {
"type": "string",
"example": "package.json",
"description": "Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity."
},
"target_runtime": {
"type": "string",
"description": "Dotnet Target, for relevant projects"
},
"target_reference": {
"type": "string",
"example": "main",
"description": "The additional information required to resolve which revision of the resource should be scanned."
},
"business_criticality": {
"type": "array",
"items": {
"enum": [
"critical",
"high",
"medium",
"low"
],
"type": "string"
},
"example": [
"medium"
]
}
}
}
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"
}
}
}
ServiceAccountsGetOrganizationAccountByIdResponse
{
"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"
}
}
}
ServiceAccountsListGroupServiceAccountsResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"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"
}
}
}
ServiceAccountsListOrganizationServiceAccountsResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"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"
}
}
}
ServiceAccountsManageClientSecretForOrganizationServiceAccountRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"service_account"
],
"type": "string",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"replace",
"create",
"delete"
],
"type": "string",
"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"
},
"secret": {
"type": "string",
"description": "Secret to delete when using `delete` mode"
}
}
}
}
}
}
}
ServiceAccountsManageClientSecretForOrganizationServiceAccountResponse
{
"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"
}
}
}
ServiceAccountsManageClientSecretRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"type": {
"enum": [
"service_account"
],
"type": "string",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"replace",
"create",
"delete"
],
"type": "string",
"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"
},
"secret": {
"type": "string",
"description": "Secret to delete when using `delete` mode"
}
}
}
}
}
}
}
ServiceAccountsManageClientSecretResponse
{
"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"
}
}
}
ServiceAccountsUpdateGroupNameByIdRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the service account. Must match the id in the url path."
},
"type": {
"enum": [
"service_account"
],
"type": "string",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name for the service account. Must be unique within the group."
}
}
}
}
}
}
}
ServiceAccountsUpdateGroupNameByIdResponse
{
"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"
}
}
}
ServiceAccountsUpdateOrganizationServiceAccountNameRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the service account. Must match the id in the url path."
},
"type": {
"enum": [
"service_account"
],
"type": "string",
"description": "The Resource type."
},
"attributes": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name for the service account. Must be unique within the organization."
}
}
}
}
}
}
}
ServiceAccountsUpdateOrganizationServiceAccountNameResponse
{
"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"
}
}
}
SessionAttributes
{
"type": "object",
"required": [
"created_at"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
SessionData
{
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"type": {
"$ref": "#/components/schemas/Type"
},
"attributes": {
"$ref": "#/components/schemas/SessionAttributes"
}
}
}
SettingsAttributes
{
"type": "object",
"required": [
"target_channel_id",
"severity_threshold"
],
"properties": {
"target_channel_id": {
"$ref": "#/components/schemas/TargetChannelId"
},
"severity_threshold": {
"$ref": "#/components/schemas/SeverityThreshold"
}
}
}
SettingsRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"slack"
],
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/SettingsAttributes"
}
}
}
}
}
Severity
{
"type": "object",
"properties": {
"level": {
"type": "string",
"example": "medium"
},
"score": {
"type": "number",
"example": 5.3,
"nullable": true,
"description": "The CVSSv3 value of the vulnerability."
},
"source": {
"type": "string",
"example": "Snyk",
"description": "The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application."
},
"vector": {
"type": "string",
"example": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:L",
"nullable": true,
"description": "The CVSSv3 value of the vulnerability."
}
}
}
SeverityThreshold
{
"enum": [
"low",
"medium",
"high",
"critical"
],
"type": "string",
"example": "high",
"description": "Minimum Snyk issue severity to send a notification for, messages will not be sent for any issue below this value"
}
SlackChannel
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uri",
"example": "slack://channel?team=T123456&id=C123456"
},
"type": {
"type": "string",
"example": "slack_channel"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "general",
"description": "Name of the Slack Channel"
},
"type": {
"enum": [
"public",
"private",
"direct_message",
"multiparty_direct_message"
],
"type": "string",
"description": "Channel type"
}
}
}
}
}
SlackDefaultSettingsData
{
"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"
],
"properties": {
"target_channel_id": {
"$ref": "#/components/schemas/TargetChannelId"
},
"severity_threshold": {
"$ref": "#/components/schemas/SeverityThreshold"
},
"target_channel_name": {
"$ref": "#/components/schemas/TargetChannelName"
}
}
}
}
}
SlackGetChannelNameByIdResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"$ref": "#/components/schemas/SlackChannel"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
SlackGetChannelsResponse
{
"type": "object",
"required": [
"data",
"jsonapi",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SlackChannel"
}
},
"links": {
"$ref": "#/components/schemas/PaginatedLinks"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
SlackSettingsCreateDefaultNotificationSettingsResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SlackDefaultSettingsData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
SlackSettingsGetDefaultNotificationSettingsResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SlackDefaultSettingsData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
SlackSettingsProjectOverrideResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectSettingsData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
SlackSettingsUpdateNotificationSettingsForProjectResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectSettingsData"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
Slots
{
"type": "object",
"properties": {
"exploit": {
"type": "string",
"example": "Not Defined",
"description": "The exploit maturity. Value of ‘No Data’, ‘Not Defined’, ‘Unproven’, ‘Proof of Concept’, ‘Functional’ or ‘High’."
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL for an external reference to the issue"
},
"title": {
"type": "string",
"description": "Descriptor for an external reference to the issue"
}
}
}
},
"disclosure_time": {
"type": "string",
"format": "date-time",
"example": "2022-06-16T13:51:13Z",
"description": "The time at which this vulnerability was disclosed."
},
"publication_time": {
"type": "string",
"example": "2022-06-16T14:00:24.315507Z",
"description": "The time at which this vulnerability was published."
}
}
}
SourceLocation
{
"type": "object",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"maximum": 2048,
"minimum": 1,
"description": "A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n"
},
"region": {
"$ref": "#/components/schemas/Region"
}
}
}
SpdxDocument
{
"type": "object",
"additionalProperties": true
}
TargetChannelId
{
"type": "string",
"format": "uri",
"example": "slack://channel?team=team-id&id=channel-id"
}
TargetChannelName
{
"type": "string",
"example": "channel-name",
"minLength": 1
}
TargetsGetByIdResponse
{
"type": "object",
"required": [
"jsonapi",
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/PublicTarget"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
TargetsListByOrgIdResponse
{
"type": "object",
"required": [
"jsonapi",
"data",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicTarget"
}
},
"meta": {
"type": "object",
"example": {
"count": 3
},
"properties": {
"count": {
"type": "number"
}
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"jsonapi": {
"$ref": "#/components/schemas/JsonApi"
}
}
}
TestExecutionType
{
"enum": [
"test-workflow-execution",
"custom-execution"
],
"type": "string"
}
Type
{
"type": "string"
}
TypeDef
{
"enum": [
"package_vulnerability",
"license",
"cloud",
"code",
"custom",
"config"
],
"type": "string",
"example": "cloud",
"description": "The type of an issue."
}
Types
{
"type": "string",
"example": "resource",
"pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$"
}
UpdateCollectionRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Types"
},
"attributes": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/components/schemas/name"
}
}
}
}
}
}
}
UpdateCollectionWithProjectsRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"enum": [
"project"
],
"type": "string",
"description": "Type of the item id"
}
}
},
"maxItems": 100,
"description": "IDs of items to add to a collection"
}
}
}
Updated
{
"type": "string",
"format": "date-time",
"example": "2021-11-12T10:31:06.026Z",
"description": "The last time the settings were updated."
}
Uuid
{
"type": "string",
"format": "uuid"
}
VersioningSchema
{
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/VersioningSchemaSemverType"
},
{
"$ref": "#/components/schemas/VersioningSchemaCustomType"
},
{
"$ref": "#/components/schemas/VersioningSchemaSingleSelectionType"
}
]
}
],
"description": "The versioning scheme used by images in the repository.\n\nA versioning schema is a system for identifying and organizing different versions of a project. \nIt is used to track changes and updates to the project over time, and to help users identify which version they are using. \nA versioning schema typically consists of a series of numbers or labels that are incremented to reflect the progression of versions. \nFor example, a versioning schema might use a series of numbers, such as \"1.0\", \"1.1\", \"2.0\", and so on, to indicate major and minor releases of a product. \nA consistent and well-defined versioning schema helps users and tools understand and track the development of a project.\n"
}
VersioningSchemaCustomType
{
"type": "object",
"required": [
"type",
"expression"
],
"properties": {
"type": {
"enum": [
"custom"
],
"type": "string"
},
"label": {
"type": "string",
"example": "calendar with flavor schema",
"description": "A customizable string that can be set for a custom versioning schema to describe its meaning.\nThis label has no function.\n"
},
"expression": {
"type": "string",
"example": "(?<C0>.)\\-(?<M2>.*)",
"description": "The regular expression used to describe the format of tags.\nKeep in mind that backslashes in the expression need to be escaped due to being encompassed in a JSON string.\n"
}
},
"description": "The Custom Schema type is a way for Snyk to understand your company’s container image tag versioning scheme,\nenabling Snyk to give more accurate base image upgrade recommendations.\n\nThis schema type is essentially a regular expression that groups the different parts of an image’s tag into comparable sections.\n\nIf your container image's tags follow a versioning scheme other than Semantic Versioning (SemVer), \nit is highly recommended that you select the \"Custom Versioning\" schema for your image repositories.\n"
}
VersioningSchemaSemverType
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"semver"
],
"type": "string",
"example": "semver"
}
}
}
VersioningSchemaSingleSelectionType
{
"type": "object",
"required": [
"type",
"is_selected"
],
"properties": {
"type": {
"enum": [
"single-selection"
],
"type": "string",
"example": "single-selection"
},
"is_selected": {
"type": "boolean",
"example": true,
"description": "Whether this image should be the recommendation. Only one image can be selected at a given time. Setting this\nas true will remove previous selection.\n"
}
},
"description": "The Single Selection Versioning Schema allows manual setting of which image should be given as a recommendation.\n\nOnly one image can be set as the current recommendation. If no images are set as the current selection, \nno recommendation will be given.\n\nIt is recommended to use this versioning schema if your repository's tags aren't supported by the other schemas.\n"
}
YarnBuildArgs
{
"type": "object",
"required": [
"root_workspace"
],
"properties": {
"root_workspace": {
"type": "string"
}
}
}
name
{
"type": "string",
"pattern": "^([a-zA-Z0-9 _\\-\\/:.])+$",
"maxLength": 255,
"minLength": 1,
"description": "User-defined name of the collection"
}