{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/account/details": { "get": { "tags": [ "Account" ], "operationId": "get", "description": "The parameters and request body are for method: get. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/update": { "patch": { "tags": [ "Account" ], "operationId": "updateAccount", "description": "The parameters and request body are for method: updateAccount. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/account/password": { "patch": { "tags": [ "Account" ], "operationId": "changePassword", "description": "The parameters and request body are for method: changePassword. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/runs": { "post": { "tags": [ "Runs" ], "operationId": "createRun", "description": "The parameters and request body are for method: createRun. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/runs/{runId}/actions/apply": { "post": { "tags": [ "Runs" ], "operationId": "applyRun", "description": "The parameters and request body are for method: applyRun. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "title": "runId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/workspaces/{workspaceId}/runs": { "get": { "tags": [ "Runs" ], "operationId": "listRuns", "description": "The parameters and request body are for method: listRuns. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/runs/{runId}": { "get": { "tags": [ "Runs" ], "operationId": "getRunDetails", "description": "The parameters and request body are for method: getRunDetails. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "title": "runId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/runs/{runId}/actions/discard": { "post": { "tags": [ "Runs" ], "operationId": "discardRun", "description": "The parameters and request body are for method: discardRun. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "title": "runId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/runs/{runId}/actions/cancel": { "post": { "tags": [ "Runs" ], "operationId": "cancelRun", "description": "The parameters and request body are for method: cancelRun. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "title": "runId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/runs/{runId}/actions/force-cancel": { "post": { "tags": [ "Runs" ], "operationId": "forceCancel", "description": "The parameters and request body are for method: forceCancel. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "title": "runId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/runs/{runId}/actions/force-execute": { "get": { "tags": [ "Runs" ], "operationId": "forceExecute", "description": "The parameters and request body are for method: forceExecute. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "title": "runId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/applies/{id}": { "get": { "tags": [ "Applies" ], "operationId": "getApply", "description": "The parameters and request body are for method: getApply. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/cost-estimates/{id}": { "get": { "tags": [ "CostEstimates" ], "operationId": "getCostEstimate", "description": "The parameters and request body are for method: getCostEstimate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{}/notification-configurations": { "post": { "tags": [ "NotificationConfigurations" ], "operationId": "createNotificationConfiguration", "description": "The parameters and request body are for method: createNotificationConfiguration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/workspaces/{workspaceId}/notification-configurations": { "get": { "tags": [ "NotificationConfigurations" ], "operationId": "listNotificationConfigurations", "description": "The parameters and request body are for method: listNotificationConfigurations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/notification-configurations/{notificationConfigurationId}": { "get": { "tags": [ "NotificationConfigurations" ], "operationId": "getNotificationConfiguration", "description": "The parameters and request body are for method: getNotificationConfiguration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "notificationConfigurationId", "in": "path", "required": true, "schema": { "title": "notificationConfigurationId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "NotificationConfigurations" ], "operationId": "updateNotificationConfiguration", "description": "The parameters and request body are for method: updateNotificationConfiguration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "notificationConfigurationId", "in": "path", "required": true, "schema": { "title": "notificationConfigurationId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "NotificationConfigurations" ], "operationId": "deleteNotificationConfiguration", "description": "The parameters and request body are for method: deleteNotificationConfiguration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "notificationConfigurationId", "in": "path", "required": true, "schema": { "title": "notificationConfigurationId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/notification-configurations/{notificationConfigurationId}/actions/verify": { "post": { "tags": [ "NotificationConfigurations" ], "operationId": "verifyNotificationConfiguration", "description": "The parameters and request body are for method: verifyNotificationConfiguration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "notificationConfigurationId", "in": "path", "required": true, "schema": { "title": "notificationConfigurationId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations": { "get": { "tags": [ "Organizations" ], "operationId": "listOrganizations", "description": "The parameters and request body are for method: listOrganizations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations/{organizationName}": { "get": { "tags": [ "Organizations" ], "operationId": "getOrganization", "description": "The parameters and request body are for method: getOrganization. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations/{organizationName}/organization-memberships": { "post": { "tags": [ "OrganizationMemberships" ], "operationId": "inviteUserToOrganization", "description": "The parameters and request body are for method: inviteUserToOrganization. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "OrganizationMemberships" ], "operationId": "listMembershipsOrganization", "description": "The parameters and request body are for method: listMembershipsOrganization. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filterStatus", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organization-memberships": { "get": { "tags": [ "OrganizationMemberships" ], "operationId": "listUserOwnMemberships", "description": "The parameters and request body are for method: listUserOwnMemberships. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organization-memberships/{organizationMembershipId}": { "get": { "tags": [ "OrganizationMemberships" ], "operationId": "showMembership", "description": "The parameters and request body are for method: showMembership. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationMembershipId", "in": "path", "required": true, "schema": { "title": "organizationMembershipId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "OrganizationMemberships" ], "operationId": "removeUserFromOrganization", "description": "The parameters and request body are for method: removeUserFromOrganization. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationMembershipId", "in": "path", "required": true, "schema": { "title": "organizationMembershipId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/plans/{id}": { "get": { "tags": [ "Plans" ], "operationId": "showPlan", "description": "The parameters and request body are for method: showPlan. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations/{organizationName}/policies": { "post": { "tags": [ "Policies" ], "operationId": "createPolicy", "description": "The parameters and request body are for method: createPolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "Policies" ], "operationId": "listPolicies", "description": "The parameters and request body are for method: listPolicies. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "searchName", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policies/{policyId}": { "get": { "tags": [ "Policies" ], "operationId": "showPolicy", "description": "The parameters and request body are for method: showPolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Policies" ], "operationId": "updatePolicy", "description": "The parameters and request body are for method: updatePolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Policies" ], "operationId": "deletePolicy", "description": "The parameters and request body are for method: deletePolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policies/{policyId}/upload": { "put": { "tags": [ "Policies" ], "operationId": "uploadPolicy", "description": "The parameters and request body are for method: uploadPolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/runs/{runId}/policy-checks": { "get": { "tags": [ "PolicyChecks" ], "operationId": "listPolicyChecks", "description": "The parameters and request body are for method: listPolicyChecks. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "title": "runId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-checks/{policyCheckId}/actions/override": { "post": { "tags": [ "PolicyChecks" ], "operationId": "overridePolicy", "description": "The parameters and request body are for method: overridePolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policyCheckId", "in": "path", "required": true, "schema": { "title": "policyCheckId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations/{organizationName}/policy-sets": { "post": { "tags": [ "PolicySets" ], "operationId": "createPolicySet", "description": "The parameters and request body are for method: createPolicySet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "PolicySets" ], "operationId": "listPolicySets", "description": "The parameters and request body are for method: listPolicySets. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-sets/{id}": { "get": { "tags": [ "PolicySets" ], "operationId": "showPolicySet", "description": "The parameters and request body are for method: showPolicySet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "PolicySets" ], "operationId": "updatePolicySet", "description": "The parameters and request body are for method: updatePolicySet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "PolicySets" ], "operationId": "deletePolicySet", "description": "The parameters and request body are for method: deletePolicySet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-sets/{id}/relationships/policies": { "post": { "tags": [ "PolicySets" ], "operationId": "addPoliciesToPolicySet", "description": "The parameters and request body are for method: addPoliciesToPolicySet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "PolicySets" ], "operationId": "removePoliciesFromThePolicySet", "description": "The parameters and request body are for method: removePoliciesFromThePolicySet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-sets/{id}/relationships/workspaces": { "post": { "tags": [ "PolicySets" ], "operationId": "attachPolicySetToWorkspaces", "description": "The parameters and request body are for method: attachPolicySetToWorkspaces. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "PolicySets" ], "operationId": "detachthePolicySetFromWorkspaces", "description": "The parameters and request body are for method: detachthePolicySetFromWorkspaces. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-sets/{id}/versions": { "post": { "tags": [ "PolicySets" ], "operationId": "createPolicySetVersion", "description": "The parameters and request body are for method: createPolicySetVersion. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-set-versions/{id}": { "get": { "tags": [ "PolicySets" ], "operationId": "showPolicySetVersion", "description": "The parameters and request body are for method: showPolicySetVersion. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-sets/{policySetId}/parameters": { "post": { "tags": [ "PolicySetParameters" ], "operationId": "createParameter", "description": "The parameters and request body are for method: createParameter. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policySetId", "in": "path", "required": true, "schema": { "title": "policySetId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "PolicySetParameters" ], "operationId": "listParameters", "description": "The parameters and request body are for method: listParameters. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policySetId", "in": "path", "required": true, "schema": { "title": "policySetId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/policy-sets/{policySetId}/parameters/{parameterId}": { "patch": { "tags": [ "PolicySetParameters" ], "operationId": "updateParameters", "description": "The parameters and request body are for method: updateParameters. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policySetId", "in": "path", "required": true, "schema": { "title": "policySetId", "type": "string" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "title": "parameterId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "PolicySetParameters" ], "operationId": "deleteParameters", "description": "The parameters and request body are for method: deleteParameters. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "policySetId", "in": "path", "required": true, "schema": { "title": "policySetId", "type": "string" } }, { "name": "parameterId", "in": "path", "required": true, "schema": { "title": "parameterId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}/state-versions": { "post": { "tags": [ "StateVersions" ], "operationId": "createStateVersion", "description": "The parameters and request body are for method: createStateVersion. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/state-versions": { "get": { "tags": [ "StateVersions" ], "operationId": "listStateVersions", "description": "The parameters and request body are for method: listStateVersions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filterWorkspaceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filterOrganizationName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}/current-state-version": { "get": { "tags": [ "StateVersions" ], "operationId": "fetchCurrentStateVersionForWorkspace", "description": "The parameters and request body are for method: fetchCurrentStateVersionForWorkspace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/state-versions/{stateVersionId}": { "get": { "tags": [ "StateVersions" ], "operationId": "showStateVersion", "description": "The parameters and request body are for method: showStateVersion. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "stateVersionId", "in": "path", "required": true, "schema": { "title": "stateVersionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/state-version-outputs/{stateVersionOutputId}": { "get": { "tags": [ "StateVersionOutputs" ], "operationId": "showStateVersionOutput", "description": "The parameters and request body are for method: showStateVersionOutput. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "stateVersionOutputId", "in": "path", "required": true, "schema": { "title": "stateVersionOutputId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vars": { "post": { "tags": [ "Variables" ], "operationId": "createVariable", "description": "The parameters and request body are for method: createVariable. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "Variables" ], "operationId": "listVariables", "description": "The parameters and request body are for method: listVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filterWorkspaceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filterOrganizationName", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vars/{variableId}": { "patch": { "tags": [ "Variables" ], "operationId": "updateVariables", "description": "The parameters and request body are for method: updateVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "variableId", "in": "path", "required": true, "schema": { "title": "variableId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Variables" ], "operationId": "deleteVariables", "description": "The parameters and request body are for method: deleteVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "variableId", "in": "path", "required": true, "schema": { "title": "variableId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations/{organizationName}/workspaces": { "post": { "tags": [ "Workspaces" ], "operationId": "createWorkspace", "description": "The parameters and request body are for method: createWorkspace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "Workspaces" ], "operationId": "listWorkspaces", "description": "The parameters and request body are for method: listWorkspaces. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}": { "get": { "tags": [ "Workspaces" ], "operationId": "showWorkspace", "description": "The parameters and request body are for method: showWorkspace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}/actions/lock": { "post": { "tags": [ "Workspaces" ], "operationId": "lockWorkspace", "description": "The parameters and request body are for method: lockWorkspace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}/actions/unlock": { "post": { "tags": [ "Workspaces" ], "operationId": "unlockWorkspace", "description": "The parameters and request body are for method: unlockWorkspace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}/actions/force-unlock": { "post": { "tags": [ "Workspaces" ], "operationId": "forceUnlockWorkspace", "description": "The parameters and request body are for method: forceUnlockWorkspace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}/relationships/ssh-key": { "patch": { "tags": [ "Workspaces" ], "operationId": "assignSSHKeyToWorkspace", "description": "The parameters and request body are for method: assignSSHKeyToWorkspace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/workspaces/{workspaceId}/vars": { "post": { "tags": [ "WorkspacesVariables" ], "operationId": "createWorkspaceVariable", "description": "The parameters and request body are for method: createWorkspaceVariable. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "WorkspacesVariables" ], "operationId": "listWorkspaceVariables", "description": "The parameters and request body are for method: listWorkspaceVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/workspaces/{workspaceId}/vars/{variableId}": { "patch": { "tags": [ "WorkspacesVariables" ], "operationId": "updateWorkspaceVariables", "description": "The parameters and request body are for method: updateWorkspaceVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } }, { "name": "variableId", "in": "path", "required": true, "schema": { "title": "variableId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "WorkspacesVariables" ], "operationId": "deleteWorkspaceVariables", "description": "The parameters and request body are for method: deleteWorkspaceVariables. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "title": "workspaceId", "type": "string" } }, { "name": "variableId", "in": "path", "required": true, "schema": { "title": "variableId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations/{organizationName}/oauth-clients": { "get": { "tags": [ "OAuthClients" ], "operationId": "listOauthClients", "description": "The parameters and request body are for method: listOauthClients. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "OAuthClients" ], "operationId": "createOAuthClient", "description": "The parameters and request body are for method: createOAuthClient. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/oauth-clients/{id}": { "get": { "tags": [ "OAuthClients" ], "operationId": "showOAuthClient", "description": "The parameters and request body are for method: showOAuthClient. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "OAuthClients" ], "operationId": "updateOAuthClient", "description": "The parameters and request body are for method: updateOAuthClient. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "OAuthClients" ], "operationId": "destroyOAuthClient", "description": "The parameters and request body are for method: destroyOAuthClient. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/oauth-clients/{oauthClientId}/oauth-tokens": { "get": { "tags": [ "OAuthTokens" ], "operationId": "listOAuthTokens", "description": "The parameters and request body are for method: listOAuthTokens. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "oauthClientId", "in": "path", "required": true, "schema": { "title": "oauthClientId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/oauth-tokens/{id}": { "get": { "tags": [ "OAuthTokens" ], "operationId": "showOAuthToken", "description": "The parameters and request body are for method: showOAuthToken. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "OAuthTokens" ], "operationId": "updateOAuthToken", "description": "The parameters and request body are for method: updateOAuthToken. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "OAuthTokens" ], "operationId": "destroyOAuthToken", "description": "The parameters and request body are for method: destroyOAuthToken. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/organizations/{organizationName}/authentication-token": { "post": { "tags": [ "OrganizationToken" ], "operationId": "generateOrganizationToken", "description": "The parameters and request body are for method: generateOrganizationToken. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "OrganizationToken" ], "operationId": "deleteOrganizationToken", "description": "The parameters and request body are for method: deleteOrganizationToken. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "organizationName", "in": "path", "required": true, "schema": { "title": "organizationName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/plan-exports": { "post": { "tags": [ "PlanExports" ], "operationId": "createPlanExport", "description": "The parameters and request body are for method: createPlanExport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/plan-exports/{id}": { "get": { "tags": [ "PlanExports" ], "operationId": "showPlanExport", "description": "The parameters and request body are for method: showPlanExport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "PlanExports" ], "operationId": "deleteExportedPlanData", "description": "The parameters and request body are for method: deleteExportedPlanData. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/plan-exports/{id}/download": { "get": { "tags": [ "PlanExports" ], "operationId": "downloadPlanExport", "description": "The parameters and request body are for method: downloadPlanExport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users/{user}": { "get": { "tags": [ "Users" ], "operationId": "showUser", "description": "The parameters and request body are for method: showUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "title": "user", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }