> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Connector Systems A–D

> Fields and example bodies for each external system a Configuration API connector supports (A–D).

Per-system connector reference (AMAZON_CONNECT → DOVETAIL). Every connector is created with `POST /platform/connectors` and the body `{"name": ..., "system": ..., "<system>_config": {...}, "version": {"change_description": ...}}`. Send the config block that matches `system`, and no other.

## EXTERNAL_SYSTEM_AMAZON_CONNECT

Config block: `amazon_connect_config`

Amazon Connect connection settings, used when system is EXTERNAL_SYSTEM_AMAZON_CONNECT. Set exactly one system-specific config.

| Field                   | Type   | Required | Notes                                                                                                                                                                                                                            |
| ----------------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `instance_id`           | string |          | ID of your Amazon Connect instance, in UUID format.                                                                                                                                                                              |
| `contact_flow_id`       | string |          | ID of the Amazon Connect contact flow to use, in UUID format.                                                                                                                                                                    |
| `aws_sns_topic_arn`     | string |          | ARN of the AWS SNS topic used for Amazon Connect notifications.                                                                                                                                                                  |
| `region`                | string |          | AWS region of the Amazon Connect instance, for example 'us-east-1'. Allowed: af-south-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-west-2, ov-west-1, us-east-1, us-west-2. |
| `aws_access_key_id`     | string |          | AWS access key ID used to call Amazon Connect. Secret: always returned masked as \*\*\*\*\*.                                                                                                                                     |
| `aws_secret_access_key` | string |          | AWS secret access key paired with the access key ID. Secret: always returned masked as \*\*\*\*\*.                                                                                                                               |

Example create body:

```json
{
  "name": "amazon_connect_connector",
  "system": "EXTERNAL_SYSTEM_AMAZON_CONNECT",
  "amazon_connect_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_ARIBA

Config block: `ariba_config`

SAP Ariba connection settings, used when system is EXTERNAL_SYSTEM_ARIBA. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                    |
| --------------------------- | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `env`                       | string                  |          | SAP Ariba environment to connect to. Allowed values: 'prod' or 'sandbox'.                                |
| `realm`                     | string                  |          | Name of your SAP Ariba realm.                                                                            |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | Authenticate with an OAuth 2.0 client ID and secret. Set exactly one authentication method.              |
| `on_prem_auth`              | OnPremiseAuth           |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method. |

Set at most one of `oauth2_client_credentials`, `on_prem_auth`.

Example create body:

```json
{
  "name": "ariba_connector",
  "system": "EXTERNAL_SYSTEM_ARIBA",
  "ariba_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_AUTHHUB

Config block: `authhub_config`

AuthHub connection settings, used when system is EXTERNAL_SYSTEM_AUTHHUB. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                    |
| --------------------------- | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `standard_url`              | StandardAuthHubUrl      |          | Standard AuthHub URL, built from a subdomain and the AuthHub domain. Set either this or custom_url.      |
| `custom_url`                | CustomBaseUrl           |          | Custom base URL for your AuthHub instance. Set either this or standard_url.                              |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | Authenticate with an OAuth 2.0 client ID and secret. Set exactly one authentication method.              |
| `on_prem_auth`              | OnPremiseAuth           |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method. |

Example create body:

```json
{
  "name": "authhub_connector",
  "system": "EXTERNAL_SYSTEM_AUTHHUB",
  "authhub_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_AXERO

Config block: `axero_config`

Axero connection settings, used when system is EXTERNAL_SYSTEM_AXERO. Set exactly one system-specific config.

| Field             | Type          | Required | Notes                                                                                                    |
| ----------------- | ------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `custom_base_url` | CustomBaseUrl |          | Base URL of your Axero instance.                                                                         |
| `api_key_auth`    | ApiKeyAuth    |          | Authenticate with an Axero API key. Set exactly one authentication method.                               |
| `on_prem_auth`    | OnPremiseAuth |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method. |

Set at most one of `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "axero_connector",
  "system": "EXTERNAL_SYSTEM_AXERO",
  "axero_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BACKSTAGE

Config block: `backstage_config`

Backstage connection settings, used when system is EXTERNAL_SYSTEM_BACKSTAGE. Set exactly one system-specific config.

| Field              | Type                    | Required | Notes                                                                                                    |
| ------------------ | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `oauth2_jwt_grant` | BackstageOAuth2JwtGrant |          | Authenticate with a service account using an OAuth 2.0 JWT grant. Set exactly one authentication method. |
| `on_prem_auth`     | OnPremiseAuth           |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method. |

Set at most one of `oauth2_jwt_grant`, `on_prem_auth`.

Example create body:

```json
{
  "name": "backstage_connector",
  "system": "EXTERNAL_SYSTEM_BACKSTAGE",
  "backstage_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BEYOND_TRUST

Config block: `beyond_trust_config`

BeyondTrust connection settings, used when system is EXTERNAL_SYSTEM_BEYOND_TRUST. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                       |
| --------------------------- | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| `standard_url`              | StandardBeyondTrustUrl  |          | Standard BeyondTrust URL, built from a subdomain and the BeyondTrust domain. Set either this or custom_url. |
| `custom_url`                | CustomBaseUrl           |          | Custom base URL for your BeyondTrust instance. Set either this or standard_url.                             |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | Authenticate with an OAuth 2.0 client ID and secret. Set exactly one authentication method.                 |
| `on_prem_auth`              | OnPremiseAuth           |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.    |

Example create body:

```json
{
  "name": "beyond_trust_connector",
  "system": "EXTERNAL_SYSTEM_BEYOND_TRUST",
  "beyond_trust_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BMC_REMEDY

Config block: `bmc_remedy_config`

BMC Remedy (including Remedy Helix) connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY. Set exactly one system-specific config.

| Field              | Type                    | Required | Notes                                                                                                                            |
| ------------------ | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`     | StandardBmcRemedyUrl    |          | Standard BMC-hosted URL in the form https\://\<subdomain>.onbmc.com. Set either this or custom_url.                              |
| `custom_url`       | CustomBaseUrl           |          | Custom base URL for your BMC Remedy instance. Set either this or standard_url.                                                   |
| `oauth2_jwt_grant` | BmcRemedyOAuth2JwtGrant |          | Authenticate with a username and password through the BMC Remedy AR System JWT login API. Set exactly one authentication method. |
| `on_prem_auth`     | OnPremiseAuth           |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.                         |

Example create body:

```json
{
  "name": "bmc_remedy_connector",
  "system": "EXTERNAL_SYSTEM_BMC_REMEDY",
  "bmc_remedy_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BMC_REMEDYFORCE

Config block: `bmc_remedyforce_config`

BMC Remedyforce connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDYFORCE. Set exactly one system-specific config.

| Field                   | Type                              | Required | Notes                                                                                                                              |
| ----------------------- | --------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`          | StandardBmcRemedyforceUrl         |          | Standard URL in the form https\://\<subdomain>.salesforce.com. Set either this or custom_url.                                      |
| `custom_url`            | CustomBaseUrl                     |          | Custom base URL for your BMC Remedyforce instance. Set either this or standard_url.                                                |
| `oauth2_password_grant` | BmcRemedyforceOAuth2PasswordGrant |          | Authenticate with a username, password and security key using the OAuth 2.0 password grant. Set exactly one authentication method. |
| `on_prem_auth`          | OnPremiseAuth                     |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.                           |

Example create body:

```json
{
  "name": "bmc_remedyforce_connector",
  "system": "EXTERNAL_SYSTEM_BMC_REMEDYFORCE",
  "bmc_remedyforce_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BMC_REMEDY_DWP

Config block: `bmc_remedy_dwp_config`

BMC Remedy DWP connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY_DWP. Set exactly one system-specific config.

| Field          | Type                   | Required | Notes                                                                                                                            |
| -------------- | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `base_url`     | BmcRemedyDwpBaseUrl    |          | BMC-hosted URL of your BMC Remedy DWP instance, in the form https\://\<subdomain>.onbmc.com.                                     |
| `cookie_auth`  | BmcRemedyDwpCookieAuth |          | Authenticate with a username and password through the BMC Remedy DWP AR System login API. Set exactly one authentication method. |
| `on_prem_auth` | OnPremiseAuth          |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.                         |

Set at most one of `cookie_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "bmc_remedy_dwp_connector",
  "system": "EXTERNAL_SYSTEM_BMC_REMEDY_DWP",
  "bmc_remedy_dwp_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BOX

Config block: `box_config`

Box connection settings, used when system is EXTERNAL_SYSTEM_BOX. Set exactly one system-specific config.

| Field                     | Type                     | Required | Notes                                                                                                             |
| ------------------------- | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `oauth2_refresh_token`    | OAuth2RefreshToken       |          | Authenticate with an OAuth 2.0 client ID, client secret and refresh token. Set exactly one authentication method. |
| `client_credentials_auth` | BoxClientCredentialsAuth |          | Authenticate with a Box app's client credentials grant. Set exactly one authentication method.                    |

Set at most one of `oauth2_refresh_token`, `client_credentials_auth`.

Example create body:

```json
{
  "name": "box_connector",
  "system": "EXTERNAL_SYSTEM_BOX",
  "box_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BOX_LEGACY

Config block: `box_legacy_config`

Box (legacy) connection settings, used when system is EXTERNAL_SYSTEM_BOX_LEGACY. Set exactly one system-specific config.

| Field           | Type   | Required | Notes                                                                                                 |
| --------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------- |
| `client_id`     | string |          | Client ID of the Box app Moveworks uses to connect.                                                   |
| `client_secret` | string |          | Client secret of the Box app Moveworks uses to connect. Secret: always returned masked as \*\*\*\*\*. |
| `enterprise_id` | string |          | Enterprise ID of your Box account, used for the Box service account.                                  |

Example create body:

```json
{
  "name": "box_legacy_connector",
  "system": "EXTERNAL_SYSTEM_BOX_LEGACY",
  "box_legacy_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BRAINSTORM

Config block: `brainstorm_config`

Brainstorm connection settings, used when system is EXTERNAL_SYSTEM_BRAINSTORM. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                                                       |
| --------------------------- | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`              | StandardBrainstormUrl   |          | URL of your Brainstorm instance, in the form https\://\<subdomain>.quickhelp.com.                                                           |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | Authenticate with the client ID and secret from your Brainstorm admin portal. Set exactly one authentication method.                        |
| `api_key_auth`              | BrainstormApiKeyAuth    |          | Authenticate with a Brainstorm API key and subscription key. Older method; OAuth 2.0 is recommended. Set exactly one authentication method. |
| `on_prem_auth`              | OnPremiseAuth           |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.                                    |

Set at most one of `oauth2_client_credentials`, `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "brainstorm_connector",
  "system": "EXTERNAL_SYSTEM_BRAINSTORM",
  "brainstorm_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_BRIGHTSPOT

Config block: `brightspot_config`

Brightspot connection settings, used when system is EXTERNAL_SYSTEM_BRIGHTSPOT. Set exactly one system-specific config.

| Field                            | Type                                  | Required | Notes                                                                                                                                         |
| -------------------------------- | ------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `custom_base_url`                | CustomBaseUrl                         |          | Base URL of your Brightspot instance.                                                                                                         |
| `client_credentials_header_auth` | BrightspotClientCredentialsHeaderAuth |          | Authenticate by sending a client ID and secret in the X-Client-ID and X-Client-Secret request headers. Set exactly one authentication method. |
| `on_prem_auth`                   | OnPremiseAuth                         |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.                                      |

Set at most one of `client_credentials_header_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "brightspot_connector",
  "system": "EXTERNAL_SYSTEM_BRIGHTSPOT",
  "brightspot_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CHERWELL

Config block: `cherwell_config`

Cherwell connection settings, used when system is EXTERNAL_SYSTEM_CHERWELL. Set exactly one system-specific config.

| Field                  | Type                       | Required | Notes                                                                                                                              |
| ---------------------- | -------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`         | StandardCherwellUrl        |          | Cherwell-hosted URL in the form https\://\<subdomain>.cherwellondemand.com. Set either this or custom_url.                         |
| `custom_url`           | CustomBaseUrl              |          | Custom base URL for your Cherwell instance. Set either this or standard_url.                                                       |
| `system_timezone`      | string                     |          | Time zone of your Cherwell system as an IANA name, for example 'America/Los_Angeles'.                                              |
| `oauth2_internal_mode` | CherwellOAuth2InternalMode |          | Authenticate with a Cherwell CSM user and REST API client ID using OAuth 2.0 internal mode. Set exactly one authentication method. |
| `on_prem_auth`         | OnPremiseAuth              |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.                           |

Example create body:

```json
{
  "name": "cherwell_connector",
  "system": "EXTERNAL_SYSTEM_CHERWELL",
  "cherwell_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_COMAROUND

Config block: `comaround_config`

ComAround connection settings, used when system is EXTERNAL_SYSTEM_COMAROUND. Set exactly one system-specific config.

| Field              | Type            | Required | Notes                                                                                                         |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| `comaround_oauth2` | ComaroundOAuth2 |          | Authenticate with a ComAround username, password and subscription key. Set exactly one authentication method. |
| `on_prem_auth`     | OnPremiseAuth   |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.      |

Set at most one of `comaround_oauth2`, `on_prem_auth`.

Example create body:

```json
{
  "name": "comaround_connector",
  "system": "EXTERNAL_SYSTEM_COMAROUND",
  "comaround_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CONCUR

Config block: `concur_config`

SAP Concur connection settings, used when system is EXTERNAL_SYSTEM_CONCUR. Set exactly one system-specific config.

| Field            | Type               | Required | Notes                                                                                                             |
| ---------------- | ------------------ | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `oauth2_refresh` | OAuth2RefreshToken |          | Authenticate with an OAuth 2.0 client ID, client secret and refresh token. Set exactly one authentication method. |
| `on_prem_auth`   | OnPremiseAuth      |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.          |

Set at most one of `oauth2_refresh`, `on_prem_auth`.

Example create body:

```json
{
  "name": "concur_connector",
  "system": "EXTERNAL_SYSTEM_CONCUR",
  "concur_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CONFLUENCE

Config block: `confluence_config`

Confluence Cloud connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE. Set exactly one system-specific config.

| Field                    | Type                                    | Required | Notes                                                                                                        |
| ------------------------ | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `service_account_method` | ConnectorConfluenceServiceAccountMethod |          | Connect with a service account's username and password or API token. Set either this or forge_app_method.    |
| `forge_app_method`       | ConnectorConfluenceForgeAppMethod       |          | Connect through a Confluence Forge app that proxies API requests. Set either this or service_account_method. |

Set at most one of `service_account_method`, `forge_app_method`.

Example create body:

```json
{
  "name": "confluence_connector",
  "system": "EXTERNAL_SYSTEM_CONFLUENCE",
  "confluence_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CONFLUENCE_LEGACY

Config block: `confluence_legacy_config`

Confluence (legacy) connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_LEGACY. Set exactly one system-specific config.

| Field           | Type                   | Required | Notes                                                                                                                                                    |
| --------------- | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`  | StandardConfluenceUrl  |          | Atlassian-hosted URL in the form https\://\<subdomain>.atlassian.net. Set either this or custom_url.                                                     |
| `custom_url`    | CustomBaseUrl          |          | Custom base URL of your Confluence instance, for example https\://\<subdomain>.atlassian.net/wiki for Confluence Cloud. Set either this or standard_url. |
| `basic_auth`    | BasicAuthentication    |          | Authenticate with a username and password. Set exactly one authentication method.                                                                        |
| `api_key_auth`  | ApiKeyAuth             |          | Authenticate with an API key. Set exactly one authentication method.                                                                                     |
| `on_prem_auth`  | OnPremiseAuth          |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.                                                 |
| `oauth2`        | ConfluenceOAuth2       |          | Authenticate with OAuth 2.0 using a token URL and client credentials. Set exactly one authentication method.                                             |
| `external_auth` | ConfluenceExternalAuth |          | Authentication managed by Moveworks. Read-only; cannot be set when creating or updating a connector.                                                     |

Example create body:

```json
{
  "name": "confluence_legacy_connector",
  "system": "EXTERNAL_SYSTEM_CONFLUENCE_LEGACY",
  "confluence_legacy_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CONFLUENCE_SERVER

Config block: `confluence_server_config`

Confluence Server connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_SERVER. Set exactly one system-specific config.

| Field            | Type                          | Required | Notes                                                                                                    |
| ---------------- | ----------------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `custom_url`     | CustomBaseUrl                 |          | Base URL of your Confluence Server instance.                                                             |
| `basic_auth`     | BasicAuthentication           |          | Authenticate with a username and password. Set exactly one authentication method.                        |
| `on_prem_auth`   | OnPremiseAuth                 |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method. |
| `api_key_auth`   | ApiKeyAuth                    |          | Authenticate with an API key. Set exactly one authentication method.                                     |
| `version_number` | ConfluenceServerVersionNumber |          | Version of the Confluence Server you are connecting to.                                                  |

Set at most one of `basic_auth`, `on_prem_auth`, `api_key_auth`.

Example create body:

```json
{
  "name": "confluence_server_connector",
  "system": "EXTERNAL_SYSTEM_CONFLUENCE_SERVER",
  "confluence_server_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CONNECT_WISE

Config block: `connect_wise_config`

ConnectWise connection settings, used when system is EXTERNAL_SYSTEM_CONNECT_WISE. Set exactly one system-specific config.

| Field          | Type                   | Required | Notes                                                                                                       |
| -------------- | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| `standard_url` | StandardConnectWiseUrl |          | Standard ConnectWise URL, built from a subdomain and the ConnectWise domain. Set either this or custom_url. |
| `custom_url`   | CustomBaseUrl          |          | Custom base URL for your ConnectWise instance. Set either this or standard_url.                             |
| `basic_auth`   | ConnectWiseBasicAuth   |          | Authenticate with a ConnectWise username, password and client ID. Set exactly one authentication method.    |
| `on_prem_auth` | OnPremiseAuth          |          | Connect through a Moveworks on-premise agent instead of directly. Set exactly one authentication method.    |

Example create body:

```json
{
  "name": "connect_wise_connector",
  "system": "EXTERNAL_SYSTEM_CONNECT_WISE",
  "connect_wise_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CONTENTFUL

Config block: `contentful_config`

Contentful connection settings, used when system is EXTERNAL_SYSTEM_CONTENTFUL. Set exactly one system-specific config.

| Field          | Type          | Required | Notes                                                                                                     |
| -------------- | ------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| `api_key_auth` | ApiKeyAuth    |          | API key authentication for Contentful. Set exactly one auth method.                                       |
| `on_prem_auth` | OnPremiseAuth |          | On-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method. |

Set at most one of `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "contentful_connector",
  "system": "EXTERNAL_SYSTEM_CONTENTFUL",
  "contentful_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_CONTENT_GATEWAY_SYSTEM

Config block: `content_gateway_system_config`

Content Gateway System connection settings, used when system is EXTERNAL_SYSTEM_CONTENT_GATEWAY_SYSTEM. Set exactly one system-specific config.

| Field                             | Type                                             | Required | Notes                                                                                                                          |
| --------------------------------- | ------------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `custom_url`                      | CustomBaseUrl                                    |          | Base URL of the content gateway system's API.                                                                                  |
| `oauth2_client_credentials_grant` | ContentGatewaySystemOAuth2ClientCredentialsGrant |          | OAuth 2.0 client credentials grant against a token endpoint you specify. Set exactly one auth method.                          |
| `on_prem_auth`                    | OnPremiseAuth                                    |          | On-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.                      |
| `api_key_auth`                    | ApiKeyAuth                                       |          | API key authentication for the content gateway system. Set exactly one auth method.                                            |
| `oauth2_jwt_grant`                | ContentGatewaySystemOAuth2JwtGrant               |          | OAuth 2.0 JWT bearer grant, where a signed JWT is exchanged for an access token at the token URL. Set exactly one auth method. |
| `external_auth`                   | ContentGatewaySystemExternalAuth                 |          | Externally managed OAuth 2.0 authentication. Read-only; it cannot be set through this API.                                     |

Set at most one of `oauth2_client_credentials_grant`, `on_prem_auth`, `api_key_auth`, `oauth2_jwt_grant`, `external_auth`.

Example create body:

```json
{
  "name": "content_gateway_system_connector",
  "system": "EXTERNAL_SYSTEM_CONTENT_GATEWAY_SYSTEM",
  "content_gateway_system_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_COUPA

Config block: `coupa_config`

Coupa connection settings, used when system is EXTERNAL_SYSTEM_COUPA. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                                          |
| --------------------------- | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `standard_url`              | StandardCoupaUrl        |          | Standard Coupa base URL, built from scheme, subdomain, and domain. Set either this or custom_url.                              |
| `custom_url`                | CustomBaseUrl           |          | Custom base URL of your Coupa instance. Use when your instance is not on the standard domain. Set either this or standard_url. |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | OAuth 2.0 client credentials grant using the client ID and client secret of your Coupa OAuth client.                           |

Example create body:

```json
{
  "name": "coupa_connector",
  "system": "EXTERNAL_SYSTEM_COUPA",
  "coupa_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_DOVETAIL

Config block: `dovetail_config`

Dovetail connection settings, used when system is EXTERNAL_SYSTEM_DOVETAIL. Set exactly one system-specific config.

| Field          | Type                | Required | Notes                                                                                                     |
| -------------- | ------------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| `base_url`     | DovetailBaseUrl     |          | Base URL of your Dovetail instance, built from scheme, subdomain, and domain.                             |
| `basic_auth`   | BasicAuthentication |          | Basic authentication with the username and password of a Dovetail account. Set exactly one auth method.   |
| `on_prem_auth` | OnPremiseAuth       |          | On-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method. |

Set at most one of `basic_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "dovetail_connector",
  "system": "EXTERNAL_SYSTEM_DOVETAIL",
  "dovetail_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```