Skip to navigation

Connector Systems M–S

View as Markdown

Per-system connector reference (META_WORKPLACE → SIMPPLR). 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_META_WORKPLACE

Config block: meta_workplace_config

Meta Workplace connection settings, used when system is EXTERNAL_SYSTEM_META_WORKPLACE. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardMetaWorkplaceUrlStandard Workplace from Meta base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of the Workplace from Meta API. Set either this or standard_url.
api_key_authApiKeyAuthAPI key authentication for Workplace from Meta. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Example create body:

{
"name": "meta_workplace_connector",
"system": "EXTERNAL_SYSTEM_META_WORKPLACE",
"meta_workplace_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_MICROSOFT_DYNAMICS

Config block: microsoft_dynamics_config

Microsoft Dynamics connection settings, used when system is EXTERNAL_SYSTEM_MICROSOFT_DYNAMICS. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardMicrosoftDynamicsUrlStandard Microsoft Dynamics base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of your Microsoft Dynamics instance. Use when your instance is not on the standard domain. Set either this or standard_url.
tenant_idstringYour Microsoft Entra tenant ID, used to request access tokens.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and client secret of your Microsoft Entra app. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Example create body:

{
"name": "microsoft_dynamics_connector",
"system": "EXTERNAL_SYSTEM_MICROSOFT_DYNAMICS",
"microsoft_dynamics_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_MS_GRAPH

Config block: ms_graph_config

Microsoft Graph connection settings, used when system is EXTERNAL_SYSTEM_MS_GRAPH. Set exactly one system-specific config.

FieldTypeRequiredNotes
tenant_idstringYour organization’s Azure domain, in the format ‘company.com’.
regionstringMicrosoft cloud used to build the base URL. Allowed values: ‘COMMERCIAL’ or ‘GOV L4’. Defaults to commercial.
oauth2_client_credentialsMsGraphOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and client secret of your Microsoft Entra app. Set exactly one auth method.
oauth2_jwt_client_assertionMsGraphOAuth2JwtClientAssertionOAuth 2.0 with a JWT client assertion, using a certificate uploaded to your Microsoft Entra app. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.
app_store_authMsGraphAppStoreAuthAuthentication through the Moveworks app installed from the Microsoft app store. Set exactly one auth method.

Set at most one of oauth2_client_credentials, oauth2_jwt_client_assertion, on_prem_auth, app_store_auth.

Example create body:

{
"name": "ms_graph_connector",
"system": "EXTERNAL_SYSTEM_MS_GRAPH",
"ms_graph_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_MS_TEAMS_ORG

Config block: ms_teams_org_config

Microsoft Teams organization connection settings, used when system is EXTERNAL_SYSTEM_MS_TEAMS_ORG. Set exactly one system-specific config.

FieldTypeRequiredNotes
tenant_idstringYour Microsoft Teams tenant ID.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and client secret of your Microsoft Entra app. Set exactly one auth method.
oauth2_jwt_client_assertionMsTeamsOrgOAuth2JwtClientAssertionOAuth 2.0 with a JWT client assertion, using a certificate uploaded to your Microsoft Entra app. Set exactly one auth method.
bot_app_store_authMsTeamsOrgBotAppStoreAuthAuthentication through the Moveworks bot installed from the Microsoft Teams app store. Needs no extra settings. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_client_credentials, oauth2_jwt_client_assertion, bot_app_store_auth, on_prem_auth.

Example create body:

{
"name": "ms_teams_org_connector",
"system": "EXTERNAL_SYSTEM_MS_TEAMS_ORG",
"ms_teams_org_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_NOTION

Config block: notion_config

Notion connection settings, used when system is EXTERNAL_SYSTEM_NOTION. Set exactly one system-specific config.

FieldTypeRequiredNotes
api_key_authApiKeyAuthAPI key authentication for Notion. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-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:

{
"name": "notion_connector",
"system": "EXTERNAL_SYSTEM_NOTION",
"notion_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_OFFICESPACE

Config block: officespace_config

OfficeSpace connection settings, used when system is EXTERNAL_SYSTEM_OFFICESPACE. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardOfficespaceUrlBase URL of your OfficeSpace instance, built from scheme, subdomain, and domain.
api_key_authApiKeyAuthAPI key authentication for OfficeSpace. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-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:

{
"name": "officespace_connector",
"system": "EXTERNAL_SYSTEM_OFFICESPACE",
"officespace_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_OKTA

Config block: okta_config

Okta connection settings, used when system is EXTERNAL_SYSTEM_OKTA. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardOktaUrlStandard Okta base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of your Okta org, such as a custom domain. Set either this or standard_url.
oauth2_jwtOAuth2JWTBearerOAuth 2.0 with a signed JWT, using the client ID, key ID, and private key of your Okta service app. Set exactly one auth method.
api_key_authApiKeyAuthAPI key authentication for Okta. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Example create body:

{
"name": "okta_connector",
"system": "EXTERNAL_SYSTEM_OKTA",
"okta_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_ONELOGIN

Config block: onelogin_config

OneLogin connection settings, used when system is EXTERNAL_SYSTEM_ONELOGIN. Set exactly one system-specific config.

FieldTypeRequiredNotes
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials using the client ID and client secret of your OneLogin API credential. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_client_credentials, on_prem_auth.

Example create body:

{
"name": "onelogin_connector",
"system": "EXTERNAL_SYSTEM_ONELOGIN",
"onelogin_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_ORACLE

Config block: oracle_config

Oracle connection settings, used when system is EXTERNAL_SYSTEM_ORACLE. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_urlCustomBaseUrlBase URL of your Oracle instance.
basic_authBasicAuthenticationBasic authentication with the username and password of a Oracle account. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-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:

{
"name": "oracle_connector",
"system": "EXTERNAL_SYSTEM_ORACLE",
"oracle_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_OUTLOOK

Config block: outlook_config

Microsoft Outlook connection settings, used when system is EXTERNAL_SYSTEM_OUTLOOK. Set exactly one system-specific config.

FieldTypeRequiredNotes
regionstringMicrosoft cloud used to build the base URL. Allowed values: ‘COMMERCIAL’ or ‘GOV L4’. Defaults to commercial.
tenant_idstringYour Microsoft Entra tenant (directory) ID, which uniquely identifies your organization.
user_consent_authOAuth2ClientCredentialsOAuth 2.0 user consent authentication using the client ID and client secret of your Microsoft Entra app.

Set at most one of user_consent_auth.

Example create body:

{
"name": "outlook_connector",
"system": "EXTERNAL_SYSTEM_OUTLOOK",
"outlook_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_PING

Config block: ping_config

PingID connection settings, used when system is EXTERNAL_SYSTEM_PING. Set exactly one system-specific config.

FieldTypeRequiredNotes
common_base_urlPingStandardUrlBase URL of your PingID API, built from scheme, subdomain, and domain.
org_aliasstringYour PingID organization alias, from the PingID properties file.
ping_authPingLegacyAuthPingID API authentication using the token and secret key from your PingID properties file. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of ping_auth, on_prem_auth.

Example create body:

{
"name": "ping_connector",
"system": "EXTERNAL_SYSTEM_PING",
"ping_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_PROMAPP

Config block: promapp_config

Promapp connection settings, used when system is EXTERNAL_SYSTEM_PROMAPP. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_urlCustomBaseUrlBase URL of your Promapp instance.
promapp_authPromappAuthPromapp authentication. Promapp needs a username and password to fetch article content and an API key to list articles. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of promapp_auth, on_prem_auth.

Example create body:

{
"name": "promapp_connector",
"system": "EXTERNAL_SYSTEM_PROMAPP",
"promapp_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_QUIP

Config block: quip_config

Quip connection settings, used when system is EXTERNAL_SYSTEM_QUIP. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardQuipUrlStandard Quip base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of your Quip instance. Use when your instance is not on the standard domain. Set either this or standard_url.
oauth2_refreshOAuth2RefreshTokenOAuth 2.0 refresh token grant using the client ID, client secret, and refresh token of your Quip app. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Example create body:

{
"name": "quip_connector",
"system": "EXTERNAL_SYSTEM_QUIP",
"quip_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_RIGHT_ANSWERS

Config block: right_answers_config

RightAnswers connection settings, used when system is EXTERNAL_SYSTEM_RIGHT_ANSWERS. Set exactly one system-specific config.

FieldTypeRequiredNotes
base_urlRightAnswersStandardUrlBase URL of your RightAnswers instance, built from scheme, subdomain, and domain.
basic_authBasicAuthenticationBasic authentication with the username and password of a RightAnswers account. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-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:

{
"name": "right_answers_connector",
"system": "EXTERNAL_SYSTEM_RIGHT_ANSWERS",
"right_answers_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SAILPOINT

Config block: sailpoint_config

SailPoint IdentityIQ connection settings, used when system is EXTERNAL_SYSTEM_SAILPOINT. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_base_urlCustomBaseUrlBase URL of your SailPoint tenant’s API.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and client secret of your SailPoint API client. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_client_credentials, on_prem_auth.

Example create body:

{
"name": "sailpoint_connector",
"system": "EXTERNAL_SYSTEM_SAILPOINT",
"sailpoint_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SAILPOINT_INOW

Config block: sailpoint_inow_config

SailPoint Identity Security Cloud connection settings, used when system is EXTERNAL_SYSTEM_SAILPOINT_INOW. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardSailpointInowUrlThe base URL of your SailPoint IdentityNow instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA custom base URL for your SailPoint IdentityNow instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and secret of an app registered in SailPoint IdentityNow. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to SailPoint IdentityNow. Set exactly one authentication method.

Example create body:

{
"name": "sailpoint_inow_connector",
"system": "EXTERNAL_SYSTEM_SAILPOINT_INOW",
"sailpoint_inow_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SALESFORCE

Config block: salesforce_config

Salesforce Service Cloud connection settings, used when system is EXTERNAL_SYSTEM_SALESFORCE. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardSalesforceUrlThe base URL of your Salesforce instance, given as scheme, subdomain, and domain.
is_sandbox_instancebooleanIf true, the connector targets a Salesforce sandbox instance instead of a production org.
oauth2_jwt_grantSalesforceOAuth2JwtGrantOAuth 2.0 JWT bearer flow using a Salesforce connected app and a service account. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to Salesforce. Set exactly one authentication method.
live_agent_authSalesforceLiveAgentAuthOptional credentials for Salesforce messaging, used to hand conversations off to live agents.

Set at most one of oauth2_jwt_grant, on_prem_auth.

Example create body:

{
"name": "salesforce_connector",
"system": "EXTERNAL_SYSTEM_SALESFORCE",
"salesforce_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SCREEN_STEPS

Config block: screen_steps_config

ScreenSteps connection settings, used when system is EXTERNAL_SYSTEM_SCREEN_STEPS. Set exactly one system-specific config.

FieldTypeRequiredNotes
base_urlScreenStepsBaseUrlThe base URL of your ScreenSteps site, given as scheme, subdomain, and domain.
basic_authBasicAuthenticationBasic authentication with the username and password of a ScreenSteps service account. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to ScreenSteps. Set exactly one authentication method.

Set at most one of basic_auth, on_prem_auth.

Example create body:

{
"name": "screen_steps_connector",
"system": "EXTERNAL_SYSTEM_SCREEN_STEPS",
"screen_steps_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SEARCHUNIFY

Config block: searchunify_config

SearchUnify connection settings, used when system is EXTERNAL_SYSTEM_SEARCHUNIFY. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardSearchunifyUrlThe base URL of your SearchUnify instance, given as scheme, subdomain, and domain.
oauth2_passwordOAuth2PasswordGrantOAuth 2.0 password grant using a client ID and secret plus the username and password of a SearchUnify account. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to SearchUnify. Set exactly one authentication method.

Set at most one of oauth2_password, on_prem_auth.

Example create body:

{
"name": "searchunify_connector",
"system": "EXTERNAL_SYSTEM_SEARCHUNIFY",
"searchunify_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SERVICE_NOW

Config block: service_now_config

ServiceNow connection settings, used when system is EXTERNAL_SYSTEM_SERVICE_NOW. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardSnowUrlThe base URL of your ServiceNow instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA custom base URL for your ServiceNow instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format.
live_agent_tokenstringToken used to authenticate to the ServiceNow Virtual Agent API to start a conversation with a live agent. Secret: always returned masked as *****.
basic_authBasicAuthenticationBasic authentication with the username and password of a ServiceNow service account. Set exactly one authentication method.
oauth2_passwordOAuth2PasswordGrantOAuth 2.0 password grant using a client ID and secret plus a ServiceNow username and password. Set exactly one authentication method.
oauth2_refreshOAuth2RefreshTokenOAuth 2.0 refresh token grant using a client ID, client secret, and refresh token. Set exactly one authentication method.
oauth2_jwtOAuth2JWTBearerOAuth 2.0 JWT bearer grant signed with a private key registered in your ServiceNow instance. Set exactly one authentication method.
external_authExternalAuthExternally managed token authentication. Read-only; it cannot be set through this API.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to ServiceNow. Set exactly one authentication method.
oauth2_jwt_grantOAuth2JWTBearerGrantDeprecated JWT grant. Read-only; it cannot be set through this API. Use oauth2_jwt instead.
live_search_authOAuth2ClientCredentialsOptional OAuth 2.0 client credentials used for live search against ServiceNow.

Example create body:

{
"name": "service_now_connector",
"system": "EXTERNAL_SYSTEM_SERVICE_NOW",
"service_now_config": {
"standard_url": {
"scheme": "https://",
"sub_domain": "acme",
"domain": ".service-now.com"
},
"basic_auth": {
"username": "svc.moveworks",
"password": "<secret>"
}
},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SHAREPOINT_MSGRAPH

Config block: sharepoint_msgraph_config

SharePoint Online via Microsoft Graph connection settings, used when system is EXTERNAL_SYSTEM_SHAREPOINT_MSGRAPH. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardSharepointMsgraphUrlThe base URL of your SharePoint instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA custom base URL for your SharePoint instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format.
tenant_idstringYour Microsoft Entra (Azure AD) tenant ID.
regionstringThe Microsoft cloud environment used to build the base URL. Allowed values: COMMERCIAL, GOV L4. Defaults to COMMERCIAL if not set.
app_store_authSharepointMsgraphAppStoreAuthAuthentication through the Moveworks app installed from the Microsoft app store. Takes no parameters. Set exactly one authentication method.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and secret of an app registered in Microsoft Entra. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to SharePoint. Set exactly one authentication method.

Example create body:

{
"name": "sharepoint_msgraph_connector",
"system": "EXTERNAL_SYSTEM_SHAREPOINT_MSGRAPH",
"sharepoint_msgraph_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SHAREPOINT_ONEDRIVE

Config block: sharepoint_onedrive_config

SharePoint and OneDrive connection settings, used when system is EXTERNAL_SYSTEM_SHAREPOINT_ONEDRIVE. Set exactly one system-specific config.

FieldTypeRequiredNotes
tenant_idstringYour Microsoft Entra (Azure AD) tenant ID that uniquely identifies your organization. Required. Checked when saved.
regionstringYour Microsoft cloud environment: COMMERCIAL (login.microsoftonline.com) or GOV L4 (login.microsoftonline.us). Defaults to COMMERCIAL if not set.
tenant_domainsarray<string>The SharePoint tenant domains to ingest data from, for example ‘contoso’ for contoso.sharepoint.com. At least one is required.
server_to_server_app_registrationSharepointOneDriveServerToServerAppRegistrationCertificate-based app registration for accessing SharePoint data without user interaction.
user_consent_app_registrationSharepointOneDriveUserConsentAppRegistrationOptional app registration for user-delegated access, allowing search on behalf of authenticated users in SharePoint and OneDrive.

Example create body:

{
"name": "sharepoint_onedrive_connector",
"system": "EXTERNAL_SYSTEM_SHAREPOINT_ONEDRIVE",
"sharepoint_onedrive_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SHAREPOINT_ONLINE

Config block: sharepoint_online_config

SharePoint Online (classic method) connection settings, used when system is EXTERNAL_SYSTEM_SHAREPOINT_ONLINE. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardSharepointOnlineUrlThe base URL of your SharePoint Online site, given as scheme, subdomain, and domain. The subdomain is required.
tenant_idstringYour Microsoft Entra (Azure AD) tenant ID.
oauth2_jwtSharepointOnlineOAuth2JwtBearerOAuth 2.0 JWT grant using a certificate uploaded to your Microsoft Entra app registration. Set exactly one authentication method.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and secret of an app registered in Microsoft Entra. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to SharePoint Online. Set exactly one authentication method.
app_store_authSharepointOnlineAppStoreAuthAuthentication through the Moveworks app installed from the Microsoft app store. Takes no parameters. Set exactly one authentication method.

Set at most one of oauth2_jwt, oauth2_client_credentials, on_prem_auth, app_store_auth.

Example create body:

{
"name": "sharepoint_online_connector",
"system": "EXTERNAL_SYSTEM_SHAREPOINT_ONLINE",
"sharepoint_online_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_SIMPPLR

Config block: simpplr_config

Simpplr connection settings, used when system is EXTERNAL_SYSTEM_SIMPPLR. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardSimpplrUrlThe base URL of your Simpplr instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA custom base URL for your Simpplr instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format.
is_sandbox_instancebooleanIf true, the connector targets a sandbox instance instead of production.
simpplr_oauth2_jwt_grantSimpplrOAuth2JwtGrantOAuth 2.0 JWT grant using a connected app and a service account. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to Simpplr. Set exactly one authentication method.

Example create body:

{
"name": "simpplr_connector",
"system": "EXTERNAL_SYSTEM_SIMPPLR",
"simpplr_config": {},
"version": {
"change_description": "Initial version."
}
}