Utility class

Classe utilitaire fournissant des méthodes d’assistance pour les opérations d’exécution de l’agent.

Méthodes

getAgentIdFromToken(string)

AVERTISSEMENT : AUCUNE VÉRIFICATION DE SIGNATURE - Cette méthode utilise jwt.decode() qui ne vérifie PAS la signature du jeton. Les revendications de jeton peuvent être usurpées par des acteurs malveillants. Cette méthode convient uniquement à la journalisation, à l’analytique et aux diagnostics. N’utilisez PAS la valeur retournée pour les décisions d’autorisation, de contrôle d’accès ou de sécurité.

Décode le jeton et récupère le meilleur identificateur d’agent disponible. Vérifie les revendications dans l’ordre de priorité : xms_par_app_azp (ID de blueprint de l’agent) > appid > azp.

Remarque : retourne une chaîne vide pour les jetons vides/manquants (contrairement à GetAppIdFromToken qui retourne un GUID par défaut). Cela permet aux appelants d’omettre les en-têtes lorsqu’aucun identificateur n’est disponible.

GetAppIdFromToken(string)

AVERTISSEMENT : AUCUNE VÉRIFICATION DE SIGNATURE - Cette méthode utilise jwt.decode() qui ne vérifie PAS la signature du jeton. Les revendications de jeton peuvent être usurpées par des acteurs malveillants. Cette méthode convient uniquement à la journalisation, à l’analytique et aux diagnostics. N’utilisez PAS la valeur retournée pour les décisions d’autorisation, de contrôle d’accès ou de sécurité.

Décode le jeton actuel et récupère l’ID d’application (appid ou revendication azp).

Remarque : Retourne un GUID par défaut ('0000000-0000-0000-0000-0000000000000') pour les jetons vides pour une compatibilité descendante avec les appelants qui attendent un GUID valide. Pour l’identification de l’agent où une chaîne vide est préférée, utilisez getAgentIdFromToken.

getApplicationName()

Obtient le nom de l’application à partir de npm_package_name variable d’environnement ou package.json. Le résultat package.json est mis en cache au moment du chargement du module pour éviter les E/S de synchronisation pendant les requêtes.

GetUserAgentHeader(string)

Génère une chaîne d’en-tête User-Agent contenant la version du SDK, le type de système d’exploitation, la version Node.js et l’orchestrateur.

ResolveAgentIdentity(TurnContext, string)

Résout l’identité de l’agent à partir du contexte de tour ou du jeton d’authentification.

Détails de la méthode

getAgentIdFromToken(string)

AVERTISSEMENT : AUCUNE VÉRIFICATION DE SIGNATURE - Cette méthode utilise jwt.decode() qui ne vérifie PAS la signature du jeton. Les revendications de jeton peuvent être usurpées par des acteurs malveillants. Cette méthode convient uniquement à la journalisation, à l’analytique et aux diagnostics. N’utilisez PAS la valeur retournée pour les décisions d’autorisation, de contrôle d’accès ou de sécurité.

Décode le jeton et récupère le meilleur identificateur d’agent disponible. Vérifie les revendications dans l’ordre de priorité : xms_par_app_azp (ID de blueprint de l’agent) > appid > azp.

Remarque : retourne une chaîne vide pour les jetons vides/manquants (contrairement à GetAppIdFromToken qui retourne un GUID par défaut). Cela permet aux appelants d’omettre les en-têtes lorsqu’aucun identificateur n’est disponible.

static function getAgentIdFromToken(token: string): string

Paramètres

token

string

Jeton JWT à décoder

Retours

string

ID de l’agent (GUID) ou chaîne vide s’il n’est pas trouvé ou si le jeton est vide

GetAppIdFromToken(string)

AVERTISSEMENT : AUCUNE VÉRIFICATION DE SIGNATURE - Cette méthode utilise jwt.decode() qui ne vérifie PAS la signature du jeton. Les revendications de jeton peuvent être usurpées par des acteurs malveillants. Cette méthode convient uniquement à la journalisation, à l’analytique et aux diagnostics. N’utilisez PAS la valeur retournée pour les décisions d’autorisation, de contrôle d’accès ou de sécurité.

Décode le jeton actuel et récupère l’ID d’application (appid ou revendication azp).

Remarque : Retourne un GUID par défaut ('0000000-0000-0000-0000-0000000000000') pour les jetons vides pour une compatibilité descendante avec les appelants qui attendent un GUID valide. Pour l’identification de l’agent où une chaîne vide est préférée, utilisez getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Paramètres

token

string

Jeton à décoder

Retours

string

AppId ou GUID par défaut pour un jeton vide ou une chaîne vide en cas d’échec du décodage

getApplicationName()

Obtient le nom de l’application à partir de npm_package_name variable d’environnement ou package.json. Le résultat package.json est mis en cache au moment du chargement du module pour éviter les E/S de synchronisation pendant les requêtes.

static function getApplicationName(): undefined | string

Retours

undefined | string

Nom de l’application ou non défini s’il n’est pas disponible.

GetUserAgentHeader(string)

Génère une chaîne d’en-tête User-Agent contenant la version du SDK, le type de système d’exploitation, la version Node.js et l’orchestrateur.

static function GetUserAgentHeader(orchestrator?: string): string

Paramètres

orchestrator

string

Identificateur d’orchestrateur facultatif à inclure dans la chaîne User-Agent.

Retours

string

Chaîne d’en-tête mise en forme User-Agent.

ResolveAgentIdentity(TurnContext, string)

Résout l’identité de l’agent à partir du contexte de tour ou du jeton d’authentification.

static function ResolveAgentIdentity(context: TurnContext, authToken: string): string

Paramètres

context
TurnContext

Tournez le contexte du tour.

authToken

string

Jeton d’authentification s’il est disponible.

Retours

string

Identité de l’agent (ID d’application)