botframework-connector package

Classes

AppCredentials

General AppCredentials auth implementation and cache. Supports any ADAL client credential flow. Subclasses can implement refreshToken to acquire the token.

AuthenticationConfiguration

General configuration settings for authentication.

AuthenticationError

General AuthenticationError class to represent an Authentication error with a Code Status.

BotFrameworkAuthentication

Represents a Cloud Environment used to authenticate Bot Framework Protocol network calls within this environment.

BotFrameworkAuthenticationFactory

A factory for BotFrameworkAuthentication which encapsulates the environment specific Bot Framework Protocol auth code.

BotFrameworkClientImpl
CertificateAppCredentials

CertificateAppCredentials auth implementation

ClaimsIdentity

Represents a claims-based identity.

ConnectorFactory

A factory class used to create ConnectorClients with appropriate credentials for the current appId.

ConnectorFactoryImpl
SimpleCredentialProvider
EndorsementsValidator

Contains helper methods for verifying JWT endorsements.

JwtTokenExtractor

A JWT token processing class that gets identity information and performs security token validation.

JwtTokenProviderFactory
ManagedIdentityAppCredentials

Managed Service Identity auth implementation.

ManagedIdentityAuthenticator

Abstraction to acquire tokens from a Managed Service Identity.

ManagedIdentityServiceClientCredentialsFactory

A Managed Identity implementation of the ServiceClientCredentialsFactory abstract class.

MicrosoftAppCredentials

MicrosoftAppCredentials auth implementation

OpenIdMetadata

Class in charge of manage OpenId metadata.

ParameterizedBotFrameworkAuthentication
PasswordServiceClientCredentialFactory

A simple implementation of the ServiceClientCredentialsFactory interface.

ServiceClientCredentialsFactory

The ServiceClientCredentialsFactory abstract class that allows Bots to provide their own ServiceClientCredentials for bot to bot channel or skill bot to parent bot calls.

UserTokenClient

Client for access user token service.

UserTokenClientImpl
ConnectorClient
ConnectorClientContext
Attachments

Class representing a Attachments.

Conversations

Class representing a Conversations.

EmulatorApiClient

The purpose of this class is to emulate an api client.

Teams

Class representing a Teams.

ReadReceiptInfo

General information about a read receipt.

TeamsConnectorClient
TeamsConnectorClientContext

The Bot Connector REST API extension for Microsoft Teams allows your bot to perform extended operations on the Microsoft Teams channel configured in the Bot Framework Developer Portal. The Connector service uses industry-standard REST and JSON over HTTPS.

BotSignIn

Class representing a BotSignIn.

UserToken

Class representing a UserToken.

TokenApiClient
TokenApiClientContext

Interfaces

Claim

Represents a claim.

ICredentialProvider
IJwtTokenProviderFactory
IOpenIdMetadataKey
ConnectorClientOptions

An interface representing ConnectorClientOptions.

ConversationsGetConversationPagedMembersOptionalParams
ConversationsGetConversationsOptionalParams

Optional Parameters.

BotFrameworkClient
TeamsConnectorClientOptions
TeamsFetchMeetingParticipantOptionalParams
AadResourceUrls
BotSignInGetSignInResourceOptionalParams
BotSignInGetSignInUrlOptionalParams
ErrorModel
ErrorResponse
InnerHttpError
TokenApiClientOptions
UserTokenGetAadTokensOptionalParams
UserTokenGetTokenOptionalParams
UserTokenGetTokenStatusOptionalParams
UserTokenSignOutOptionalParams

Type Aliases

AuthenticateRequestResult

The result from a call to authenticate a Bot Framework Protocol request.

ValidateClaims

Used to validate a list of Claims and should throw an exception if the validation fails.

StatusCode
AttachmentsGetAttachmentInfoResponse

Contains response data for the getAttachmentInfo operation.

AttachmentsGetAttachmentResponse

Contains response data for the getAttachment operation.

ConversationsCreateConversationResponse

Contains response data for the createConversation operation.

ConversationsGetActivityMembersResponse

Contains response data for the getActivityMembers operation.

ConversationsGetConversationMemberResponse

Contains response data for the getConversationMember operation.

ConversationsGetConversationMembersResponse

Contains response data for the getConversationMembers operation.

ConversationsGetConversationPagedMembersResponse

Contains response data for the getConversationPagedMembers operation.

ConversationsGetConversationsResponse

Contains response data for the getConversations operation.

ConversationsReplyToActivityResponse

Contains response data for the replyToActivity operation.

ConversationsSendConversationHistoryResponse

Contains response data for the sendConversationHistory operation.

ConversationsSendToConversationResponse

Contains response data for the sendToConversation operation.

ConversationsUpdateActivityResponse

Contains response data for the updateActivity operation.

ConversationsUploadAttachmentResponse

Contains response data for the uploadAttachment operation.

TeamsFetchChannelListResponse

Contains response data for the fetchChannelList operation.

TeamsFetchMeetingParticipantResponse

Contains response data for the fetchMeetingParticipant operation.

TeamsFetchTeamDetailsResponse

Contains response data for the fetchTeamDetails operation.

TeamsMeetingInfoResponse

Contains response data for the fetchMeetingInfo operation.

BotSignInGetSignInResourceResponse

Contains response data for the getSignInResource operation.

BotSignInGetSignInUrlResponse

Contains response data for the getSignInUrl operation.

UserTokenExchangeAsyncResponse

Contains response data for the exchangeAsync operation.

UserTokenGetAadTokensResponse

Contains response data for the getAadTokens operation.

UserTokenGetTokenResponse

Contains response data for the getToken operation.

UserTokenGetTokenStatusResponse

Contains response data for the getTokenStatus operation.

UserTokenSignOutResponse

Contains response data for the signOut operation.

Functions

allowedCallersClaimsValidator(string[])

Create an allowe callers claims validator

Function Details

allowedCallersClaimsValidator(string[])

Create an allowe callers claims validator

function allowedCallersClaimsValidator(allowedCallers: string[]): ValidateClaims

Parameters

allowedCallers

string[]

allowed callers of skill

Returns

claims validator function