ApiKeyAuthenticator

Authenticator for requests authenticated with an API token injected as an HTTP request header.

• type: object
• required: ["type"]

type

• Required: Yes
• type: string
• enum: ["ApiKeyAuthenticator"]

api_token

The API key to inject in the request. Fill it in the user inputs.

• Required: No
• type: string
• Available variables: config

Examples:

{{ config['api_key'] }}

Token token={{ config['api_key'] }}

header

The name of the HTTP header that will be set to the API key. This setting is deprecated, use inject_into instead. Header and inject_into can not be defined at the same time.

• Required: No
• type: string
• Available variables: config

Examples:

Authorization

Api-Token

X-Auth-Token

inject_into

Configure how the API Key will be sent in requests to the source API. Either inject_into or header has to be defined.

• Required: No
• Allowed type: RequestOption

Examples:

inject_into: header
field_name: Authorization

inject_into: request_parameter
field_name: authKey

$parameters

• Required: No
• type: object