Auth types - Kore.ai Docs

API Key

Field	Description
Profile Name	Required. A label for the profile, for example API Key - Production.
Description	Optional. Notes on what this profile is for or which service it connects to.
Usage Mode	Chooses how the profile is authorized. Preconfigured - the admin supplies credentials at setup time, and users don’t need to authorize.
Visible to project members	Toggle. When on, project members can use this profile.
Header Name	Required. The header the key is sent in, for example `X-API-Key`.
Placement	Chooses Header or Query Parameter.
Prefix	Optional. Text prepended to the key value.
API Key (Secrets)	Required. The key value.

Bearer Token

Field	Description
Profile Name	Required. A label for the profile, for example Bearer Token - Production.
Description	Optional. Notes on what this profile is for or which service it connects to.
Usage Mode	Chooses how the profile is authorized. Preconfigured - the admin supplies credentials at setup time, and users don’t need to authorize.
Visible to project members	Toggle. When on, project members can use this profile.
Authorization Prefix	Optional. Defaults to `Bearer`.
Token (Secrets)	Required. The bearer token value.

Basic Auth

Field	Description
Profile Name	Required. A label for the profile, for example Basic Auth - Production.
Description	Optional. Notes on what this profile is for or which service it connects to.
Usage Mode	Chooses how the profile is authorized. Preconfigured - the admin supplies credentials at setup time, and users don’t need to authorize.
Visible to project members	Toggle. When on, project members can use this profile.
Username (Secrets)	Required.
Password (Secrets)	Required.

Custom Header

Field	Description
Profile Name	Required. A label for the profile, for example Custom Header - Production.
Description	Optional. Notes on what this profile is for or which service it connects to.
Usage Mode	Chooses how the profile is authorized. Preconfigured - the admin supplies credentials at setup time, and users don’t need to authorize.
Visible to project members	Toggle. When on, project members can use this profile.
Headers	One or more header rows. Select + Add to add a row. Each row needs both a header name and a value; values are treated as secrets.

OAuth 2.0 App

Field	Description
Profile Name	Required. A label for the profile, for example OAuth 2.0 App - Production.
Description	Optional. Notes on what this profile is for or which service it connects to.
Usage Mode	Chooses how the profile is authorized. Preconfigured - the admin supplies credentials at setup time, and users don’t need to authorize. OAuth 2.0 App profiles support two additional modes, JIT and Preflight, which require a project-scoped profile.
Scope	Automatically derived from the selected Usage Mode. Defaults to Shared.
Visible to project members	Toggle. When on, project members can use this profile.

OAuth endpoints

Field	Description
Authorization URL	Required.
Token URL	Required.
Refresh URL	Optional. The endpoint used to request a new access token when the current one expires.
Scopes	Optional. Space-separated scopes, for example `read:users write:tasks offline_access`. Leave empty when the provider doesn’t require or advertise scopes.
Require PKCE	Toggle. Enable when the provider requires a proof key during authorization, including OAuth 2.1-compatible providers.
PKCE Challenge Method	Shown when Require PKCE is on. Defaults to S256 (Recommended).
Additional Authorization Parameters	Optional key=value pairs appended to the authorization URL. Select + Add to add a row.

Authorized redirect URI Copy the generated Callback URL and add it to the OAuth provider’s authorized redirect URIs (for example, Google Cloud Console or GitHub OAuth Apps). Secrets

Field	Description
Client ID	Required.
Client Secret	Required.