Schema Explorer

Choose element:

Important note about accessibility: In version 1.3 of the schema we introduced a label property on Inputs to improve accessibility. If the Host app you are targetting supports v1.3 you should use label instead of a TextBlock as seen in some samples below. Once most Host apps have updated to the latest version we will update the samples accordingly.

Authentication

Defines authentication information associated with a card. This maps to the OAuthCard type defined by the Bot Framework (https://github.com/microsoft/botframework-obi/blob/jeffders/adaptiveCards2/protocols/botframework-activity/botframework-cards.md#oauth-card)

Introduced in version 1.4

Property Type Required Description Version
text string No Text that can be displayed to the end user when prompting them to authenticate. 1.4
connectionName string No The identifier for registered OAuth connection setting information. 1.4
tokenExchangeResource TokenExchangeResource No Provides information required to enable on-behalf-of single sign-on user authentication. 1.4
buttons AuthCardButton[] No 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. 1.4

Properties

text

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

  • Type: string
  • Required: No

connectionName

The identifier for registered OAuth connection setting information.

  • Type: string
  • Required: No

tokenExchangeResource

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

  • Type: TokenExchangeResource
  • Required: No
  • Allowed values:
    • TokenExchangeResource

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.

  • Type: AuthCardButton[]
  • Required: No
  • Allowed values:
    • AuthCardButton