{
  "opencollection": "1.0.0",
  "info": {
    "name": "Arthur Scope Agents V1 Workspaces V1 API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Workspaces V1",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Workspace.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/workspaces/:workspace_id",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/auth",
              "accessTokenUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Requires workspace_read permission."
        },
        {
          "info": {
            "name": "Patch Workspace.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/workspaces/:workspace_id",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/auth",
              "accessTokenUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Requires workspace_update permission."
        },
        {
          "info": {
            "name": "Delete Workspace.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/workspaces/:workspace_id",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/auth",
              "accessTokenUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Requires workspace_delete permission."
        },
        {
          "info": {
            "name": "Get Workspace Statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/workspaces/:workspace_id/statistics",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/auth",
              "accessTokenUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets workspace information for data plane, projects, custom aggregations, and user count. Requires workspace_get_statistics permission"
        },
        {
          "info": {
            "name": "Get Workspaces.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/organization/workspaces",
            "params": [
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Override the field used for sorting the returned list. Optional."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Override the sort order used. Optional."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Search term to filter workspaces by name."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page to return starting from 1 up to total_pages."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of records per page. The max is 1000."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/auth",
              "accessTokenUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Requires organization_list_workspaces permission."
        },
        {
          "info": {
            "name": "Post Workspace.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/organization/workspaces",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/auth",
              "accessTokenUrl": "https://platform-auth.arthur.ai/realms/arthur/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Requires organization_create_workspace permission."
        }
      ]
    }
  ],
  "bundled": true
}