Table of Contents

Interface IUserAuthorization

Namespace
Microsoft.Agents.Builder.UserAuth
Assembly
Microsoft.Agents.Builder.dll

Handles user sign-in and sign-out.

public interface IUserAuthorization

Properties

Name 

string Name { get; }

Property Value

string

Methods

ResetStateAsync(ITurnContext, CancellationToken)

Resets the sign in flow state.

Task ResetStateAsync(ITurnContext turnContext, CancellationToken cancellationToken = default)

Parameters

turnContext ITurnContext
cancellationToken CancellationToken

Returns

Task

SignInUserAsync(ITurnContext, bool, string, IList<string>, CancellationToken)

Signs in a user. This method will be called automatically by the AgentApplication class.

Task<string> SignInUserAsync(ITurnContext context, bool forceSignIn = false, string exchangeConnection = null, IList<string> exchangeScopes = null, CancellationToken cancellationToken = default)

Parameters

context ITurnContext

Current turn context.

forceSignIn bool
exchangeConnection string
exchangeScopes IList<string>
cancellationToken CancellationToken

The cancellation token

Returns

Task<string>

The authentication token if user is signed in. Otherwise returns null. In that case the Agent will attempt to sign the user in.

SignOutUserAsync(ITurnContext, CancellationToken)

Signs out a user.

Task SignOutUserAsync(ITurnContext context, CancellationToken cancellationToken = default)

Parameters

context ITurnContext

Current turn context.

cancellationToken CancellationToken

The cancellation token

Returns

Task