ConfigurationCredentialProvider Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.BotFramework

Assemblies:: Microsoft.Bot.Builder.Integration.AspNet.Core.dll, Microsoft.Bot.Builder.Integration.AspNet.WebApi.dll

Packages:: Microsoft.Bot.Builder.Integration.AspNet.Core v4.18.1, Microsoft.Bot.Builder.Integration.AspNet.WebApi v4.18.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Use ConfigurationBotFrameworkAuthentication instead to configure credentials.

Loads credentials from the AppSettings.

[System.Obsolete("Use `ConfigurationBotFrameworkAuthentication` instead to configure credentials.", false)]
public sealed class ConfigurationCredentialProvider : Microsoft.Bot.Connector.Authentication.SimpleCredentialProvider

[<System.Obsolete("Use `ConfigurationBotFrameworkAuthentication` instead to configure credentials.", false)>]
type ConfigurationCredentialProvider = class
    inherit SimpleCredentialProvider

Public NotInheritable Class ConfigurationCredentialProvider
Inherits SimpleCredentialProvider

Inheritance: Object

SimpleCredentialProvider
ConfigurationCredentialProvider

Attributes: ObsoleteAttribute

Remarks

This will populate the AppId from an app setting entry with the key of MicrosoftAppIdKey and the Password from an app setting with the key of MicrosoftAppPasswordKey.

NOTE: if the keys are not present, a null value will be used.

Constructors

ConfigurationCredentialProvider()	Initializes a new instance of the ConfigurationCredentialProvider class.
ConfigurationCredentialProvider(IConfiguration)	Initializes a new instance of the ConfigurationCredentialProvider class.

Properties

AppId	Gets or sets the app ID for this credential. (Inherited from SimpleCredentialProvider)
Password	Gets or sets the app password for this credential. (Inherited from SimpleCredentialProvider)

Methods

GetAppPasswordAsync(String)	Gets the app password for a given bot app ID. (Inherited from SimpleCredentialProvider)
IsAuthenticationDisabledAsync()	Checks whether bot authentication is disabled. (Inherited from SimpleCredentialProvider)
IsValidAppIdAsync(String)	Validates an app ID. (Inherited from SimpleCredentialProvider)

Applies to