AuthProvider interface

Represents an authentication provider.

Properties

connectionSettings

The AuthConfiguration used for token acquisition.

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

Property Details

connectionSettings

The AuthConfiguration used for token acquisition.

connectionSettings?: AuthConfiguration

Property Value

getAgenticApplicationToken

Get an access token for the agentic application

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

Property Value

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

getAgenticInstanceToken

Get an access token for the agentic instance

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

Property Value

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

getAgenticUserToken

Get an access token for the agentic user

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

Property Value

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

Method Details

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

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

Parameters

authConfigOrScopes

AuthConfiguration | string[]

scopesOrOboAssertion

string | string[]

oboAssertion

string

Returns

Promise

acquireTokenOnBehalfOf(AuthConfiguration, string[], string)

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

Parameters

authConfig
AuthConfiguration
scopes

string[]

oboAssertion

string

Returns

Promise

acquireTokenOnBehalfOf(string[], string)

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

Parameters

scopes

string[]

oboAssertion

string

Returns

Promise

getAccessToken(AuthConfiguration, string)

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

function getAccessToken(authConfig: AuthConfiguration, scope: string): Promise

Parameters

authConfig
AuthConfiguration

The authentication configuration.

scope

string

The scope for which the access token is requested.

Returns

Promise

A promise that resolves to the access token.

getAccessToken(string | AuthConfiguration, string)

function getAccessToken(authConfigOrScope: string | AuthConfiguration, scope?: string): Promise

Parameters

authConfigOrScope

string | AuthConfiguration

scope

string

Returns

Promise

getAccessToken(string)

function getAccessToken(scope: string): Promise

Parameters

scope

string

Returns

Promise