AgenticTokenCache class

Package:

@microsoft/opentelemetry

Cache for agentic authentication tokens used by observability services.

Example

// Use the default singleton:
import { AgenticTokenCacheInstance } from '@microsoft/opentelemetry';

// Or create an instance with custom scopes:
const cache = new AgenticTokenCache({ authScopes: ['api://my-scope/.default'] });

Constructors

AgenticTokenCache(AgenticTokenCacheOptions)

Methods

getObservabilityToken(string, string)
invalidateAll()
invalidateToken(string, string)
makeKey(string, string)
refreshObservabilityToken(string, string, TurnContextLike, AuthorizationLike, string[], string)

Constructor Details

AgenticTokenCache(AgenticTokenCacheOptions)

new AgenticTokenCache(options?: AgenticTokenCacheOptions)

Parameters

options

AgenticTokenCacheOptions

Method Details

getObservabilityToken(string, string)

function getObservabilityToken(agentId: string, tenantId: string): null | string

Parameters

agentId

string

tenantId

string

Returns

null | string

invalidateAll()

function invalidateAll()

invalidateToken(string, string)

function invalidateToken(agentId: string, tenantId: string)

Parameters

agentId

string

tenantId

string

makeKey(string, string)

static function makeKey(agentId: string, tenantId: string): string

Parameters

agentId

string

tenantId

string

Returns

string

refreshObservabilityToken(string, string, TurnContextLike, AuthorizationLike, string[], string)

function refreshObservabilityToken(agentId: string, tenantId: string, turnContext: TurnContextLike, authorization: AuthorizationLike, scopes?: string[], authHandlerName?: string): Promise<void>

Parameters

agentId

string

tenantId

string

turnContext

TurnContextLike

authorization

AuthorizationLike

scopes

string[]

authHandlerName

string

Returns

Promise<void>