Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CodelessConnectorPollingAuthProperties

Package version

Describe the authentication properties needed to successfully authenticate with the server

Hierarchy

  • CodelessConnectorPollingAuthProperties

Index

Properties

Optional apiKeyIdentifier

apiKeyIdentifier: undefined | string

A prefix send in the header before the actual token

Optional apiKeyName

apiKeyName: undefined | string

The header name which the token is sent with

authType

authType: string

The authentication type

Optional authorizationEndpoint

authorizationEndpoint: undefined | string

The endpoint used to authorize the user, used in Oauth 2.0 flow

Optional authorizationEndpointQueryParameters

authorizationEndpointQueryParameters: Record<string, unknown>

The query parameters used in authorization request, used in Oauth 2.0 flow

Optional flowName

flowName: undefined | string

Describes the flow name, for example 'AuthCode' for Oauth 2.0

Optional isApiKeyInPostPayload

isApiKeyInPostPayload: undefined | string

Marks if the key should sent in header

Optional isClientSecretInHeader

isClientSecretInHeader: undefined | false | true

Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow

Optional redirectionEndpoint

redirectionEndpoint: undefined | string

The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow

Optional scope

scope: undefined | string

The OAuth token scope

Optional tokenEndpoint

tokenEndpoint: undefined | string

The endpoint used to issue a token, used in Oauth 2.0 flow

Optional tokenEndpointHeaders

tokenEndpointHeaders: Record<string, unknown>

The query headers used in token request, used in Oauth 2.0 flow

Optional tokenEndpointQueryParameters

tokenEndpointQueryParameters: Record<string, unknown>

The query parameters used in token request, used in Oauth 2.0 flow

Generated using TypeDoc