getAuthType

This interface declares the authentication method used by your connector. The framework calls it once when it needs to understand how to authenticate the current user, and uses the return value to branch the entire auth flow — deciding whether to initiate an OAuth redirect or to collect static credentials via an API key form.

It is also called when the framework queries your connector's /implementedInterfaces endpoint to build a capability map. The auth type you return determines which companion interface the framework expects: getOauthInfo for OAuth connectors, or getBasicAuth for API key connectors.

When is this interface called?

When a user attempts to connect to the CRM for the first time
When the framework checks which interfaces your connector implements

Signature

function getAuthType({ proxyId, proxyConfig } = {}) {
  return 'oauth'; // or 'apiKey'
}

Existing connectors may define this with no parameters. The runtime can pass proxyId and proxyConfig when the connected user came from proxy mode.

Input parameters

A string literal indicating the auth method:

Value	Description
`"oauth"`	The CRM uses OAuth 2.0. The framework will call `getOauthInfo` to retrieve credentials and will manage the OAuth redirect flow.
`"apiKey"`	The CRM uses static credentials (API key, username/password, or similar). The framework will present the user with the credential form defined in `platform.auth.apiKey.page` and will call `getBasicAuth` to build the Authorization header.

Example

function getAuthType() {
  return 'oauth';
}

How auth type affects the rest of the connector

Returning "oauth" means you must also implement:

getOauthInfo — supplies OAuth credentials and token endpoint details
getUserInfo — called after the OAuth code exchange to fetch and store user details

Returning "apiKey" means you must also implement:

getBasicAuth — converts the user's submitted credentials into an Authorization header value
getUserInfo — called immediately after credential submission to verify them and fetch user details

In both cases getUserInfo is required. The difference is only in which pre-auth interface the framework calls to set up the request.

Return

Return one of:

Value	Runtime behavior
`oauth`	Core refreshes OAuth tokens when needed, builds `authHeader` as `Bearer <accessToken>`, and calls `getOauthInfo()` for token exchange details.
`apiKey`	Core calls `getBasicAuth({ apiKey: user.accessToken })`, then builds `authHeader` as `Basic <returned value>`.

Example

function getAuthType() {
  return 'apiKey';
}

module.exports = getAuthType;

Reference

TemplatePipedrive (OAuth)

function getAuthType() {
    return 'apiKey'; // Return either 'oauth' OR 'apiKey'
}

module.exports = getAuthType;

const { handleDatabaseError } = require('@app-connect/core/lib/errorHandler');

function getAuthType() {