@itentialopensource/adapter-terraform_enterprise
Version:
This adapter integrates with system described as: terraform Enterprise.
1,791 lines (1,790 loc) • 114 kB
JSON
{
"openapi": "3.0.0",
"info": {
"title": "Terraform",
"description": "Terraform Cloud is an application that helps teams use Terraform together. It manages Terraform runs in a consistent and reliable environment, and includes easy access to shared state and secret data, access controls for approving changes to infrastructure, a private registry for sharing Terraform modules, detailed policy controls for governing the contents of Terraform configurations, and more.\n\nTerraform Cloud is available as a hosted service at https://app.terraform.io. We offer free accounts for small teams, and paid plans with additional feature sets for medium-sized businesses.\n\nLarge enterprises can purchase Terraform Enterprise, our self-hosted distribution of Terraform Cloud. It offers enterprises a private instance of the Terraform Cloud application, with no resource limits and with additional enterprise-grade architectural features like audit logging and SAML single sign-on.",
"contact": {
"email": "apiteam@swagger.io"
},
"version": "v2"
},
"servers": [
{
"url": "https://app.terraform.io/api",
"variables": {}
},
{
"url": "http://app.terraform.io/api",
"variables": {}
}
],
"paths": {
"/account/details": {
"get": {
"tags": [
"Account"
],
"summary": "GET",
"description": "Get account details.",
"operationId": "GET",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/account/update": {
"patch": {
"tags": [
"Account"
],
"summary": "updateAccount",
"description": "Update account details",
"operationId": "updateAccount",
"parameters": [],
"requestBody": {
"description": "JSON body for update",
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "JSON body for update"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/account/password": {
"patch": {
"tags": [
"Account"
],
"summary": "changePassword",
"description": "Change your password",
"operationId": "changePassword",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/applies/{id}": {
"get": {
"tags": [
"Applies"
],
"summary": "getApply",
"description": "Show an apply",
"operationId": "getApply",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the apply to show.",
"required": true,
"style": "simple",
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/cost-estimates/{id}": {
"get": {
"tags": [
"CostEstimates"
],
"summary": "getCostEstimate",
"description": "Show a cost estimate",
"operationId": "getCostEstimate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the cost estimate to show..",
"required": true,
"style": "simple",
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/workspaces/{workspace_id}/notification-configurations": {
"post": {
"tags": [
"NotificationConfigurations"
],
"summary": "createNotificationConfiguration",
"description": "Create a Notification Configuration",
"operationId": "createNotificationConfiguration",
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"get": {
"tags": [
"NotificationConfigurations"
],
"summary": "listNotificationConfigurations",
"description": "List all notification configurations",
"operationId": "listNotificationConfigurations",
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "The ID of the workspace to list configurations from. Obtain this from the workspace settings or the Show Workspace endpoint.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/notification-configurations/{notification-configuration-id}": {
"get": {
"tags": [
"NotificationConfigurations"
],
"summary": "getNotificationConfiguration",
"description": "Get details for a notification configuration",
"operationId": "getNotificationConfiguration",
"parameters": [
{
"name": "notification-configuration-id",
"in": "path",
"description": "The id of the notification configuration to show.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"patch": {
"tags": [
"NotificationConfigurations"
],
"summary": "updateNotificationConfiguration",
"description": "Update a notification configuration",
"operationId": "updateNotificationConfiguration",
"parameters": [
{
"name": "notification-configuration-id",
"in": "path",
"description": "The id of the notification configuration to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"delete": {
"tags": [
"NotificationConfigurations"
],
"summary": "deleteNotificationConfiguration",
"description": "This endpoint deletes a notification configuration.",
"operationId": "deleteNotificationConfiguration",
"parameters": [
{
"name": "notification-configuration-id",
"in": "path",
"description": "The id of the notification configuration to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/notification-configurations/{notification-configuration-id}/actions/verify": {
"post": {
"tags": [
"NotificationConfigurations"
],
"summary": "verifyNotificationConfiguration",
"description": "This will cause Terraform Cloud to send a verification request for the specified configuration. If a response is received, it will be stored and returned in the delivery-responses attribute. More details in the Notification Verification and Delivery Responses section above.",
"operationId": "verifyNotificationConfiguration",
"parameters": [
{
"name": "notification-configuration-id",
"in": "path",
"description": "The id of the notification configuration to verify.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organizations/{organization_name}/oauth-clients": {
"get": {
"tags": [
"OAuthClients"
],
"summary": "listOauthClients",
"description": "This endpoint allows you to list VCS connections between an organization and a VCS provider (GitHub, Bitbucket, or GitLab) for use when creating or setting up workspaces.",
"operationId": "listOauthClients",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The name of the organization.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"post": {
"tags": [
"OAuthClients"
],
"summary": "createOAuthClient",
"description": "Create an OAuth Client",
"operationId": "createOAuthClient",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The name of the organization that will be connected to the VCS provider. The organization must already exist in the system, and the user must have permissions to initiate the connection.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/oauth-clients/{id}": {
"get": {
"tags": [
"OAuthClients"
],
"summary": "showOAuthClient",
"description": "Show an OAuth Client",
"operationId": "showOAuthClient",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the OAuth Client to show",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"patch": {
"tags": [
"OAuthClients"
],
"summary": "updateOAuthClient",
"description": "Update an OAuth Client",
"operationId": "updateOAuthClient",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the OAuth Client to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"delete": {
"tags": [
"OAuthClients"
],
"summary": "destroyOAuthClient",
"description": "Destroy an OAuth Client",
"operationId": "destroyOAuthClient",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the OAuth Client to destroy",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/oauth-clients/{oauth_client_id}/oauth-tokens": {
"get": {
"tags": [
"OAuthTokens"
],
"summary": "listOAuthTokens",
"description": "List all the OAuth Tokens for a given OAuth Client",
"operationId": "listOAuthTokens",
"parameters": [
{
"name": "oauth_client_id",
"in": "path",
"description": "The ID of the OAuth Client",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/oauth-tokens/{id}": {
"get": {
"tags": [
"OAuthTokens"
],
"summary": "showOAuthToken",
"description": "Show an OAuth Token",
"operationId": "showOAuthToken",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the OAuth token to show",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"patch": {
"tags": [
"OAuthTokens"
],
"summary": "updateOAuthToken",
"description": "Update an OAuth Token",
"operationId": "updateOAuthToken",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the OAuth token to update",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"delete": {
"tags": [
"OAuthTokens"
],
"summary": "destroyOAuthToken",
"description": "Destroy an OAuth Token",
"operationId": "destroyOAuthToken",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the OAuth Token to destroy",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organizations": {
"get": {
"tags": [
"Organizations"
],
"summary": "listOrganizations",
"description": "List the organizations",
"operationId": "listOrganizations",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organizations/{organization_name}": {
"get": {
"tags": [
"Organizations"
],
"summary": "getOrganization",
"description": "Get an organization",
"operationId": "getOrganization",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The name of the organization to show",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organizations/{organization_name}/organization-memberships": {
"post": {
"tags": [
"OrganizationMemberships"
],
"summary": "InviteUserToOrganization",
"description": "Invite a User to an Organization",
"operationId": "InviteUserToOrganization",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The name of the organization the user will be invited to join. The inviting user must have permission to manage organization memberships",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"get": {
"tags": [
"OrganizationMemberships"
],
"summary": "listMembershipsOrganization",
"description": "List Memberships for an Organization",
"operationId": "listMembershipsOrganization",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The name of the organization to list the memberships of.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "q",
"in": "query",
"description": "Optional. A search query string. Organization memberships are searchable by user name and email.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"description": "Optional. If specified, restricts results to those with the matching status value. Valid values are invited and active.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"description": "Optional. If omitted, the endpoint will return the first page.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "page[size]",
"in": "query",
"description": "Optional. If omitted, the endpoint will return 20 users per page.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organization-memberships": {
"get": {
"tags": [
"OrganizationMemberships"
],
"summary": "listUserOwnMemberships",
"description": "List User's Own Memberships",
"operationId": "listUserOwnMemberships",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organization-memberships/{organization_membership_id}": {
"get": {
"tags": [
"OrganizationMemberships"
],
"summary": "showMembership",
"description": "Show a Membership",
"operationId": "showMembership",
"parameters": [
{
"name": "organization_membership_id",
"in": "path",
"description": "The organization membership",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"delete": {
"tags": [
"OrganizationMemberships"
],
"summary": "removeUserFromOrganization",
"description": "Remove User from Organization",
"operationId": "removeUserFromOrganization",
"parameters": [
{
"name": "organization_membership_id",
"in": "path",
"description": "The organization membership",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organizations/{organization_name}/authentication-token": {
"post": {
"tags": [
"OrganizationToken"
],
"summary": "generateOrganizationToken",
"description": "Generate a new organization token",
"operationId": "generateOrganizationToken",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The name of the organization to generate a token for.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"delete": {
"tags": [
"OrganizationToken"
],
"summary": "deleteOrganizationToken",
"description": "Delete the organization token",
"operationId": "deleteOrganizationToken",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "Which organization's token should be deleted.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/plan-exports": {
"post": {
"tags": [
"PlanExports"
],
"summary": "createPlanExport",
"description": "This endpoint exports data from a plan in the specified format. The export process is asynchronous, and the resulting data becomes downloadable when its status is \"finished\". The data is then available for one hour before expiring. After the hour is up, a new export can be created.",
"operationId": "createPlanExport",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/plan-exports/{id}": {
"get": {
"tags": [
"PlanExports"
],
"summary": "showPlanExport",
"description": "Show a plan export",
"operationId": "showPlanExport",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the plan export to show.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"delete": {
"tags": [
"PlanExports"
],
"summary": "Delete exported plan data",
"description": "Plan exports expire after being available for one hour, but they can be deleted manually as well.",
"operationId": "Deleteexportedplandata",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the plan export",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/plan-exports/{id}/download": {
"get": {
"tags": [
"PlanExports"
],
"summary": "downloadPlanExport",
"description": "This endpoint generates a temporary URL to the location of the exported plan data in a .tar.gz archive, and then redirects to that link. If using a client that can follow redirects, you can use this endpoint to save the .tar.gz archive locally without needing to save the temporary URL.",
"operationId": "downloadPlanExport",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the plan export.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/plans/{id}": {
"get": {
"tags": [
"Plans"
],
"summary": "showPlan",
"description": "Show a plan",
"operationId": "showPlan",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the plan to show",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organizations/{organization_name}/policies": {
"post": {
"tags": [
"Policies"
],
"summary": "createPolicy",
"description": "Create a Policy",
"operationId": "createPolicy",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The organization to create the policy in. The organization must already exist in the system, and the token authenticating the API request must belong to the \"owners\" team or a member of the \"owners\" team.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"get": {
"tags": [
"Policies"
],
"summary": "listPolicies",
"description": "List Policies",
"operationId": "listPolicies",
"parameters": [
{
"name": "organization_name",
"in": "path",
"description": "The organization to list policies for.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"description": "Optional. If omitted, the endpoint will return the first page.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "page[size]",
"in": "query",
"description": "Optional. If omitted, the endpoint will return 20 policies per page.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "search[name]",
"in": "query",
"description": "Optional. Allows searching the organization's policies by name.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/policies/{policy_id}": {
"get": {
"tags": [
"Policies"
],
"summary": "showPolicy",
"description": "Show a Policy",
"operationId": "showPolicy",
"parameters": [
{
"name": "policy_id",
"in": "path",
"description": "The ID of the policy to show. Use the \"List Policies\" endpoint to find IDs.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"patch": {
"tags": [
"Policies"
],
"summary": "updatePolicy",
"description": "This endpoint can update the enforcement mode of an existing policy. To update the policy code itself, use the upload endpoint.",
"operationId": "updatePolicy",
"parameters": [
{
"name": "policy_id",
"in": "path",
"description": "The ID of the policy to update. Use the \"List Policies\" endpoint to find IDs.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
},
"delete": {
"tags": [
"Policies"
],
"summary": "deletePolicy",
"description": "Delete a Policy",
"operationId": "deletePolicy",
"parameters": [
{
"name": "policy_id",
"in": "path",
"description": "The ID of the policy to delete. Use the \"List Policies\" endpoint to find IDs.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/policies/{policy_id}/upload": {
"put": {
"tags": [
"Policies"
],
"summary": "uploadPolicy",
"description": "Upload a Policy",
"operationId": "uploadPolicy",
"parameters": [
{
"name": "policy_id",
"in": "path",
"description": "The ID of the policy to upload code to. Use the \"List Policies\" endpoint (or the response to a \"Create Policy\" request) to find IDs.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/runs/{run_id}/policy-checks": {
"get": {
"tags": [
"PolicyChecks"
],
"summary": "listPolicyChecks",
"description": "This endpoint lists the policy checks in a run.",
"operationId": "listPolicyChecks",
"parameters": [
{
"name": "run_id",
"in": "path",
"description": "specifies the run ID for which to list policy checks",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/policy-checks/{policy_check_id}/actions/override": {
"post": {
"tags": [
"PolicyChecks"
],
"summary": "overridePolicy",
"description": "This endpoint overrides a soft-mandatory or warning policy.",
"operationId": "overridePolicy",
"parameters": [
{
"name": "policy_check_id",
"in": "path",
"description": "specifies the ID for the policy check to override",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "successful operation"
}
}
}
},
"400": {
"description": "failed operation"
}
},
"deprecated": false
}
},
"/organizations/{organization_name}/policy-sets": {
"post": {
"tags": [
"PolicySets"