Share via

AuthProvider interface

Package:
@microsoft/agents-hosting

Represents an authentication provider.

Properties

getAccessToken

Gets an access token for the specified authentication configuration and scope.
getAgenticApplicationToken

Get an access token for the agentic application
getAgenticInstanceToken

Get an access token for the agentic instance
getAgenticUserToken

Get an access token for the agentic user

Methods

acquireTokenOnBehalfOf(AuthConfiguration | string[], string | string[], string)
acquireTokenOnBehalfOf(AuthConfiguration, string[], string)
acquireTokenOnBehalfOf(string[], string)

Property Details

getAccessToken

Gets an access token for the specified authentication configuration and scope.

getAccessToken: (authConfig: AuthConfiguration, scope: string) => Promise<string>

Property Value

(authConfig: AuthConfiguration, scope: string) => Promise<string>

getAgenticApplicationToken

Get an access token for the agentic application

getAgenticApplicationToken: (tenantId: string, agentAppInstanceId: string) => Promise<string>

Property Value

(tenantId: string, agentAppInstanceId: string) => Promise<string>

getAgenticInstanceToken

Get an access token for the agentic instance

getAgenticInstanceToken: (tenantId: string, agentAppInstanceId: string) => Promise<string>

Property Value

(tenantId: string, agentAppInstanceId: string) => Promise<string>

getAgenticUserToken

Get an access token for the agentic user

getAgenticUserToken: (tenantId: string, agentAppInstanceId: string, upn: string, scopes: string[]) => Promise<string>

Property Value

(tenantId: string, agentAppInstanceId: string, upn: string, scopes: string[]) => Promise<string>

Method Details

acquireTokenOnBehalfOf(AuthConfiguration | string[], string | string[], string) 

function acquireTokenOnBehalfOf(authConfigOrScopes: AuthConfiguration | string[], scopesOrOboAssertion?: string | string[], oboAssertion?: string): Promise<string>

Parameters

authConfigOrScopes

AuthConfiguration | string[]

scopesOrOboAssertion

string | string[]

oboAssertion

string

Returns

Promise<string>

acquireTokenOnBehalfOf(AuthConfiguration, string[], string) 

function acquireTokenOnBehalfOf(authConfig: AuthConfiguration, scopes: string[], oboAssertion: string): Promise<string>

Parameters

authConfig
AuthConfiguration
scopes

string[]

oboAssertion

string

Returns

Promise<string>

acquireTokenOnBehalfOf(string[], string) 

function acquireTokenOnBehalfOf(scopes: string[], oboAssertion: string): Promise<string>

Parameters

scopes

string[]

oboAssertion

string

Returns

Promise<string>