Share via


IAuth interface

Defines authentication information associated with a card. This maps to the OAuthCard type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.oauthcard)

Properties

buttons

Buttons that should be displayed to the user when prompting for authentication. The array MUST contain one button of type “signin”. Other button types are not currently supported.

connectionName

The identifier for registered OAuth connection setting information.

text

Text that can be displayed to the end user when prompting them to authenticate.

tokenExchangeResource

Provides information required to enable on-behalf-of single sign-on user authentication.

Property Details

buttons

Buttons that should be displayed to the user when prompting for authentication. The array MUST contain one button of type “signin”. Other button types are not currently supported.

buttons?: IAuthCardButton[]

Property Value

connectionName

The identifier for registered OAuth connection setting information.

connectionName?: string

Property Value

string

text

Text that can be displayed to the end user when prompting them to authenticate.

text?: string

Property Value

string

tokenExchangeResource

Provides information required to enable on-behalf-of single sign-on user authentication.

tokenExchangeResource?: ITokenExchangeResource

Property Value