AzureBotAuthorizationOptionsLegacy interface

Package:
@microsoft/agents-hosting

Interface defining an authorization handler configuration.

Example

# For a handler with id "myAuth":
AgentApplication__UserAuthorization__handlers__myAuth__settings__azureBotOAuthConnectionName=MyConnection
AgentApplication__UserAuthorization__handlers__myAuth__settings__oboScopes=api://scope1 api://scope2

Remarks

Properties can be configured via environment variables (case-insensitive). Use the format: AgentApplication__UserAuthorization__handlers__{handlerId}__settings__{propertyName} where {handlerId} is the handler's unique identifier and {propertyName} matches the property name.

Properties

maxAttempts

Maximum number of attempts for entering the magic code. Defaults to 2.
messages

Messages to display for various authentication scenarios.
name

Connection name for the auth provider.
obo

Settings for on-behalf-of token acquisition.

Property Details

maxAttempts

Warning

This API is now deprecated.

Use invalidSignInRetryMax instead.

Maximum number of attempts for entering the magic code. Defaults to 2.

maxAttempts?: number

Property Value

number

Remarks

Env (legacy): {handlerId}_maxAttempts

messages

Warning

This API is now deprecated.

Use invalidSignInRetryMessage, invalidSignInRetryMessageFormat, and invalidSignInRetryMaxExceededMessage instead.

Messages to display for various authentication scenarios.

messages?: AzureBotAuthorizationOptionsMessages

Property Value

AzureBotAuthorizationOptionsMessages

Remarks

Env (legacy):

  • {handlerId}_messages_invalidCode
  • {handlerId}_messages_invalidCodeFormat
  • {handlerId}_messages_maxAttemptsExceeded

name

Warning

This API is now deprecated.

Use azureBotOAuthConnectionName instead.

Connection name for the auth provider.

name?: string

Property Value

string

Remarks

Env (legacy): {handlerId}_connectionName

obo

Warning

This API is now deprecated.

Use oboConnectionName and oboScopes instead.

Settings for on-behalf-of token acquisition.

obo?: AzureBotAuthorizationOptionsOBO

Property Value

AzureBotAuthorizationOptionsOBO

Remarks

Env (legacy):

  • {handlerId}_obo_connection
  • {handlerId}_obo_scopes (comma or space-separated)