OAuthSettings Class

Definition

The settings for OAuthAuthentication.

public class OAuthSettings : Microsoft.Agents.Builder.UserAuth.OBOSettings
type OAuthSettings = class
    inherit OBOSettings
Public Class OAuthSettings
Inherits OBOSettings
Inheritance
OAuthSettings
Derived

Constructors

Name Description
OAuthSettings()

Fields

Name Description
DefaultTimeoutValue

The default timeout for the exchange.

Properties

Name Description
AzureBotOAuthConnectionName

Gets or sets the name of the OAuth Connection defined on the Azure Bot.

EnableSso

Set to true to enable SSO when authenticating using Azure Active Directory (AAD).

EndOnInvalidMessage

Gets or sets a value indicating whether the OAuthPrompt should end upon receiving an invalid message. Generally the OAuthPrompt will ignore incoming messages from the user during the auth flow, if they are not related to the auth flow. This flag enables ending the OAuthPrompt rather than ignoring the user's message. Typically, this flag will be set to 'true', but is 'false' by default for backwards compatibility.

InvalidSignInRetryMax
InvalidSignInRetryMessage
OBOConnectionName (Inherited from OBOSettings)
OBOScopes (Inherited from OBOSettings)
ShowSignInLink

Gets or sets an optional boolean value to force the display of a Sign In link overriding the default behavior.

Text

Gets or sets any additional text to include in the sign-in card.

Timeout

Gets or sets the number of milliseconds the prompt waits for the user to authenticate. Default is DefaultTimeoutValue.

Title

Gets or sets the title of the sign-in card.

Applies to