WorkspaceIntegration

Query Workspace Integrations

Changed on

Query matching Integration Configurations for Workspace

get/workspaces/{workspace_id}/integrations

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/workspaces/{workspace_id}/integrations
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

workspace_idstring required

workspace id

Query parameters

integration_type'atlassian_connect' | 'atlassian_forge' | 'atlassian_rovo' | 'azure_boards' | 'export_feed_google_bigquery' | 'export_feed_google_cloud_storage' | 'export_feed_google_pubsub' | 'github_app' | 'jira' | 'jira_server_plugin' | 'microsoft_teams_webhook' | 'segment' | 'slack' | 'testrail' | 'xray' | 'xray_sync' | 'zephyr'

integration type filter

oauth_token_idstring

Return only if has a matching OAuth token id

user_idstring

Return only if has a matching user id

enabledboolean

Return only enabled or disabled integrations

limitinteger

The limit to use for pagination

cursorstring

The cursor to use for pagination

integration_typesIntegrationTypeEnum[]

Multiple integration types filter. Will be used only integration_type is not provided

with_secretsboolean

Return decrypted secrets if true. Honored only for a principal holding read_secret:integrations in the requested workspace; otherwise the query is served as if it were false, with the secret fields empty, rather than refused.

renew_secretsboolean

Renew time sensitive secrets, if relevant to the given integration, and IFF with_secrets is true. Honored only for a principal holding read_secret:integrations in the requested workspace; otherwise the query is served as if it were false, and no secret is renewed or persisted.

Response

Workspace Integrations, if any

cursorstring

Cursor used for pagination

Example response

{
  "integrations": [
    {
      "config": {
        "issue_tracker": {
          "base_url": "https://jira.example.com/jira",
          "schemas": [
            {
              "fields": [
                {
                  "id": "affected_platform",
                  "name": "Affected Platform",
                  "type": "labels",
                  "allowed_values": [
                    {
                      "value": "Chrome"
                    },
                    {
                      "value": "Edge"
                    },
                    {
                      "value": "Firefox"
                    },
                    {
                      "value": "IE11"
                    },
                    {
                      "value": "Safari"
                    }
                  ],
                  "is_required": true
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

Changes

  • 488eade0b398Revision changes
    • warning

      added the new zephyr enum value to the // response property for the response status

    • info

      added the new enum value zephyr to the query request parameter integration_type

    • info

      added the enum value zephyr to the property items/ of the query request parameter integration_types

    • info

      added the optional property /// to the response with the status

  • 09076d803fdfRevision changes
    • info

      added the optional property //// to the response with the status