Sdílet prostřednictvím

Klientská knihovna azure Mixed Reality Authentication pro JavaScript – verze 1.0.0-beta.1

  • Článek

Mixed Reality služby, jako jsou Azure Spatial Anchors, Azure Remote Rendering a další, používají k ověřování službu tokenů zabezpečení (STS) Mixed Reality. Tento balíček podporuje výměnu přihlašovacích údajů Mixed Reality účtu pro přístupový token ze služby STS, které lze použít pro přístup ke službám Mixed Reality.

Klíčové odkazy:

diagram ověřování služby Mixed Reality

Začínáme

Aktuálně podporovaná prostředí

Požadavky

Nainstalujte balíček @azure/mixed-reality-authentication.

Nainstalujte klientskou knihovnu Azure Mixed Reality Authentication pro JavaScript pomocí npmpříkazu :

npm install @azure/mixed-reality-authentication

Vytvoření a ověření MixedRealityStsClient

Pokud chcete vytvořit objekt klienta pro vyžádání přístupového tokenu pro službu Mixed Reality, budete potřebovat account identifier a account domain prostředku služby Mixed Reality a credential.

Mixed Reality služby podporují několik různých forem ověřování:

  • Ověřování pomocí klíče účtu
    • Klíče účtu umožňují rychle začít používat Mixed Reality služby. Než ale nasadíte aplikaci do produkčního prostředí, doporučujeme aplikaci aktualizovat tak, aby používala ověřování Azure AD.
  • Ověřování tokenem Azure Active Directory (AD)
    • Pokud vytváříte podnikovou aplikaci a vaše společnost používá jako systém identit Azure AD, můžete ve své aplikaci použít ověřování založené na Azure AD uživatele. Přístup k účtům Mixed Reality pak udělíte pomocí stávajících skupin zabezpečení Azure AD. Přístup můžete také udělit přímo uživatelům ve vaší organizaci.
    • V opačném případě doporučujeme získat tokeny Azure AD z webové služby, která podporuje vaši aplikaci. Tuto metodu doporučujeme pro produkční aplikace, protože umožňuje vyhnout se vkládání přihlašovacích údajů pro přístup ke službě Mixed Reality do klientské aplikace.

Podrobné pokyny a informace najdete tady .

Použití ověřování pomocí klíče účtu

Pomocí webu Azure Portal přejděte k prostředku služby Mixed Reality a načtěte account key.

Jakmile budete mít klíč účtu, můžete třídu použít AzureKeyCredential k ověření klienta následujícím způsobem:

const { AzureKeyCredential } = require("@azure/core-auth");

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");

const accountId = "<ACCOUNTD ID>";
const accountDomain = "<ACCOUNT_DOMAIN>";
const accountKey = "<ACCOUNT_KEY>";

const client = new MixedRealityStsClient(
  accountId,
  accountDomain,
  new AzureKeyCredential(accountKey)
);

Poznámka: Ověřování pomocí klíče účtu se nedoporučuje pro produkční aplikace.

Použití přihlašovacích údajů Azure Active Directory

Ve většině příkladů se používá ověřování pomocí klíče účtu, ale můžete se také ověřit pomocí Azure Active Directory pomocí knihovny identit Azure. Toto je doporučená metoda pro produkční aplikace. Pokud chcete použít zprostředkovatele DefaultAzureCredential uvedeného níže nebo jiné poskytovatele přihlašovacích údajů poskytovaného se sadou Azure SDK, nainstalujte @azure/identity balíček:

npm install @azure/identity

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup k prostředku Mixed Reality přiřazením příslušné role pro službu Mixed Reality vašemu instančnímu objektu.

Nastavte hodnoty ID klienta, ID tenanta a tajného klíče klienta aplikace AAD jako proměnné prostředí: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");
const { DefaultAzureCredential } = require("@azure/identity");

const client = new MixedRealityStsClient(accountId, accountDomain, new DefaultAzureCredential());

Klíčové koncepty

MixedRealityStsClient

Jedná se MixedRealityStsClient o klientskou knihovnu, která se používá pro přístup k Mixed Reality STS za účelem získání přístupového tokenu.

Tokeny získané z Mixed Reality sts mají životnost 24 hodin.

Návratová hodnota

Návratová hodnota pro úspěšné volání getToken je GetTokenResponse, což je AccessTokenhodnota z @azure/core-http.

Příklady

Načtení přístupového tokenu

const { AzureKeyCredential } = require("@azure/core-auth");

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");

const accountId = "<ACCOUNTD ID>";
const accountDomain = "<ACCOUNT_DOMAIN>";
const accountKey = "<ACCOUNT_KEY>";

const client = new MixedRealityStsClient(
  accountId,
  accountDomain,
  new AzureKeyCredential(accountKey)
);

const token = await client.getToken();

Složitější scénáře ověřování najdete v předchozích příkladech ověřování nebo v Azure Identity .

Použití přístupového tokenu v klientské knihovně Mixed Reality

Některé Mixed Reality klientské knihovny můžou místo přihlašovacích údajů přijmout přístupový token. Příklad:

// GetMixedRealityAccessTokenFromWebService is a hypothetical method that retrieves
// a Mixed Reality access token from a web service. The web service would use the
// MixedRealityStsClient and credentials to obtain an access token to be returned
// to the client.
const accessToken = await GetMixedRealityAccessTokenFromWebService();

const account = new SpatialAnchorsAccount(accountId, accountDomain);
const client = new SpatialAnchorsClient(account, accessToken);

Poznámka: Výše SpatialAnchorsClient uvedené využití je hypotetické a nemusí odrážet skutečnou knihovnu. V dokumentaci ke klientské knihovně, kterou používáte, zjistěte, jestli a jak se to může podporovat.

Řešení potíží

protokolování

Povolení protokolování může pomoct odhalit užitečné informace o selháních. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou AZURE_LOG_LEVEL prostředí na info. Případně je možné protokolování povolit za běhu voláním setLogLevel v :@azure/logger

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k balíčkům @azure/protokolovacího nástroje.

Další kroky

Podrobné příklady použití této knihovny najdete v adresáři samples .

Přispívání

Tento projekt vítá příspěvky a návrhy. Většina příspěvků vyžaduje souhlas s licenční smlouvou s přispěvatelem (CLA), která stanoví, že máte právo udělit nám práva k používání vašeho příspěvku a skutečně tak činíte. Podrobnosti najdete tady: https://cla.microsoft.com

Při odesílání žádosti o přijetí změn robot CLA automaticky určí, jestli je potřeba poskytnout smlouvu CLA, a příslušným způsobem žádost o přijetí změn upraví (např. přidáním jmenovky nebo komentáře). Stačí postupovat podle pokynů robota. Pro všechna úložiště používající naši smlouvu CLA to stačí udělat jenom jednou.

Tento projekt přijal pravidla chování pro Microsoft Open Source. Další informace najdete v nejčastějších dotazech k pravidlům chování nebo se obraťte na opencode@microsoft.com případné další dotazy nebo komentáře.

Pokud chcete přispívat do této knihovny, přečtěte si prosím průvodce přispívání , kde se dozvíte více o tom, jak sestavit a otestovat kód.

Imprese