openapi.city
Sign in

Snyk API

Security platform for developers

docs.snyk.io/snyk-api ↗
Version
REST
OpenAPI
3.0.3
Endpoints
96
Schemas
446
82
Quality
Updated
3 days ago
Security security vulnerabilities devops
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.snyk.io/rest

Endpoints

GET POST PUT PATCH DELETE

Apps 20 endpoints

GET /groups/{group_id}/apps/installs

Get a list of apps installed for a group.

operationId: Apps_listGroupAppInstalls

Parameters

Name In Required Type Description
expand query optional array

Expand relationships.
group_id path required string

Group ID
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page

Responses

200

A list of apps installed for the specified group.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /groups/{group_id}/apps/installs
POST /groups/{group_id}/apps/installs

Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.

operationId: Apps_installGroupApp

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
group_id path required string

Group ID

Request Body

App Install to be created

application/vnd.api+json
schema AppsInstallGroupAppRequest
Property Type Required
data object required
└ type string optional
relationships object required
└ app object required
└ data object required
└ id string required
└ type string required

Responses

201

The newly created app install.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /groups/{group_id}/apps/installs
DELETE /groups/{group_id}/apps/installs/{install_id}

Revoke app authorization for an Snyk Group with install ID.

operationId: Apps_revokeGroupAppInstall

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
group_id path required string

Group ID
install_id path optional

Install ID

Responses

204

The app install has been de-authorized.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /groups/{group_id}/apps/installs/{install_id}
POST /groups/{group_id}/apps/installs/{install_id}/secrets

Manage client secret for non-interactive Snyk App installations.

operationId: Apps_createInstallSecret

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
group_id path required string

Group ID
install_id path optional

Install ID

Request Body

application/vnd.api+json
schema AppsCreateInstallSecretRequest
Property Type Required
data object required
└ type string required
└ attributes object required
└ mode string required
└ secret string optional

Responses

200

Secret has been updated.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /groups/{group_id}/apps/installs/{install_id}/secrets
GET /orgs/{org_id}/apps/creations

Get a list of apps created by an organization.

operationId: Apps_listOrgCreations

Parameters

Name In Required Type Description
org_id path required string

Org ID
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page

Responses

200

A list of apps created by the specified organization
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/apps/creations
POST /orgs/{org_id}/apps/creations

Create a new Snyk App for an organization.

operationId: Apps_createNewAppForOrganization

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID

Request Body

Snyk App details for app to be created.

application/vnd.api+json
schema AppPostRequest
Property Type Required
data object required
└ type string required
└ attributes object required
└ name string required
└ scopes array required
└ context string required
└ redirect_uris array required
└ access_token_ttl_seconds number optional

Responses

201

Created Snyk App successfully.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/creations
DELETE /orgs/{org_id}/apps/creations/{app_id}

Delete an app by its App ID.

operationId: Apps_deleteByAppId

Parameters

Name In Required Type Description
org_id path required string

Org ID
app_id path optional

App ID
version query optional

The requested version of the endpoint to process the request

Responses

204

The app has been deleted
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /orgs/{org_id}/apps/creations/{app_id}
GET /orgs/{org_id}/apps/creations/{app_id}

Get a Snyk App by its App ID.

operationId: Apps_getByAppId

Parameters

Name In Required Type Description
org_id path required string

Org ID
app_id path optional

App ID
version query optional

The requested version of the endpoint to process the request

Responses

200

The requested app
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/apps/creations/{app_id}
PATCH /orgs/{org_id}/apps/creations/{app_id}

Update app creation attributes with App ID.

operationId: Apps_updateCreationAttributesById

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
app_id path optional

App ID

Request Body

application/vnd.api+json
schema AppPatchRequest
Property Type Required
data object required
└ type string optional
└ attributes object optional
└ name string optional
└ redirect_uris array optional
└ access_token_ttl_seconds number optional

Responses

200

The update app.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
PATCH /orgs/{org_id}/apps/creations/{app_id}
POST /orgs/{org_id}/apps/creations/{app_id}/secrets

Manage client secret for the Snyk App.

operationId: Apps_manageClientSecretForSnykApp

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
app_id path optional

App ID

Request Body

application/vnd.api+json
schema AppsManageClientSecretForSnykAppRequest
Property Type Required
data object required
└ type string required
└ attributes object required
└ mode string required
└ secret string optional

Responses

200

Secret has been updated.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/creations/{app_id}/secrets
GET /orgs/{org_id}/apps/installs

Get a list of apps installed for an organization.

operationId: Apps_listOrgInstalls

Parameters

Name In Required Type Description
expand query optional array

Expand relationships.
org_id path required string

Org ID
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page

Responses

200

A list of apps installed for the specified organization.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/apps/installs
POST /orgs/{org_id}/apps/installs

Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.

operationId: Apps_installSnykAppToOrg

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID

Request Body

App Install to be created

application/vnd.api+json
schema AppsInstallSnykAppToOrgRequest
Property Type Required
data object required
└ type string optional
relationships object required
└ app object required
└ data object required
└ id string required
└ type string required

Responses

201

The newly created app install.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/installs
DELETE /orgs/{org_id}/apps/installs/{install_id}

Revoke app authorization for an Snyk Organization with install ID.

operationId: Apps_byInstallId

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
install_id path optional

Install ID

Responses

204

The app install has been revoked.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /orgs/{org_id}/apps/installs/{install_id}
POST /orgs/{org_id}/apps/installs/{install_id}/secrets

Manage client secret for non-interactive Snyk App installations.

operationId: Apps_manageClientSecretForSnykApp

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
install_id path optional

Install ID

Request Body

application/vnd.api+json
schema AppsManageClientSecretForSnykAppRequest1
Property Type Required
data object required
└ type string required
└ attributes object required
└ mode string required
└ secret string optional

Responses

200

Secret has been updated.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/apps/installs/{install_id}/secrets
GET /self/apps

Get a list of apps that can act on your behalf.

operationId: Apps_listApps

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page

Responses

200

A list of apps install that can act on your behalf
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /self/apps
GET /self/apps/installs

Get a list of apps installed for an user.

operationId: Apps_listUserInstalledApps

Parameters

Name In Required Type Description
expand query optional array

Expand relationships.
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page

Responses

200

A list of apps installed for the specified organization.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /self/apps/installs
DELETE /self/apps/installs/{install_id}

Revoke access for an app by install ID.

operationId: Apps_revokeByInstallId

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
install_id path optional

Install ID

Responses

204

The app install has been revoked.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /self/apps/installs/{install_id}
DELETE /self/apps/{app_id}

Revoke access for an app by app id

operationId: Apps_revokeAppById

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
app_id path optional

App ID

Responses

204

The app has been revoked
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /self/apps/{app_id}
GET /self/apps/{app_id}/sessions

Get a list of active OAuth sessions for the app.

operationId: Apps_getActiveSessions

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page
app_id path optional

App ID

Responses

200

A list of active OAuth sessions for the app.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /self/apps/{app_id}/sessions
DELETE /self/apps/{app_id}/sessions/{session_id}

Revoke an active user app session.

operationId: Apps_revokeUserAppSession

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
app_id path optional

App ID
session_id path required string

Session ID

Responses

204

The user app sessions has been revoked.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /self/apps/{app_id}/sessions/{session_id}

Auditlogs 2 endpoints

GET /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
operationId: AuditLogs_searchGroupAuditLogs

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
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.

Responses

200

Group Audit Logs.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /groups/{group_id}/audit_logs/search
GET /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
operationId: AuditLogs_searchOrganizationAuditLogs

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
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.

Responses

200

Organization Audit Logs.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/audit_logs/search

Collection 8 endpoints

GET /orgs/{org_id}/collections

Return a list of organization’s collections with issues counts and projects count.

operationId: Collection_getList

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page
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

Responses

200

Returns a list of collections
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/collections
POST /orgs/{org_id}/collections

Create a collection

operationId: Collection_createNew

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID

Request Body

application/vnd.api+json
schema CreateCollectionRequest
Property Type Required
data object required
└ type string required
└ attributes object required
└ name string required

Responses

201

Returned collection
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/collections
DELETE /orgs/{org_id}/collections/{collection_id}

Delete a collection

operationId: Collection_removeById

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
collection_id path optional string

Unique identifier for a collection

Responses

204

Collection was deleted successfully
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /orgs/{org_id}/collections/{collection_id}
GET /orgs/{org_id}/collections/{collection_id}

Get a collection

operationId: Collection_getById

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
collection_id path optional string

Unique identifier for a collection

Responses

200

Returned collection
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/collections/{collection_id}
PATCH /orgs/{org_id}/collections/{collection_id}

Edit a collection

operationId: Collection_editCollection

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
collection_id path optional string

Unique identifier for a collection

Request Body

application/vnd.api+json
schema UpdateCollectionRequest
Property Type Required
data object required
└ id string optional
└ type string required
└ attributes object required
└ name string required

Responses

200

Returned collection
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
PATCH /orgs/{org_id}/collections/{collection_id}
DELETE /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)

operationId: Collection_removeProjects

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
collection_id path optional string

Unique identifier for a collection

Request Body

application/vnd.api+json
schema DeleteProjectsFromCollectionRequest
Property Type Required
data array required
└ id string required
└ type string required

Responses

204

successfully removing projects from a collection
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /orgs/{org_id}/collections/{collection_id}/relationships/projects
GET /orgs/{org_id}/collections/{collection_id}/relationships/projects

Return a list of organization’s projects that are from the specified collection.

operationId: Collection_getProjects

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
collection_id path optional string

Unique identifier for a collection
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page
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

Responses

200

Returns a list of projects from the specified collection
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/collections/{collection_id}/relationships/projects
POST /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)

operationId: Collection_addProjectsTo

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
collection_id path optional string

Unique identifier for a collection

Request Body

application/vnd.api+json
schema UpdateCollectionWithProjectsRequest
Property Type Required
data array required
└ id string required
└ type string required

Responses

204

successfully adding projects to a collection
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/collections/{collection_id}/relationships/projects

Containerimage 3 endpoints

GET /orgs/{org_id}/container_images

List instances of container image

operationId: ContainerImage_listInstancesOfContainerImage

Parameters

Name In Required Type Description
org_id path required string

Org ID
image_ids query optional array

A comma-separated list of Image IDs
platform query optional

The image Operating System and processor architecture
names query optional array

The container registry names
version query optional

The requested version of the endpoint to process the request
limit query optional integer

Number of results to return per page
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor

Responses

200

Returns a list of container image instances
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/container_images
GET /orgs/{org_id}/container_images/{image_id}

Get instance of container image

operationId: ContainerImage_getInstance

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
image_id path optional string

Image ID

Responses

200

Returns an instance of container image
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/container_images/{image_id}
GET /orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs

List instances of image target references for a container image

operationId: ContainerImage_listImageTargetRefs

Parameters

Name In Required Type Description
org_id path required string

Org ID
image_id path optional string

Image ID
version query optional

The requested version of the endpoint to process the request
limit query optional integer

Number of results to return per page
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor

Responses

200

Returns a list of image target references for a container image
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs

Custombaseimages 5 endpoints

GET /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.

operationId: CustomBaseImages_list

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page
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
repository query optional string

The image repository
tag query optional string

The image tag
include_in_recommendations query optional boolean

Whether this image should be recommended as a base image upgrade
sort_by query optional string

Which column to sort by.
If sorting by version, the versioning schema is used.
sort_direction query optional string

Which direction to sort

Responses

200

Returns custom base images
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /custom_base_images
POST /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.

operationId: CustomBaseImages_markImageAsCustomBase

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request

Request Body

The properties used in the creation of a custom base image

application/vnd.api+json
schema CustomBaseImagePostRequest
Property Type Required
data object required
└ type string required
└ attributes object required
└ project_id string required
└ versioning_schema object optional
└ include_in_recommendations boolean required

Responses

201

Successfully created a custom base image
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /custom_base_images
DELETE /custom_base_images/{custombaseimage_id}

Delete a custom base image resource. (the related container project is unaffected)

operationId: CustomBaseImages_removeCustomBaseImage

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
custombaseimage_id path optional string

Unique identifier for custom base image

Responses

204

Successfully deleted the custom base image
401

Unauthorized: the request requires an authentication token.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /custom_base_images/{custombaseimage_id}
GET /custom_base_images/{custombaseimage_id}

Get a custom base image

operationId: CustomBaseImages_getById

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
custombaseimage_id path optional string

Unique identifier for custom base image

Responses

200

Returns a custom base image
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /custom_base_images/{custombaseimage_id}
PATCH /custom_base_images/{custombaseimage_id}

Updates a custom base image’s attributes

operationId: CustomBaseImages_updateAttributes

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
custombaseimage_id path optional string

Unique identifier for custom base image

Request Body

custom base image to be updated

application/vnd.api+json
schema CustomBaseImagePatchRequest
Property Type Required
data object required
└ id string optional
└ type string required
└ attributes object required
└ versioning_schema object optional
└ include_in_recommendations boolean optional

Responses

200

Returns the updated custom base image
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
PATCH /custom_base_images/{custombaseimage_id}

Iacsettings 4 endpoints

GET /groups/{group_id}/settings/iac

Get the Infrastructure as Code Settings for a group.

operationId: IacSettings_getForGroup

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
group_id path required string

The id of the group whose Infrastructure as Code settings are requested

Responses

200

The Infrastructure as Code Settings of the group.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /groups/{group_id}/settings/iac
PATCH /groups/{group_id}/settings/iac

Update the Infrastructure as Code Settings for a group.

operationId: IacSettings_updateForGroup

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
group_id path required string

The id of the group whose Infrastructure as Code settings are getting updated

Request Body

application/vnd.api+json
schema IacSettingsUpdateForGroupRequest
Property Type Required
data object optional
└ type string required
└ attributes object required
└ custom_rules object optional
└ is_enabled boolean optional
└ oci_registry_tag string optional
└ oci_registry_url string optional

Responses

200

The Infrastructure as Code Settings of the group were updated.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
PATCH /groups/{group_id}/settings/iac
GET /orgs/{org_id}/settings/iac

Get the Infrastructure as Code Settings for an org.

operationId: IacSettings_getForOrgIac

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

The id of the org whose Infrastructure as Code settings are requested.

Responses

200

The Infrastructure as Code Settings of the org.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/settings/iac
PATCH /orgs/{org_id}/settings/iac

Update the Infrastructure as Code Settings for an org.

operationId: IacSettings_updateForOrg

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

The id of the org whose Infrastructure as Code settings are getting updated

Request Body

application/vnd.api+json
schema IacSettingsUpdateForOrgRequest
Property Type Required
data object optional
└ type string required
└ attributes object required
└ custom_rules object optional
└ is_enabled boolean optional
└ oci_registry_tag string optional
└ oci_registry_url string optional
└ inherit_from_parent string optional

Responses

200

The Infrastructure as Code Settings of the org were updated.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
PATCH /orgs/{org_id}/settings/iac

Invites 3 endpoints

GET /orgs/{org_id}/invites

List pending user invitations to an organization.

operationId: Invites_listPendingUserInvitations

Parameters

Name In Required Type Description
org_id path required string

The id of the org the user is being invited to
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page

Responses

200

List of pending invitations to an organization.
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/invites
POST /orgs/{org_id}/invites

Invite a user to an organization with a role.

operationId: Invites_userToOrganization

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

The id of the org the user is being invited to

Request Body

application/vnd.api+json
schema InvitesUserToOrganizationRequest
Property Type Required
data object required
└ type string required
└ attributes object required
└ role object required
└ email string required
└ relationships object optional
└ org object optional
└ data object required
└ meta object optional
└ links object required

Responses

201

A new organization invitation has been created
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/invites
DELETE /orgs/{org_id}/invites/{invite_id}

Cancel a pending user invitations to an organization.

operationId: Invites_cancelPendingInvitation

Parameters

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
version query optional

The requested version of the endpoint to process the request

Responses

204

The operation completed successfully with no content
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
DELETE /orgs/{org_id}/invites/{invite_id}

Issues 5 endpoints

GET /groups/{group_id}/issues

Get a list of a group’s issues.

operationId: Issues_byGroupId

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page
group_id path optional string

Group ID
scan_item.id query optional string

A scan item id to filter issues through their scan item relationship.
scan_item.type query optional

A scan item types to filter issues through their scan item relationship.
type query optional

An issue type to filter issues.
updated_before query optional string

A filter to select issues updated before this date.
updated_after query optional string

A filter to select issues updated after this date.
created_before query optional string

A filter to select issues created before this date.
created_after query optional string

A filter to select issues created after this date.
effective_severity_level query optional array

One or more effective severity levels to filter issues.
status query optional array

An issue’s status
ignored query optional boolean

Whether an issue is ignored or not.

Responses

200

Returns a collection of issues.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Unauthorized: the request requires an authentication token or a token with more permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /groups/{group_id}/issues
GET /groups/{group_id}/issues/{issue_id}

Get an issue

operationId: Issues_getByIssueId

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
group_id path optional string

Group ID
issue_id path optional string

Issue ID

Responses

200

Returns an instance of an issue
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Unauthorized: the request requires an authentication token or a token with more permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /groups/{group_id}/issues/{issue_id}
GET /orgs/{org_id}/issues

Get a list of an organization’s issues.

operationId: Issues_listByOrgId

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
starting_after query optional string

Return the page of results immediately after this cursor
ending_before query optional string

Return the page of results immediately before this cursor
limit query optional integer

Number of results to return per page
org_id path required string

Org ID
scan_item.id query optional string

A scan item id to filter issues through their scan item relationship.
scan_item.type query optional

A scan item types to filter issues through their scan item relationship.
type query optional

An issue type to filter issues.
updated_before query optional string

A filter to select issues updated before this date.
updated_after query optional string

A filter to select issues updated after this date.
created_before query optional string

A filter to select issues created before this date.
created_after query optional string

A filter to select issues created after this date.
effective_severity_level query optional array

One or more effective severity levels to filter issues.
status query optional array

An issue’s status
ignored query optional boolean

Whether an issue is ignored or not.

Responses

200

Returns a collection of issues.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Unauthorized: the request requires an authentication token or a token with more permissions.
404

Not Found: The resource being operated on could not be found.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/issues
GET /orgs/{org_id}/issues/{issue_id}

Get an issue

operationId: Issues_getById

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Org ID
issue_id path optional string

Issue ID

Responses

200

Returns an instance of an issue
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token or a token with more permissions.
403

Unauthorized: the request requires an authentication token or a token with more permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
GET /orgs/{org_id}/issues/{issue_id}
POST /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.

operationId: Issues_queryForPackages

Parameters

Name In Required Type Description
version query optional

The requested version of the endpoint to process the request
org_id path required string

Unique identifier for an organization

Request Body

required
application/vnd.api+json
schema BulkPackageUrlsRequestBody
Property Type Required
data object required
└ type string optional
└ attributes object required
└ purls array required

Responses

200

Returns an array of issues with the purl identifier of the package that caused them
400

Bad Request: A parameter provided as a part of the request was invalid.
401

Unauthorized: the request requires an authentication token.
403

Forbidden: the request requires an authentication token with more or different permissions.
404

Not Found: The resource being operated on could not be found.
409

Conflict: The requested operation conflicts with the current state of the resource in some way.
500

Internal Server Error: An error was encountered while attempting to process the request.
POST /orgs/{org_id}/packages/issues
Load more endpoints

Schemas

number 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."
}
string 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"
}
object 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"
            }
          }
        }
      }
    }
  }
}
object AppData 
{
  "type": "object",
  "required": [
    "type",
    "id",
    "attributes"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "type": {
      "$ref": "#/components/schemas/Type"
    },
    "attributes": {
      "$ref": "#/components/schemas/AppResourceAttributes"
    }
  }
}
object AppDataWithSecret 
{
  "type": "object",
  "required": [
    "type",
    "id",
    "attributes"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "type": {
      "$ref": "#/components/schemas/Type"
    },
    "attributes": {
      "$ref": "#/components/schemas/AppResourceAttributesWithSecret"
    }
  }
}
object 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"
            }
          }
        }
      }
    }
  }
}
object 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"
            }
          }
        }
      }
    }
  }
}
object 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"
                }
              }
            }
          }
        }
      }
    }
  }
}
string AppName 
{
  "type": "string",
  "example": "My App",
  "minLength": 1,
  "description": "New name of the app to display to users during authorization flow."
}
object 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
        }
      }
    }
  }
}
object 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"
            }
          }
        }
      }
    }
  }
}
object AppPostResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/AppDataWithSecret"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object 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"
    }
  }
}
object 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"
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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"
            }
          }
        }
      }
    }
  }
}
object AppsCreateInstallSecretResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/AppInstallDataWithSecret"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
object 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."
        }
      }
    }
  }
}
Load more schemas

Versions

Version Endpoints Schemas Ingested Status
REST 96 446 2026-05-11 current
REST 96 446 2026-04-16