Utility class

Пакет:

@microsoft/agents-a365-runtime

Класс служебной программы, предоставляющий вспомогательные методы для операций среды выполнения агента.

Методы

getAgentIdFromToken(string)	ПРЕДУПРЕЖДЕНИЕ: НЕТ ПРОВЕРКИ ПОДПИСИ . Этот метод использует jwt.decode(), который НЕ проверяет подпись токена. Утверждения токена могут быть спуфинированы вредоносными субъектами. Этот метод подходит ТОЛЬКО для ведения журнала, аналитики и диагностики. Не используйте возвращаемое значение для авторизации, контроля доступа или принятия решений по безопасности. Декодирует маркер и извлекает лучший идентификатор агента. Проверяет утверждения в порядке приоритета: xms_par_app_azp (идентификатор схемы агента) > appid > azp. Примечание. Возвращает пустую строку для пустых и отсутствующих маркеров (в отличие от GetAppIdFromToken , которая возвращает GUID по умолчанию). Это позволяет вызывающим пользователям опустить заголовки, если идентификатор недоступен.
GetAppIdFromToken(string)	ПРЕДУПРЕЖДЕНИЕ: НЕТ ПРОВЕРКИ ПОДПИСИ . Этот метод использует jwt.decode(), который НЕ проверяет подпись токена. Утверждения токена могут быть спуфинированы вредоносными субъектами. Этот метод подходит ТОЛЬКО для ведения журнала, аналитики и диагностики. Не используйте возвращаемое значение для авторизации, контроля доступа или принятия решений по безопасности. Декодирует текущий маркер и извлекает идентификатор приложения (утверждение appid или azp). Примечание. Возвращает GUID по умолчанию ('000000000000-0000-0000-00000000000000') для пустых маркеров для обратной совместимости с вызывающими абонентами, ожидающими допустимого GUID. Для идентификации агента, где предпочтительная пустая строка, используйте getAgentIdFromToken.
getApplicationName()	Возвращает имя приложения из переменной среды npm_package_name или package.json. Результат package.json кэшируется во время загрузки модуля, чтобы избежать синхронизации операций ввода-вывода во время запросов.
GetUserAgentHeader(string)	Создает строку заголовка User-Agent, содержащую версию пакета SDK, тип ОС, версию Node.js и оркестратор.
ResolveAgentIdentity(TurnContext, string)	Разрешает удостоверение агента из контекста поворота или маркера проверки подлинности.

Сведения о методе

getAgentIdFromToken(string)

ПРЕДУПРЕЖДЕНИЕ: НЕТ ПРОВЕРКИ ПОДПИСИ . Этот метод использует jwt.decode(), который НЕ проверяет подпись токена. Утверждения токена могут быть спуфинированы вредоносными субъектами. Этот метод подходит ТОЛЬКО для ведения журнала, аналитики и диагностики. Не используйте возвращаемое значение для авторизации, контроля доступа или принятия решений по безопасности.

Декодирует маркер и извлекает лучший идентификатор агента. Проверяет утверждения в порядке приоритета: xms_par_app_azp (идентификатор схемы агента) > appid > azp.

Примечание. Возвращает пустую строку для пустых и отсутствующих маркеров (в отличие от GetAppIdFromToken , которая возвращает GUID по умолчанию). Это позволяет вызывающим пользователям опустить заголовки, если идентификатор недоступен.

static function getAgentIdFromToken(token: string): string

Параметры

token

string

Токен JWT для декодировки

Возвращаемое значение

string

Идентификатор агента (GUID) или пустая строка, если не найден или токен пуст

GetAppIdFromToken(string)

ПРЕДУПРЕЖДЕНИЕ: НЕТ ПРОВЕРКИ ПОДПИСИ . Этот метод использует jwt.decode(), который НЕ проверяет подпись токена. Утверждения токена могут быть спуфинированы вредоносными субъектами. Этот метод подходит ТОЛЬКО для ведения журнала, аналитики и диагностики. Не используйте возвращаемое значение для авторизации, контроля доступа или принятия решений по безопасности.

Декодирует текущий маркер и извлекает идентификатор приложения (утверждение appid или azp).

Примечание. Возвращает GUID по умолчанию ('000000000000-0000-0000-00000000000000') для пустых маркеров для обратной совместимости с вызывающими абонентами, ожидающими допустимого GUID. Для идентификации агента, где предпочтительная пустая строка, используйте getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Параметры

token

string

Маркер для декодирования

Возвращаемое значение

string

AppId или GUID по умолчанию для пустого маркера или пустой строки, если декодирование завершается ошибкой

getApplicationName()

Возвращает имя приложения из переменной среды npm_package_name или package.json. Результат package.json кэшируется во время загрузки модуля, чтобы избежать синхронизации операций ввода-вывода во время запросов.

static function getApplicationName(): undefined | string

Возвращаемое значение

undefined | string

Имя приложения или не определено, если оно недоступно.

GetUserAgentHeader(string)

Создает строку заголовка User-Agent, содержащую версию пакета SDK, тип ОС, версию Node.js и оркестратор.

static function GetUserAgentHeader(orchestrator?: string): string

Параметры

orchestrator

string

Необязательный идентификатор оркестратора для включения в строку User-Agent.

Возвращаемое значение

string

Форматированная строка заголовка User-Agent.

ResolveAgentIdentity(TurnContext, string)

Разрешает удостоверение агента из контекста поворота или маркера проверки подлинности.

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

Параметры

context

TurnContext

Поворот контекста поворота.

authToken

string

Маркер проверки подлинности, если он доступен.

Возвращаемое значение

string

Удостоверение агента (идентификатор приложения)