{
  "id": "@itentialopensource/adapter-terraform_enterprise",
  "type": "Adapter",
  "export": "Terraform",
  "title": "TerraformEnterprise",
  "src": "adapter.js",
  "roles": [
    "admin"
  ],
  "methods": [
    {
      "name": "iapUpdateAdapterConfiguration",
      "summary": "Updates the adapter configuration",
      "description": "Updates the adapter configuration file with the provided changes",
      "input": [
        {
          "name": "configFile",
          "type": "string",
          "info": "The name of the file to change",
          "required": true,
          "schema": {
            "title": "configFile",
            "type": "string"
          }
        },
        {
          "name": "changes",
          "type": "object",
          "info": "JSON object containing the configuration changes",
          "required": true,
          "schema": {
            "title": "changes",
            "type": "object"
          }
        },
        {
          "name": "entity",
          "type": "string",
          "info": "The entity in which the changes are being made",
          "required": false,
          "schema": {
            "title": "entity",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "The type of file to change - action, schema, or mock",
          "required": false,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "action",
          "type": "string",
          "info": "The action to be changed",
          "required": false,
          "schema": {
            "title": "action",
            "type": "string"
          }
        },
        {
          "name": "replace",
          "type": "boolean",
          "info": "True to replace entire mock data, false to merge/append",
          "required": false,
          "schema": {
            "title": "replace",
            "type": "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUpdateAdapterConfiguration"
      },
      "task": true
    },
    {
      "name": "iapSuspendAdapter",
      "summary": "Suspends the adapter",
      "description": "Suspends the adapter",
      "input": [
        {
          "name": "mode",
          "type": "enum",
          "enumerals": [
            "pause",
            "error"
          ],
          "info": "How incoming requests are handled. Defaults to 'pause'",
          "description": "How incoming requests are handled. Defaults to 'pause'",
          "schema": {
            "title": "mode",
            "type": "string"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapSuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapUnsuspendAdapter",
      "summary": "Unsuspends the adapter",
      "description": "Unsuspends the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUnsuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterQueue",
      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
      "description": "Return the requests that are waiting in the queue if throttling is enabled",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter queue",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetAdapterQueue"
      },
      "task": true
    },
    {
      "name": "iapFindAdapterPath",
      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
      "description": "Provides the ability to see if a particular API path is supported by the adapter",
      "input": [
        {
          "name": "apiPath",
          "type": "string",
          "info": "The API Path you want to check - make sure to not include base path and version",
          "description": "The API Path you want to check - make sure to not include base path and version",
          "schema": {
            "title": "apiPath",
            "type": "string"
          },
          "required": true
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapFindAdapterPath"
      },
      "task": true
    },
    {
      "name": "iapTroubleshootAdapter",
      "summary": "Runs troubleshoot script for adapter",
      "description": "Runs troubleshoot script for adapter",
      "input": [
        {
          "name": "props",
          "type": "object",
          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
          "required": true,
          "schema": {
            "title": "props",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapTroubleshootAdapter"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterHealthcheck",
      "summary": "Runs healthcheck script for adapter",
      "description": "Runs healthcheck script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "Whether healthcheck passed or failed",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterHealthcheck"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterConnectivity",
      "summary": "Runs connectivity check script for adapter",
      "description": "Runs connectivity check script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterConnectivity"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterBasicGet",
      "summary": "Runs basicGet script for adapter",
      "description": "Runs basicGet script for adapter",
      "input": [
        {
          "name": "maxCalls",
          "required": false,
          "type": "number",
          "info": "How many GET endpoints to test (defaults to 5)",
          "schema": {
            "title": "maxCalls",
            "type": "number",
            "default": 5
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterBasicGet"
      },
      "task": true
    },
    {
      "name": "iapMoveAdapterEntitiesToDB",
      "summary": "Moves entities from an adapter into the Itential Platform database",
      "description": "Moves entities from an adapter into the Itential Platform database",
      "input": [],
      "output": {
        "name": "res",
        "type": "object",
        "description": "A JSON Object containing status, code and the response from the mongo transaction",
        "schema": {
          "title": "res",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapMoveAdapterEntitiesToDB"
      },
      "task": true
    },
    {
      "name": "iapDeactivateTasks",
      "summary": "Deactivate the inputted tasks",
      "description": "Deactivate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to deactivate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapDeactivateTasks"
      },
      "task": true
    },
    {
      "name": "iapActivateTasks",
      "summary": "Activate the inputted tasks",
      "description": "activate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to activate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapActivateTasks"
      },
      "task": true
    },
    {
      "name": "iapPopulateEntityCache",
      "summary": "Populate the cache for the given entities",
      "description": "Populate the cache for the given entities",
      "input": [
        {
          "name": "entityTypes",
          "type": "array",
          "info": "the entity type(s) to populate",
          "required": true,
          "schema": {
            "title": "entityTypes",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapPopulateEntityCache"
      },
      "task": true
    },
    {
      "name": "iapRetrieveEntitiesCache",
      "summary": "Retrieves data from cache for specified entity type",
      "description": "Retrieves data from cache for specified entity type",
      "input": [
        {
          "name": "entityType",
          "type": "string",
          "info": "entity of which to retrieve",
          "required": true,
          "schema": {
            "title": "entityType",
            "type": "string"
          }
        },
        {
          "name": "options",
          "type": "object",
          "info": "settings of which data to return and how to return it",
          "required": false,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRetrieveEntitiesCache"
      },
      "task": true
    },
    {
      "name": "getDevice",
      "summary": "Get the Appliance",
      "description": "Get the Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevice"
      },
      "task": false
    },
    {
      "name": "getDevicesFiltered",
      "summary": "Get Appliances that match the filter",
      "description": "Get Appliances that match the filter",
      "input": [
        {
          "name": "options",
          "type": "object",
          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
          "required": true,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "array",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "array"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevicesFiltered"
      },
      "task": false
    },
    {
      "name": "isAlive",
      "summary": "Checks the status for the provided Appliance",
      "description": "Checks the status for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/isAlive"
      },
      "task": false
    },
    {
      "name": "getConfig",
      "summary": "Gets a config for the provided Appliance",
      "description": "Gets a config for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        },
        {
          "name": "format",
          "type": "string",
          "info": "The format to be returned - this is ignored as we always return json",
          "required": false,
          "schema": {
            "title": "format",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getConfig"
      },
      "task": false
    },
    {
      "name": "iapGetDeviceCount",
      "summary": "Gets a device count from the system",
      "description": "Gets a device count from the system",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetDeviceCount"
      },
      "task": false
    },
    {
      "name": "iapExpandedGenericAdapterRequest",
      "summary": "Makes the requested generic call with additional options",
      "description": "Makes the requested generic call with additional options via metadata",
      "input": [
        {
          "name": "metadata",
          "type": "object",
          "info": "metadata for the call (optional)",
          "description": "metadata for the call - allows for many enhancements (optional)",
          "schema": {
            "title": "metadata",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "pathVars",
          "type": "object",
          "info": "the parameters to be put within the url path (optional)",
          "description": "the parameters to be put within the url path (optional)",
          "schema": {
            "title": "pathVars",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapExpandedGenericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequest",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequestNoBasePath",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequestNoBasePath"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterLint",
      "summary": "Run the adapter lint script to return the results",
      "description": "Run the adapter lint script to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "string",
        "description": "A string containing the run results",
        "schema": {
          "title": "result",
          "type": "string"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterLint"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterTests",
      "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
      "description": "Run the adapter test scripts (baseunit and unit) to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterTests"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterInventory",
      "summary": "Provide inventory information abbout the adapter",
      "description": "Provide inventory information abbout the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapGetAdapterInventory"
      },
      "task": true
    },
    {
      "name": "get",
      "summary": "GetAccountDetails",
      "description": "Get account details.",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/get"
      },
      "task": true
    },
    {
      "name": "updateAccount",
      "summary": "Update Account",
      "description": "Update account details",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": "JSON body for update: string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateAccount"
      },
      "task": true
    },
    {
      "name": "changePassword",
      "summary": "Change Password",
      "description": "Change your password",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/changePassword"
      },
      "task": true
    },
    {
      "name": "createRun",
      "summary": "Create a Run",
      "description": "A run performs a plan and apply, using a configuration version and the workspace’s current variables. You can specify a configuration version when creating a run; if you don’t provide one, the run defaults to the workspace’s most recently used version. (A configuration version is “used” when it is created or used for a run in this workspace.)",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createRun"
      },
      "task": true
    },
    {
      "name": "applyRun",
      "summary": "Apply a Run",
      "description": "Applies a run that is paused waiting for confirmation after a plan. This includes runs in the \"needs confirmation\" and \"policy checked\" states. This action is only required for runs that can't be auto-applied. (Plans can be auto-applied if the auto-apply setting is enabled on the workspace and the plan was queued by a new VCS commit or by a user with write permissions.)",
      "input": [
        {
          "name": "runId",
          "type": "string",
          "info": "The run ID to apply: string",
          "required": true,
          "schema": {
            "title": "runId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/applyRun"
      },
      "task": true
    },
    {
      "name": "listRuns",
      "summary": "List Runs in a Workspace",
      "description": "List Runs in a Workspace",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The workspace ID to list runs for.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        },
        {
          "name": "pageNumber",
          "type": "number",
          "info": "Page Number: 123",
          "required": false,
          "schema": {
            "title": "pageNumber",
            "type": "number"
          }
        },
        {
          "name": "pageSize",
          "type": "number",
          "info": "Page Size: 123",
          "required": false,
          "schema": {
            "title": "pageSize",
            "type": "number"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listRuns"
      },
      "task": true
    },
    {
      "name": "getRunDetails",
      "summary": "Get run details",
      "description": "This endpoint is used for showing details of a specific run.",
      "input": [
        {
          "name": "runId",
          "type": "string",
          "info": "The run ID to get.: string",
          "required": true,
          "schema": {
            "title": "runId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getRunDetails"
      },
      "task": true
    },
    {
      "name": "discardRun",
      "summary": "Discard a Run",
      "description": "The discard action can be used to skip any remaining work on runs that are paused waiting for confirmation or priority. This includes runs in the \"pending,\" \"needs confirmation,\" \"policy checked,\" and \"policy override\" states.",
      "input": [
        {
          "name": "runId",
          "type": "string",
          "info": "The run ID to discard: string",
          "required": true,
          "schema": {
            "title": "runId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/discardRun"
      },
      "task": true
    },
    {
      "name": "cancelRun",
      "summary": "Cancel a Run",
      "description": "The cancel action can be used to interrupt a run that is currently planning or applying. Performing a cancel is roughly equivalent to hitting ctrl+c during a Terraform plan or apply on the CLI. The running Terraform process is sent an INT signal, which instructs Terraform to end its work and wrap up in the safest way possible.",
      "input": [
        {
          "name": "runId",
          "type": "string",
          "info": "The run ID to cancel: string",
          "required": true,
          "schema": {
            "title": "runId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/cancelRun"
      },
      "task": true
    },
    {
      "name": "forceCancel",
      "summary": "Forcefully cancel a run",
      "description": "The force-cancel action is like cancel, but ends the run immediately. Once invoked, the run is placed into a canceled state, and the running Terraform process is terminated. The workspace is immediately unlocked, allowing further runs to be queued. The force-cancel operation requires workspace admin privileges.",
      "input": [
        {
          "name": "runId",
          "type": "string",
          "info": "The run ID to cancel: string",
          "required": true,
          "schema": {
            "title": "runId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/forceCancel"
      },
      "task": true
    },
    {
      "name": "forceExecute",
      "summary": "Forcefully execute a run",
      "description": "The force-execute action cancels all prior runs that are not already complete, unlocking the run's workspace and allowing the run to be executed. (It initiates the same actions as the \"Run this plan now\" button at the top of the view of a pending run.)",
      "input": [
        {
          "name": "runId",
          "type": "string",
          "info": "The run ID to execute: string",
          "required": true,
          "schema": {
            "title": "runId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/forceExecute"
      },
      "task": true
    },
    {
      "name": "getApply",
      "summary": "Get Apply",
      "description": "Show an apply",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the apply to show.: ",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getApply"
      },
      "task": true
    },
    {
      "name": "getCostEstimate",
      "summary": "Get Cost Estimate",
      "description": "Show a cost estimate",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the cost estimate to show..: ",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getCostEstimate"
      },
      "task": true
    },
    {
      "name": "createNotificationConfiguration",
      "summary": "Create Notification Configuration",
      "description": "Create a Notification Configuration",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createNotificationConfiguration"
      },
      "task": true
    },
    {
      "name": "listNotificationConfigurations",
      "summary": "List Notification Configurations",
      "description": "List all notification configurations",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The ID of the workspace to list configurations from. Obtain this from the workspace settings or the Show Workspace endpoint.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listNotificationConfigurations"
      },
      "task": true
    },
    {
      "name": "getNotificationConfiguration",
      "summary": "Get Notification Configuration",
      "description": "Get details for a notification configuration",
      "input": [
        {
          "name": "notificationConfigurationId",
          "type": "string",
          "info": "The id of the notification configuration to show.: string",
          "required": true,
          "schema": {
            "title": "notificationConfigurationId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getNotificationConfiguration"
      },
      "task": true
    },
    {
      "name": "updateNotificationConfiguration",
      "summary": "Update Notification Configuration",
      "description": "Update a notification configuration",
      "input": [
        {
          "name": "notificationConfigurationId",
          "type": "string",
          "info": "The id of the notification configuration to update.: string",
          "required": true,
          "schema": {
            "title": "notificationConfigurationId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateNotificationConfiguration"
      },
      "task": true
    },
    {
      "name": "deleteNotificationConfiguration",
      "summary": "Delete Notification Configuration",
      "description": "This endpoint deletes a notification configuration.",
      "input": [
        {
          "name": "notificationConfigurationId",
          "type": "string",
          "info": "The id of the notification configuration to delete.: string",
          "required": true,
          "schema": {
            "title": "notificationConfigurationId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteNotificationConfiguration"
      },
      "task": true
    },
    {
      "name": "verifyNotificationConfiguration",
      "summary": "Verify a Notification Configuration",
      "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.",
      "input": [
        {
          "name": "notificationConfigurationId",
          "type": "string",
          "info": "The id of the notification configuration to verify.: string",
          "required": true,
          "schema": {
            "title": "notificationConfigurationId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/verifyNotificationConfiguration"
      },
      "task": true
    },
    {
      "name": "listOrganizations",
      "summary": "List Organizations",
      "description": "List the organizations",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/listOrganizations"
      },
      "task": true
    },
    {
      "name": "getOrganization",
      "summary": "Get Organization",
      "description": "Get an organization",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The name of the organization to show: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getOrganization"
      },
      "task": true
    },
    {
      "name": "inviteUserToOrganization",
      "summary": "Invite a User to an Organization",
      "description": "Invite a User to an Organization",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The name of the organization the user will be invited to join. The inviting user must have permission to manage organization memberships: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/inviteUserToOrganization"
      },
      "task": true
    },
    {
      "name": "listMembershipsOrganization",
      "summary": "List Memberships for an Organization",
      "description": "List Memberships for an Organization",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The name of the organization to list the memberships of.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "q",
          "type": "string",
          "info": "Optional. A search query string. Organization memberships are searchable by user name and email.: string",
          "required": false,
          "schema": {
            "title": "q",
            "type": "string"
          }
        },
        {
          "name": "filterStatus",
          "type": "string",
          "info": "Optional. If specified, restricts results to those with the matching status value. Valid values are invited and active.: string",
          "required": false,
          "schema": {
            "title": "filterStatus",
            "type": "string"
          }
        },
        {
          "name": "pageNumber",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return the first page.: string",
          "required": false,
          "schema": {
            "title": "pageNumber",
            "type": "string"
          }
        },
        {
          "name": "pageSize",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return 20 users per page.: string",
          "required": false,
          "schema": {
            "title": "pageSize",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listMembershipsOrganization"
      },
      "task": true
    },
    {
      "name": "listUserOwnMemberships",
      "summary": "List User's Own Memberships",
      "description": "List User's Own Memberships",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/listUserOwnMemberships"
      },
      "task": true
    },
    {
      "name": "showMembership",
      "summary": "Show a Membership",
      "description": "Show a Membership",
      "input": [
        {
          "name": "organizationMembershipId",
          "type": "string",
          "info": "The organization membership: string",
          "required": true,
          "schema": {
            "title": "organizationMembershipId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showMembership"
      },
      "task": true
    },
    {
      "name": "removeUserFromOrganization",
      "summary": "Remove User from Organization",
      "description": "Remove User from Organization",
      "input": [
        {
          "name": "organizationMembershipId",
          "type": "string",
          "info": "The organization membership: string",
          "required": true,
          "schema": {
            "title": "organizationMembershipId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/removeUserFromOrganization"
      },
      "task": true
    },
    {
      "name": "showPlan",
      "summary": "Show a plan",
      "description": "Show a plan",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the plan to show: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showPlan"
      },
      "task": true
    },
    {
      "name": "createPolicy",
      "summary": "Create a Policy",
      "description": "Create a Policy",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "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...(description truncated): string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createPolicy"
      },
      "task": true
    },
    {
      "name": "listPolicies",
      "summary": "List Policies",
      "description": "List Policies",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The organization to list policies for.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "pageNumber",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return the first page.: string",
          "required": false,
          "schema": {
            "title": "pageNumber",
            "type": "string"
          }
        },
        {
          "name": "pageSize",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return 20 policies per page.: string",
          "required": false,
          "schema": {
            "title": "pageSize",
            "type": "string"
          }
        },
        {
          "name": "searchName",
          "type": "string",
          "info": "Optional. Allows searching the organization's policies by name.: string",
          "required": false,
          "schema": {
            "title": "searchName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listPolicies"
      },
      "task": true
    },
    {
      "name": "showPolicy",
      "summary": "Show a Policy",
      "description": "Show a Policy",
      "input": [
        {
          "name": "policyId",
          "type": "string",
          "info": "The ID of the policy to show. Use the \"List Policies\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "policyId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showPolicy"
      },
      "task": true
    },
    {
      "name": "updatePolicy",
      "summary": "Update a Policy",
      "description": "This endpoint can update the enforcement mode of an existing policy. To update the policy code itself, use the upload endpoint.",
      "input": [
        {
          "name": "policyId",
          "type": "string",
          "info": "The ID of the policy to update. Use the \"List Policies\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "policyId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updatePolicy"
      },
      "task": true
    },
    {
      "name": "deletePolicy",
      "summary": "Delete a Policy",
      "description": "Delete a Policy",
      "input": [
        {
          "name": "policyId",
          "type": "string",
          "info": "The ID of the policy to delete. Use the \"List Policies\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "policyId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deletePolicy"
      },
      "task": true
    },
    {
      "name": "uploadPolicy",
      "summary": "Upload a Policy",
      "description": "Upload a Policy",
      "input": [
        {
          "name": "policyId",
          "type": "string",
          "info": "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.: string",
          "required": true,
          "schema": {
            "title": "policyId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/uploadPolicy"
      },
      "task": true
    },
    {
      "name": "listPolicyChecks",
      "summary": "List policy checks",
      "description": "This endpoint lists the policy checks in a run.",
      "input": [
        {
          "name": "runId",
          "type": "string",
          "info": "specifies the run ID for which to list policy checks: string",
          "required": true,
          "schema": {
            "title": "runId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listPolicyChecks"
      },
      "task": true
    },
    {
      "name": "overridePolicy",
      "summary": "Override Policy",
      "description": "This endpoint overrides a soft-mandatory or warning policy.",
      "input": [
        {
          "name": "policyCheckId",
          "type": "string",
          "info": "specifies the ID for the policy check to override: string",
          "required": true,
          "schema": {
            "title": "policyCheckId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/overridePolicy"
      },
      "task": true
    },
    {
      "name": "createPolicySet",
      "summary": "Create a Policy Set",
      "description": "Create a Policy Set",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The organization to create the policy set in. The organization must already exist in the system, and the token authenticating the API request must belong to the \"owners\" ...(description truncated): string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createPolicySet"
      },
      "task": true
    },
    {
      "name": "listPolicySets",
      "summary": "List Policy Sets",
      "description": "List Policy Sets",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The organization to list policy sets for.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "filterVersioned",
          "type": "string",
          "info": "Optional. Allows filtering policy sets based on whether they are versioned (VCS-managed or API-managed), or use individual policy relationships. Accepts a boolean true/fa...(description truncated): string",
          "required": true,
          "schema": {
            "title": "filterVersioned",
            "type": "string"
          }
        },
        {
          "name": "include",
          "type": "string",
          "info": "Optional. Allows including related resource data. Value must be a comma-separated list containing one or more of workspaces, policies, newest_version, or current_version....(description truncated): string",
          "required": true,
          "schema": {
            "title": "include",
            "type": "string"
          }
        },
        {
          "name": "pageNumber",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return the first page.: string",
          "required": true,
          "schema": {
            "title": "pageNumber",
            "type": "string"
          }
        },
        {
          "name": "pageSize",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return 20 policy sets per page.: string",
          "required": true,
          "schema": {
            "title": "pageSize",
            "type": "string"
          }
        },
        {
          "name": "searchName",
          "type": "string",
          "info": "Optional. Allows searching the organization's policy sets by name.: string",
          "required": true,
          "schema": {
            "title": "searchName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listPolicySets"
      },
      "task": true
    },
    {
      "name": "showPolicySet",
      "summary": "Show a Policy Set",
      "description": "Show a Policy Set",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to show. Use the \"List Policy Sets\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showPolicySet"
      },
      "task": true
    },
    {
      "name": "updatePolicySet",
      "summary": "Update a Policy Set",
      "description": "Update a Policy Set",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to update. Use the \"List Policy Sets\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updatePolicySet"
      },
      "task": true
    },
    {
      "name": "deletePolicySet",
      "summary": "Delete a Policy Set",
      "description": "Delete a Policy Set",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to delete. Use the \"List Policy Sets\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deletePolicySet"
      },
      "task": true
    },
    {
      "name": "addPoliciesToPolicySet",
      "summary": "Add Policies to the Policy Set",
      "description": "Add Policies to the Policy Set",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to add policies to. Use the \"List Policy Sets\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/addPoliciesToPolicySet"
      },
      "task": true
    },
    {
      "name": "removePoliciesFromThePolicySet",
      "summary": "Remove Policies from the Policy Set",
      "description": "Remove Policies from the Policy Set",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to remove policies from. Use the \"List Policy Sets\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/removePoliciesFromThePolicySet"
      },
      "task": true
    },
    {
      "name": "attachPolicySetToWorkspaces",
      "summary": "Attach a Policy Set to workspaces",
      "description": "Attach a Policy Set to workspaces",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to attach to workspaces. Use the \"List Policy Sets\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/attachPolicySetToWorkspaces"
      },
      "task": true
    },
    {
      "name": "detachthePolicySetFromWorkspaces",
      "summary": "Detach the Policy Set from workspaces",
      "description": "Detach the Policy Set from workspaces",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to detach from workspaces. Use the \"List Policy Sets\" endpoint to find IDs.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/detachthePolicySetFromWorkspaces"
      },
      "task": true
    },
    {
      "name": "createPolicySetVersion",
      "summary": "Create a Policy Set Version",
      "description": "For versioned policy sets which have no VCS repository attached, versions of policy code may be uploaded directly to the API by creating a new policy set version and, in a subsequent request, uploading a tarball (tar.gz) of data to it.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set to create a new version for.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createPolicySetVersion"
      },
      "task": true
    },
    {
      "name": "showPolicySetVersion",
      "summary": "Show a Policy Set Version",
      "description": "Show a Policy Set Version",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the policy set version to show.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showPolicySetVersion"
      },
      "task": true
    },
    {
      "name": "createParameter",
      "summary": "Create a Parameter",
      "description": "Create a Parameter",
      "input": [
        {
          "name": "policySetId",
          "type": "string",
          "info": "The ID of the policy set to create the parameter in.: string",
          "required": true,
          "schema": {
            "title": "policySetId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createParameter"
      },
      "task": true
    },
    {
      "name": "listParameters",
      "summary": "List Parameters",
      "description": "List Parameters",
      "input": [
        {
          "name": "policySetId",
          "type": "string",
          "info": "The ID of the policy set to list parameters for.: string",
          "required": true,
          "schema": {
            "title": "policySetId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listParameters"
      },
      "task": true
    },
    {
      "name": "updateParameters",
      "summary": "Update Parameters",
      "description": "Update Parameters",
      "input": [
        {
          "name": "policySetId",
          "type": "string",
          "info": "The ID of the policy set that owns the parameter.: string",
          "required": true,
          "schema": {
            "title": "policySetId",
            "type": "string"
          }
        },
        {
          "name": "parameterId",
          "type": "string",
          "info": "The ID of the parameter to be updated.: string",
          "required": true,
          "schema": {
            "title": "parameterId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateParameters"
      },
      "task": true
    },
    {
      "name": "deleteParameters",
      "summary": "Delete Parameters",
      "description": "Delete Parameters",
      "input": [
        {
          "name": "policySetId",
          "type": "string",
          "info": "The ID of the policy set that owns the parameter.: string",
          "required": true,
          "schema": {
            "title": "policySetId",
            "type": "string"
          }
        },
        {
          "name": "parameterId",
          "type": "string",
          "info": "The ID of the parameter to be deleted.: string",
          "required": true,
          "schema": {
            "title": "parameterId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteParameters"
      },
      "task": true
    },
    {
      "name": "createStateVersion",
      "summary": "Create a State Version",
      "description": "Create a State Version",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The workspace ID to create the new state version in. Obtain this from the workspace settings or the Show Workspace endpoint.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createStateVersion"
      },
      "task": true
    },
    {
      "name": "listStateVersions",
      "summary": "List State Versions",
      "description": "List State Versions for a Workspace",
      "input": [
        {
          "name": "filterWorkspaceName",
          "type": "string",
          "info": "Required The name of one workspace to list versions for.: string",
          "required": false,
          "schema": {
            "title": "filterWorkspaceName",
            "type": "string"
          }
        },
        {
          "name": "filterOrganizationName",
          "type": "string",
          "info": "Required The name of the organization that owns the desired workspace.: string",
          "required": false,
          "schema": {
            "title": "filterOrganizationName",
            "type": "string"
          }
        },
        {
          "name": "pageNumber",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return the first page.: string",
          "required": false,
          "schema": {
            "title": "pageNumber",
            "type": "string"
          }
        },
        {
          "name": "pageSize",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return 20 state versions per page.: string",
          "required": false,
          "schema": {
            "title": "pageSize",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listStateVersions"
      },
      "task": true
    },
    {
      "name": "fetchCurrentStateVersionForWorkspace",
      "summary": "Fetch Current State Version",
      "description": "Fetch the Current State Version for a Workspace",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The ID for the workspace whose current state version you want to fetch. Obtain this from the workspace settings or the Show Workspace endpoint.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/fetchCurrentStateVersionForWorkspace"
      },
      "task": true
    },
    {
      "name": "showStateVersion",
      "summary": "Show a State Version",
      "description": "Show a State Version",
      "input": [
        {
          "name": "stateVersionId",
          "type": "string",
          "info": "The ID of the desired state version.: string",
          "required": true,
          "schema": {
            "title": "stateVersionId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showStateVersion"
      },
      "task": true
    },
    {
      "name": "showStateVersionOutput",
      "summary": "Show a State Version Output",
      "description": "Show a State Version Output",
      "input": [
        {
          "name": "stateVersionOutputId",
          "type": "string",
          "info": "The ID of the desired state version output.: string",
          "required": true,
          "schema": {
            "title": "stateVersionOutputId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showStateVersionOutput"
      },
      "task": true
    },
    {
      "name": "createVariable",
      "summary": "Create a Variable",
      "description": "Create a Variable",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createVariable"
      },
      "task": true
    },
    {
      "name": "listVariables",
      "summary": "List Variables",
      "description": "List Variables",
      "input": [
        {
          "name": "filterWorkspaceName",
          "type": "string",
          "info": "Optional The name of one workspace to list variables for. If included, you must also include the organization name filter.: string",
          "required": false,
          "schema": {
            "title": "filterWorkspaceName",
            "type": "string"
          }
        },
        {
          "name": "filterOrganizationName",
          "type": "string",
          "info": "Optional The name of the organization that owns the desired workspace. If included, you must also included the workspace name filter.: string",
          "required": false,
          "schema": {
            "title": "filterOrganizationName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listVariables"
      },
      "task": true
    },
    {
      "name": "updateVariables",
      "summary": "Update Variables",
      "description": "Update Variables",
      "input": [
        {
          "name": "variableId",
          "type": "string",
          "info": "The ID of the variable to be updated.: string",
          "required": true,
          "schema": {
            "title": "variableId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateVariables"
      },
      "task": true
    },
    {
      "name": "deleteVariables",
      "summary": "Delete Variables",
      "description": "Delete Variables",
      "input": [
        {
          "name": "variableId",
          "type": "string",
          "info": "The ID of the variable to be deleted.: string",
          "required": true,
          "schema": {
            "title": "variableId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteVariables"
      },
      "task": true
    },
    {
      "name": "createWorkspace",
      "summary": "Create a Workspace",
      "description": "Create a Workspace",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The name of the organization to create the workspace in. The organization must already exist in the system, and the user must have permissions to create new workspaces.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createWorkspace"
      },
      "task": true
    },
    {
      "name": "listWorkspaces",
      "summary": "List Workspaces",
      "description": "List Workspaces",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The name of the organization to list the workspaces of.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "pageNumber",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return the first page.: string",
          "required": false,
          "schema": {
            "title": "pageNumber",
            "type": "string"
          }
        },
        {
          "name": "pageSize",
          "type": "string",
          "info": "Optional. If omitted, the endpoint will return 150 workspaces per page.: string",
          "required": false,
          "schema": {
            "title": "pageSize",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listWorkspaces"
      },
      "task": true
    },
    {
      "name": "showWorkspace",
      "summary": "Show Workspace",
      "description": "Details on a workspace can be retrieved from two endpoints, which behave identically. One refers to a workspace by its ID, and the other by its name and organization.",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The workspace ID: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showWorkspace"
      },
      "task": true
    },
    {
      "name": "lockWorkspace",
      "summary": "Lock a workspace",
      "description": "This endpoint locks a workspace.",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The workspace ID to lock. Obtain this from the workspace settings or the Show Workspace endpoint.: ",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/lockWorkspace"
      },
      "task": true
    },
    {
      "name": "unlockWorkspace",
      "summary": "Unlock a workspace",
      "description": "This endpoint unlocks a workspace.",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The workspace ID to unlock. Obtain this from the workspace settings or the Show Workspace endpoint.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/unlockWorkspace"
      },
      "task": true
    },
    {
      "name": "forceUnlockWorkspace",
      "summary": "Force Unlock a workspace",
      "description": "This endpoint force unlocks a workspace. Only users with admin access are authorized to force unlock a workspace.",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The workspace ID to force unlock. Obtain this from the workspace settings or the Show Workspace endpoint.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/forceUnlockWorkspace"
      },
      "task": true
    },
    {
      "name": "assignSSHKeyToWorkspace",
      "summary": "Assign/Unassign an SSH key to a workspace",
      "description": "This endpoint assigns and unassigns an SSH key to/from a workspace.",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The workspace ID to assign the SSH key to. Obtain this from the workspace settings or the Show Workspace endpoint.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/assignSSHKeyToWorkspace"
      },
      "task": true
    },
    {
      "name": "createWorkspaceVariable",
      "summary": "Create a Workspace Variable",
      "description": "Create a Workspace Variable",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The ID of the workspace to create the variable in.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createWorkspaceVariable"
      },
      "task": true
    },
    {
      "name": "listWorkspaceVariables",
      "summary": "List Workspace Variables",
      "description": "List workspace variables",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The ID of the workspace to list variables for.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listWorkspaceVariables"
      },
      "task": true
    },
    {
      "name": "updateWorkspaceVariables",
      "summary": "Update Workspace Variables",
      "description": "Update Workspace Variables",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The ID of the workspace that owns the variable.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        },
        {
          "name": "variableId",
          "type": "string",
          "info": "The ID of the variable to be updated.: string",
          "required": true,
          "schema": {
            "title": "variableId",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateWorkspaceVariables"
      },
      "task": true
    },
    {
      "name": "deleteWorkspaceVariables",
      "summary": "Delete Workspace Variables",
      "description": "Delete Workspace Variables",
      "input": [
        {
          "name": "workspaceId",
          "type": "string",
          "info": "The ID of the workspace that owns the variable.: string",
          "required": true,
          "schema": {
            "title": "workspaceId",
            "type": "string"
          }
        },
        {
          "name": "variableId",
          "type": "string",
          "info": "The ID of the variable to be deleted.: string",
          "required": true,
          "schema": {
            "title": "variableId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteWorkspaceVariables"
      },
      "task": true
    },
    {
      "name": "listOauthClients",
      "summary": "List OAuth Clients",
      "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.",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The name of the organization.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listOauthClients"
      },
      "task": true
    },
    {
      "name": "createOAuthClient",
      "summary": "Create an OAuth Client",
      "description": "Create an OAuth Client",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "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...(description truncated): string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createOAuthClient"
      },
      "task": true
    },
    {
      "name": "showOAuthClient",
      "summary": "Show an OAuth Client",
      "description": "Show an OAuth Client",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the OAuth Client to show: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showOAuthClient"
      },
      "task": true
    },
    {
      "name": "updateOAuthClient",
      "summary": "Update an OAuth Client",
      "description": "Update an OAuth Client",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the OAuth Client to update.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateOAuthClient"
      },
      "task": true
    },
    {
      "name": "destroyOAuthClient",
      "summary": "Destroy an OAuth Client",
      "description": "Destroy an OAuth Client",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the OAuth Client to destroy: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/destroyOAuthClient"
      },
      "task": true
    },
    {
      "name": "listOAuthTokens",
      "summary": "List OAuth Tokens",
      "description": "List all the OAuth Tokens for a given OAuth Client",
      "input": [
        {
          "name": "oauthClientId",
          "type": "string",
          "info": "The ID of the OAuth Client: string",
          "required": true,
          "schema": {
            "title": "oauthClientId",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/listOAuthTokens"
      },
      "task": true
    },
    {
      "name": "showOAuthToken",
      "summary": "Show an OAuth Token",
      "description": "Show an OAuth Token",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the OAuth token to show: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showOAuthToken"
      },
      "task": true
    },
    {
      "name": "updateOAuthToken",
      "summary": "Update an OAuth Token",
      "description": "Update an OAuth Token",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the OAuth token to update: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateOAuthToken"
      },
      "task": true
    },
    {
      "name": "destroyOAuthToken",
      "summary": "Destroy an OAuth Token",
      "description": "Destroy an OAuth Token",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the OAuth Token to destroy: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/destroyOAuthToken"
      },
      "task": true
    },
    {
      "name": "generateOrganizationToken",
      "summary": "Generate a new organization token",
      "description": "Generate a new organization token",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "The name of the organization to generate a token for.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/generateOrganizationToken"
      },
      "task": true
    },
    {
      "name": "deleteOrganizationToken",
      "summary": "Delete the organization token",
      "description": "Delete the organization token",
      "input": [
        {
          "name": "organizationName",
          "type": "string",
          "info": "Which organization's token should be deleted.: string",
          "required": true,
          "schema": {
            "title": "organizationName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteOrganizationToken"
      },
      "task": true
    },
    {
      "name": "createPlanExport",
      "summary": "Create a plan export",
      "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.",
      "input": [
        {
          "name": "body",
          "type": "object",
          "info": ": string",
          "required": false,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/createPlanExport"
      },
      "task": true
    },
    {
      "name": "showPlanExport",
      "summary": "Show a plan export",
      "description": "Show a plan export",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the plan export to show.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showPlanExport"
      },
      "task": true
    },
    {
      "name": "deleteExportedPlanData",
      "summary": "Delete exported plan data",
      "description": "Plan exports expire after being available for one hour, but they can be deleted manually as well.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the plan export: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/deleteExportedPlanData"
      },
      "task": true
    },
    {
      "name": "downloadPlanExport",
      "summary": "Download exported plan data",
      "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.",
      "input": [
        {
          "name": "id",
          "type": "string",
          "info": "The ID of the plan export.: string",
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/downloadPlanExport"
      },
      "task": true
    },
    {
      "name": "showUser",
      "summary": "Show a User",
      "description": "Shows details for a given user.",
      "input": [
        {
          "name": "user",
          "type": "string",
          "info": "The ID of the desired user.: string",
          "required": true,
          "schema": {
            "title": "user",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/showUser"
      },
      "task": true
    }
  ],
  "views": []
}