AzureBotAuthorizationOptions 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

azureBotOAuthConnectionName	Connection name for the auth provider.
enableSso	Option to enable SSO when authenticating using Azure Active Directory (AAD). Defaults to true.
invalidSignInRetryMax	Maximum number of attempts for entering the magic code. Defaults to 2.
invalidSignInRetryMaxExceededMessage	Message displayed when the maximum number of attempts is exceeded. Use {maxAttempts} as a placeholder to display the maximum number of attempts. Defaults to: 'You have exceeded the maximum number of sign-in attempts ({maxAttempts}).'
invalidSignInRetryMessage	Message displayed when an invalid code is entered. Use {code} as a placeholder to display the entered code. Defaults to: 'The code entered is invalid. Please sign-in again to continue.'
invalidSignInRetryMessageFormat	Message displayed when the entered code format is invalid. Use {attemptsLeft} as a placeholder to display the number of attempts left. Defaults to: 'Please enter a valid 6-digit code format (e.g. 123456).\r\n**{attemptsLeft} attempt(s) left...**'
oboConnectionName	Connection name to use for on-behalf-of token acquisition.
oboScopes	Scopes to request for on-behalf-of token acquisition.
text	Text to display on auth cards/UI.
title	Title to display on auth cards/UI.
type	The type of authorization handler. This property is optional and should not be set when configuring this handler. It is included here for completeness and type safety.

Property Details

azureBotOAuthConnectionName

Connection name for the auth provider.

azureBotOAuthConnectionName?: string

Property Value

string

enableSso

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

enableSso?: boolean

Property Value

boolean

invalidSignInRetryMax

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

invalidSignInRetryMax?: number

Property Value

number

invalidSignInRetryMaxExceededMessage

Message displayed when the maximum number of attempts is exceeded. Use {maxAttempts} as a placeholder to display the maximum number of attempts. Defaults to: 'You have exceeded the maximum number of sign-in attempts ({maxAttempts}).'

invalidSignInRetryMaxExceededMessage?: string

Property Value

string

invalidSignInRetryMessage

Message displayed when an invalid code is entered. Use {code} as a placeholder to display the entered code. Defaults to: 'The code entered is invalid. Please sign-in again to continue.'

invalidSignInRetryMessage?: string

Property Value

string

invalidSignInRetryMessageFormat

Message displayed when the entered code format is invalid. Use {attemptsLeft} as a placeholder to display the number of attempts left. Defaults to: 'Please enter a valid 6-digit code format (e.g. 123456).\r\n**{attemptsLeft} attempt(s) left...**'

invalidSignInRetryMessageFormat?: string

Property Value

string

oboConnectionName

Connection name to use for on-behalf-of token acquisition.

oboConnectionName?: string

Property Value

string

oboScopes

Scopes to request for on-behalf-of token acquisition.

oboScopes?: string[]

Property Value

string[]

Remarks

When set via environment variable, use comma or space-separated values (e.g. scope1,scope2 or scope1 scope2).

text

Text to display on auth cards/UI.

text?: string

Property Value

string

title

Title to display on auth cards/UI.

title?: string

Property Value

string

type

The type of authorization handler. This property is optional and should not be set when configuring this handler. It is included here for completeness and type safety.

type?: "AzureBotUserAuthorization"

Property Value

"AzureBotUserAuthorization"