ParameterizedBotFrameworkAuthentication class
- Extends
コンストラクター
メソッド
authenticate |
|
authenticate |
Bot Framework プロトコル要求を検証します。 |
authenticate |
Bot Framework プロトコル要求を検証します。 |
create |
Skills の呼び出しに使用される BotFrameworkClient を作成します。 |
create |
この特定のクラウド環境の資格情報を使用できる ConnectorClient を作成するために使用できる ConnectorFactory を作成します。 |
create |
適切な UserTokenClient インスタンスを作成します。 |
get |
Bot OAuth スコープから送信元の対象ユーザーを取得します。 |
コンストラクターの詳細
ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)
new ParameterizedBotFrameworkAuthentication(validateAuthority: boolean, toChannelFromBotLoginUrl: string, toChannelFromBotOAuthScope: string, toBotFromChannelTokenIssuer: string, oAuthUrl: string, toBotFromChannelOpenIdMetadataUrl: string, toBotFromEmulatorOpenIdMetadataUrl: string, callerId: string, credentialsFactory: ServiceClientCredentialsFactory, authConfiguration: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)
パラメーター
- validateAuthority
-
boolean
使用する検証機関の値。
- toChannelFromBotLoginUrl
-
string
ボットのログイン URL からチャネルに移動します。
- toChannelFromBotOAuthScope
-
string
ボットの oauth スコープからチャネルに移動します。
- toBotFromChannelTokenIssuer
-
string
チャネル トークン発行者からボットへ。
- oAuthUrl
-
string
OAuth URL。
- toBotFromChannelOpenIdMetadataUrl
-
string
Channel Open ID メタデータ URL からボットへ。
- toBotFromEmulatorOpenIdMetadataUrl
-
string
エミュレーターの Open Id メタデータ URL からボットへ。
- callerId
-
string
認証済みの アクティビティに設定された callerId。
- credentialsFactory
- ServiceClientCredentialsFactory
資格情報の作成に使用する ServiceClientCredentialsFactory。
- authConfiguration
- AuthenticationConfiguration
- botFrameworkClientFetch
-
(input: RequestInfo, init?: RequestInit) => Promise<Response>
BotFrameworkClient で使用するフェッチ。
- connectorClientOptions
- ConnectorClientOptions
ConnectorClientOptions ConnectorClients の作成時に使用します。
メソッドの詳細
authenticateChannelRequest(string)
function authenticateChannelRequest(authHeader: string): Promise<ClaimsIdentity>
パラメーター
- authHeader
-
string
スキル要求で受信した http 認証ヘッダー。
戻り値
Promise<ClaimsIdentity>
ID 検証の結果。
authenticateRequest(Activity, string)
Bot Framework プロトコル要求を検証します。
function authenticateRequest(activity: Activity, authHeader: string): Promise<AuthenticateRequestResult>
パラメーター
- activity
-
Activity
受信アクティビティ。
- authHeader
-
string
スキル要求で受信した http 認証ヘッダー。
戻り値
Promise<AuthenticateRequestResult>
AuthenticateRequestResult を使用した Promise。
authenticateStreamingRequest(string, string)
Bot Framework プロトコル要求を検証します。
function authenticateStreamingRequest(authHeader: string, channelIdHeader: string): Promise<AuthenticateRequestResult>
パラメーター
- authHeader
-
string
スキル要求で受信した http 認証ヘッダー。
- channelIdHeader
-
string
チャネル ID HTTP ヘッダー。
戻り値
Promise<AuthenticateRequestResult>
AuthenticateRequestResult を使用した Promise。
createBotFrameworkClient()
Skills の呼び出しに使用される BotFrameworkClient を作成します。
function createBotFrameworkClient(): BotFrameworkClient
戻り値
Skills を呼び出す BotFrameworkClient インスタンス。
createConnectorFactory(ClaimsIdentity)
この特定のクラウド環境の資格情報を使用できる ConnectorClient を作成するために使用できる ConnectorFactory を作成します。
function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory
パラメーター
- claimsIdentity
- ClaimsIdentity
受信アクティビティの ClaimsIdentity。
戻り値
ConnectorFactory。
createUserTokenClient(ClaimsIdentity)
適切な UserTokenClient インスタンスを作成します。
function createUserTokenClient(claimsIdentity: ClaimsIdentity): Promise<UserTokenClient>
パラメーター
- claimsIdentity
- ClaimsIdentity
受信アクティビティの ClaimsIdentity。
戻り値
Promise<UserTokenClient>
UserTokenClient インスタンスを使用した Promise。
getOriginatingAudience()
Bot OAuth スコープから送信元の対象ユーザーを取得します。
function getOriginatingAudience(): string
戻り値
string
発信元の対象ユーザー。