OnBehalfOfCredential class
On Behalf Of flowを使って認証Microsoft Entra IDを可能にします。
コンストラクター
| On |
クライアント
|
| On |
OnBehalfOfCredentialのインスタンスを作成し、PEM証明書への経路を持つ認証に必要なMicrosoft Entra ID詳細とユーザーアサーションを付与します。
|
| On |
クライアントシークレットとユーザーアサーションでMicrosoft Entra IDに対して認証に必要な詳細を含むOnBehalfOfCredentialのインスタンスを作成します。
|
メソッド
| get |
Microsoft Entra IDで認証し、成功するとアクセストークンを返します。 認証に失敗すると、CredentialUnavailableError がスローされ、エラーの詳細が表示されます。 |
コンストラクターの詳細
OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
クライアントgetAssertionとユーザーアサーションで認証Microsoft Entra IDするための詳細を含むOnBehalfOfCredentialのインスタンスを作成します。
import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";
const tokenCredential = new OnBehalfOfCredential({
tenantId: "tenant-id",
clientId: "client-id",
getAssertion: () => {
return Promise.resolve("my-jwt");
},
userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);
await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
パラメーター
- options
-
OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
省略可能なパラメーター。通常、資格情報間で一般的です。
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
OnBehalfOfCredentialのインスタンスを作成し、PEM証明書への経路を持つ認証に必要なMicrosoft Entra ID詳細とユーザーアサーションを付与します。
import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";
const tokenCredential = new OnBehalfOfCredential({
tenantId: "tenant-id",
clientId: "client-id",
certificatePath: "/path/to/certificate.pem",
userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);
await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
パラメーター
- options
-
OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
省略可能なパラメーター。通常、資格情報間で一般的です。
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
クライアントシークレットとユーザーアサーションでMicrosoft Entra IDに対して認証に必要な詳細を含むOnBehalfOfCredentialのインスタンスを作成します。
import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";
const tokenCredential = new OnBehalfOfCredential({
tenantId: "tenant-id",
clientId: "client-id",
clientSecret: "client-secret",
userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);
await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
パラメーター
- options
-
OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
省略可能なパラメーター。通常、資格情報間で一般的です。
メソッドの詳細
getToken(string | string[], GetTokenOptions)
Microsoft Entra IDで認証し、成功するとアクセストークンを返します。 認証に失敗すると、CredentialUnavailableError がスローされ、エラーの詳細が表示されます。
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
パラメーター
- scopes
-
string | string[]
トークンがアクセスできるスコープの一覧。
- options
- GetTokenOptions
基になるネットワーク要求の構成に使用されるオプション。
返品
Promise<AccessToken>