Snyk API

Security platform for developers

docs.snyk.io/snyk-api ↗

Version

REST

OpenAPI

3.0.3

Endpoints

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

Clear filters

GET POST PUT PATCH DELETE

Apps 7 endpoints

GET /groups/{group_id}/apps/installs Get a list of apps installed for a group.

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

GET /orgs/{org_id}/apps/creations Get a list of apps created by an organization.

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

GET /orgs/{org_id}/apps/creations/{app_id} Get a Snyk App by its 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}

GET /orgs/{org_id}/apps/installs Get a list of apps installed for an organization.

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

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

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.

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

GET /self/apps/{app_id}/sessions Get a list of active OAuth sessions for the app.

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

Auditlogs 2 endpoints

GET /groups/{group_id}/audit_logs/search Search Group audit logs.

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 Organization audit logs.

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 3 endpoints

GET /orgs/{org_id}/collections Get 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

GET /orgs/{org_id}/collections/{collection_id} Get a collection

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}

GET /orgs/{org_id}/collections/{collection_id}/relationships/projects Get projects from the specified collection

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

Containerimage 3 endpoints

GET /orgs/{org_id}/container_images List instances of container image

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

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

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 2 endpoints

GET /custom_base_images Get a custom base image collection

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

GET /custom_base_images/{custombaseimage_id} Get a custom base image

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}

Iacsettings 2 endpoints

GET /groups/{group_id}/settings/iac Get the Infrastructure as Code Settings for a group

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

GET /orgs/{org_id}/settings/iac Get the Infrastructure as Code Settings for an org.

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

Invites 1 endpoints

GET /orgs/{org_id}/invites List pending user invitations to an organization.

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

Issues 5 endpoints

GET /groups/{group_id}/issues Get issues by group ID

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

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 issues by org ID

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

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}

GET /orgs/{org_id}/packages/{purl}/issues List issues for a package

Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.

operationId: Issues_listByPackage

Parameters

Name	In	Required	Type	Description
version	query	optional		The requested version of the endpoint to process the request
purl	path	optional	string	A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required.
org_id	path	required	string	Unique identifier for an organization
offset	query	optional	number	Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0.
limit	query	optional	number	Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000.

Responses

200

Returns an array of issues

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}/packages/{purl}/issues

Openapi 2 endpoints

GET /openapi

List available versions of OpenAPI specification

operationId: OpenApi_listAvailableVersions

Responses

200

List of available versions is returned

400

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

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.

GET /openapi

GET /openapi/{version}

Get OpenAPI specification effective at version.

operationId: OpenApi_getEffectiveVersion

Parameters

Name	In	Required	Type	Description
version	path	required	string	The requested version of the API

Responses

200

OpenAPI specification matching requested version is returned

400

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

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.

GET /openapi/{version}

Orgs 3 endpoints

GET /orgs List accessible organizations

Get a paginated list of organizations you have access to.

operationId: Orgs_listAccessibleOrganizations

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	query	optional	string	If set, only return organizations within the specified group
is_personal	query	optional	boolean	If true, only return organizations that are not part of a group.
slug	query	optional	string	Only return orgs whose slug exactly matches this value.
name	query	optional	string	Only return orgs whose name contains this value.
expand	query	optional	array	Expand the specified related resources in the response to include their attributes.

Responses

200

A list of organizations you have access to.

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

GET /orgs/{org_id} Get organization

Get the full details of an organization.

operationId: Orgs_getDetails

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 org

Responses

200

Returns an instance of 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.

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}

GET /groups/{group_id}/orgs List all organizations in group

Get a paginated list of all the organizations belonging to the group.
By default, this endpoint returns the organizations in alphabetical order of their name.

operationId: Orgs_listGroupOrgs

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	Unique identifier for group
name	query	optional	string	Only return organizations whose name contains this value. Case insensitive.
slug	query	optional	string	Only return organizations whose slug exactly matches this value. Case sensitive.

Responses

200

A list of organizations in 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}/orgs

Projects 2 endpoints

GET /orgs/{org_id}/projects List all Projects for an Org with the given Org ID.

List all Projects for an Org.

operationId: Projects_listForOrg

Parameters

Name	In	Required	Type	Description
org_id	path	required	string	The ID of the org that the projects belong to.
target_id	query	optional	array	Return projects that belong to the provided targets
target_reference	query	optional	string	Return projects that match the provided target reference
target_file	query	optional	string	Return projects that match the provided target file
target_runtime	query	optional	string	Return projects that match the provided target runtime
meta_count	query	optional	string	The collection count.
ids	query	optional	array	Return projects that match the provided IDs.
names	query	optional	array	Return projects that match the provided names.
names_start_with	query	optional	array	Return projects with names starting with the specified prefix.
origins	query	optional	array	Return projects that match the provided origins.
types	query	optional	array	Return projects that match the provided types.
expand	query	optional	array	Expand relationships.
meta.latest_issue_counts	query	optional	boolean	Include a summary count for the issues found in the most recent scan of this project
meta.latest_dependency_total	query	optional	boolean	Include the total number of dependencies found in the most recent scan of this project
cli_monitored_before	query	optional	string	Filter projects uploaded and monitored before this date (encoded value)
cli_monitored_after	query	optional	string	Filter projects uploaded and monitored after this date (encoded value)
importing_user_public_id	query	optional	array	Return projects that match the provided importing user public ids.
tags	query	optional	array	Return projects that match all the provided tags
business_criticality	query	optional	array	Return projects that match all the provided business_criticality value
environment	query	optional	array	Return projects that match all the provided environment values
lifecycle	query	optional	array	Return projects that match all the provided lifecycle values
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 projects is returned for the targeted 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}/projects

GET /orgs/{org_id}/projects/{project_id} Get project by project ID.

Get one project of the organization by project ID.

operationId: Projects_getByProjectId

Parameters

Name	In	Required	Type	Description
org_id	path	required	string	The ID of the org to which the project belongs to.
project_id	path	required	string	The ID of the project.
expand	query	optional	array	Expand relationships.
meta.latest_issue_counts	query	optional	boolean	Include a summary count for the issues found in the most recent scan of this project
meta.latest_dependency_total	query	optional	boolean	Include the total number of dependencies found in the most recent scan of this project
version	query	optional		The requested version of the endpoint to process the request

Responses

200

A project is returned for the targeted 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}/projects/{project_id}

Sbom 1 endpoints

GET /orgs/{org_id}/projects/{project_id}/sbom Get a project’s SBOM document

This endpoint lets you retrieve the SBOM document of a software project.
It supports the following formats:

CycloneDX version 1.4 in JSON (set format to cyclonedx1.4+json).
CycloneDX version 1.4 in XML (set format to cyclonedx1.4+xml).
SPDX version 2.3 in JSON (set format to spdx2.3+json).

By default it will respond with an empty JSON:API response.

operationId: Sbom_getProjectDocument

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
project_id	path	optional	string	Unique identifier for a project
format	query	optional	string	The desired SBOM format of the response.

Responses

200

Returns the SBOM document of a project

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}/projects/{project_id}/sbom

Sastsettings 1 endpoints

GET /orgs/{org_id}/settings/sast Retrieves the SAST settings for an org

Retrieves the SAST settings for an org

operationId: SastSettings_getForOrg

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 for which we want to retrieve the SAST settings

Responses

200

The SAST settings for the org are being retrieved

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/sast

Serviceaccounts 4 endpoints

GET /groups/{group_id}/service_accounts Get a list of group service accounts.

Get all service accounts for a group.

operationId: ServiceAccounts_listGroupServiceAccounts

Parameters

Name	In	Required	Type	Description
group_id	path	required	string	The ID of the Snyk Group that owns the service accounts.
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
version	query	optional		The requested version of the endpoint to process the request

Responses

200

A list of service accounts is returned.

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}/service_accounts

GET /groups/{group_id}/service_accounts/{serviceaccount_id} Get a group service account.

Get a group-level service account by its ID.

operationId: ServiceAccounts_getGroupServiceAccount

Parameters

Name	In	Required	Type	Description
group_id	path	required	string	The ID of the Snyk Group that owns the service account.
serviceaccount_id	path	required	string	The ID of the service account.
version	query	optional		The requested version of the endpoint to process the request

Responses

200

Service account is returned.

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}/service_accounts/{serviceaccount_id}

GET /orgs/{org_id}/service_accounts Get a list of organization service accounts.

Get all service accounts for an organization.

operationId: ServiceAccounts_listOrganizationServiceAccounts

Parameters

Name	In	Required	Type	Description
org_id	path	required	string	The ID of the Snyk Organization that owns the service accounts.
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
version	query	optional		The requested version of the endpoint to process the request

Responses

200

A list of service accounts is returned.

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}/service_accounts

GET /orgs/{org_id}/service_accounts/{serviceaccount_id} Get an organization service account.

Get an organization-level service account by its ID.

operationId: ServiceAccounts_getOrganizationAccountById

Parameters

Name	In	Required	Type	Description
org_id	path	required	string	The ID of the Snyk Organization that owns the service account.
serviceaccount_id	path	required	string	The ID of the service account.
version	query	optional		The requested version of the endpoint to process the request

Responses

200

Service account is returned.

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}/service_accounts/{serviceaccount_id}

Slack 2 endpoints

GET /orgs/{org_id}/slack_app/{tenant_id}/channels Get a list of Slack channels

Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can access. Note that it is currently only possible to page forwards through this collection, no prev links will be generated and the ending_before parameter will not function.

operationId: Slack_getChannels

Parameters

Name	In	Required	Type	Description
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
version	query	optional		The requested version of the endpoint to process the request
org_id	path	required	string	Org ID
tenant_id	path	optional	string	Tenant ID

Responses

200

List of Slack channels

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}/slack_app/{tenant_id}/channels

GET /orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id} Get Slack Channel name by Slack Channel ID.

Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.

operationId: Slack_getChannelNameById

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
channel_id	path	optional	string	Slack Channel ID
tenant_id	path	optional	string	Tenant ID

Responses

200

List of Slack channels

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}/slack_app/{tenant_id}/channels/{channel_id}

Slacksettings 2 endpoints

GET /orgs/{org_id}/slack_app/{bot_id} Get Slack integration default notification settings.

Get Slack integration default notification settings for the provided tenant ID and bot ID.

operationId: SlackSettings_getDefaultNotificationSettings

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
bot_id	path	optional		Bot ID

Responses

200

Default settings created 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.

GET /orgs/{org_id}/slack_app/{bot_id}

GET /orgs/{org_id}/slack_app/{bot_id}/projects Slack notification settings overrides for projects

Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.

operationId: SlackSettings_getOverridesForProjects

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
bot_id	path	optional		Bot ID

Responses

200

Return default settings for a tenant

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}/slack_app/{bot_id}/projects

Targets 2 endpoints

GET /orgs/{org_id}/targets Get targets by org ID

Get a list of an organization’s targets.

operationId: Targets_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
count	query	optional	boolean	Calculate total amount of filtered results
limit	query	optional	integer	Number of results to return per page
org_id	path	required	string	The id of the org to return a list of targets
is_private	query	optional	boolean	Return targets that match the provided value of is_private
exclude_empty	query	optional	boolean	Return only the targets that has projects
url	query	optional	string	Return targets that match the provided remote_url.
source_types	query	optional	array	Return targets that match the provided source_types
display_name	query	optional	string	Return targets with display names starting with the provided string
created_gte	query	optional	string	Return only targets which have been created at or after the specified date.

Responses

200

A list of targets is returned for the targeted 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}/targets

GET /orgs/{org_id}/targets/{target_id} Get target by target ID

Get a specified target for an organization.

operationId: Targets_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	The id of the org to return the target from
target_id	path	required	string	The id of the target to return

Responses

200

A single target is returned if it is found in the specified org

400

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

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.

GET /orgs/{org_id}/targets/{target_id}

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