CodelessConnectorPollingAuthProperties interface

サーバーで正常に認証するために必要な認証プロパティについて説明する

プロパティ

apiKeyIdentifier

実際のトークンの前にヘッダーで送信されるプレフィックス

apiKeyName

トークンが送信されるヘッダー名

authorizationEndpoint

Oauth 2.0 フローで使用されるユーザーの承認に使用されるエンドポイント

authorizationEndpointQueryParameters

Oauth 2.0 フローで使用される承認要求で使用されるクエリ パラメーター

authType

認証の種類

flowName

フロー名 (Oauth 2.0 の場合は "AuthCode" など) について説明します

isApiKeyInPostPayload

キーをヘッダーで送信する必要があるかどうかをマークします

isClientSecretInHeader

Oauth 2.0 フローで使用されるヘッダーまたはペイロードでクライアント シークレットを送信する必要があるかどうかをマークします

redirectionEndpoint

Oauth 2.0 フローで使用される承認コードを取得するリダイレクト エンドポイント

scope

OAuth トークン スコープ

tokenEndpoint

Oauth 2.0 フローで使用されるトークンの発行に使用されるエンドポイント

tokenEndpointHeaders

Oauth 2.0 フローで使用されるトークン要求で使用されるクエリ ヘッダー

tokenEndpointQueryParameters

Oauth 2.0 フローで使用されるトークン要求で使用されるクエリ パラメーター

プロパティの詳細

apiKeyIdentifier

実際のトークンの前にヘッダーで送信されるプレフィックス

apiKeyIdentifier?: string

プロパティ値

string

apiKeyName

トークンが送信されるヘッダー名

apiKeyName?: string

プロパティ値

string

authorizationEndpoint

Oauth 2.0 フローで使用されるユーザーの承認に使用されるエンドポイント

authorizationEndpoint?: string

プロパティ値

string

authorizationEndpointQueryParameters

Oauth 2.0 フローで使用される承認要求で使用されるクエリ パラメーター

authorizationEndpointQueryParameters?: Record<string, unknown>

プロパティ値

Record<string, unknown>

authType

認証の種類

authType: string

プロパティ値

string

flowName

フロー名 (Oauth 2.0 の場合は "AuthCode" など) について説明します

flowName?: string

プロパティ値

string

isApiKeyInPostPayload

キーをヘッダーで送信する必要があるかどうかをマークします

isApiKeyInPostPayload?: string

プロパティ値

string

isClientSecretInHeader

Oauth 2.0 フローで使用されるヘッダーまたはペイロードでクライアント シークレットを送信する必要があるかどうかをマークします

isClientSecretInHeader?: boolean

プロパティ値

boolean

redirectionEndpoint

Oauth 2.0 フローで使用される承認コードを取得するリダイレクト エンドポイント

redirectionEndpoint?: string

プロパティ値

string

scope

OAuth トークン スコープ

scope?: string

プロパティ値

string

tokenEndpoint

Oauth 2.0 フローで使用されるトークンの発行に使用されるエンドポイント

tokenEndpoint?: string

プロパティ値

string

tokenEndpointHeaders

Oauth 2.0 フローで使用されるトークン要求で使用されるクエリ ヘッダー

tokenEndpointHeaders?: Record<string, unknown>

プロパティ値

Record<string, unknown>

tokenEndpointQueryParameters

Oauth 2.0 フローで使用されるトークン要求で使用されるクエリ パラメーター

tokenEndpointQueryParameters?: Record<string, unknown>

プロパティ値

Record<string, unknown>