Edit

Share via

ICredentialProvider interface

  • Reference
Package:
botframework-connector

Warning

This API is now deprecated.

Use ConfigurationBotFrameworkAuthentication instead to configure credentials. CredentialProvider interface. This interface allows Bots to provide their own implementation of what is, and what is not, a valid appId and password. This is useful in the case of multi-tenant bots, where the bot may need to call out to a service to determine if a particular appid/password pair is valid.

For Single Tenant bots (the vast majority) the simple static providers are sufficient.

Methods

getAppPassword(string)

Get the app password for a given bot appId, if it is not a valid appId, return Null This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair.
isAuthenticationDisabled()

Checks if bot authentication is disabled. Return true if bot authentication is disabled. This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair.
isValidAppId(string)

Validate AppId. This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair.

Method Details

getAppPassword(string)

Get the app password for a given bot appId, if it is not a valid appId, return Null This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair.

function getAppPassword(appId: string): Promise<string | null>

Parameters

appId

string

bot appid

Returns

Promise<string | null>

password or null for invalid appid

isAuthenticationDisabled()

Checks if bot authentication is disabled. Return true if bot authentication is disabled. This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair.

function isAuthenticationDisabled(): Promise<boolean>

Returns

Promise<boolean>

true if bot authentication is disabled.

isValidAppId(string)

Validate AppId. This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair.

function isValidAppId(appId: string): Promise<boolean>

Parameters

appId

string

bot appid

Returns

Promise<boolean>

true if it is a valid AppId