OnBehalfOfCredential class
代理フローを使用して認証をMicrosoft Entra IDできるようにします。
コンストラクター
On |
PEM 証明書へのパスとユーザー アサーションを使用して、Microsoft Entra IDに対する認証に必要な詳細を含む OnBehalfOfCredential のインスタンスを作成します。 from @azure/keyvault-keys の使用
|
On |
クライアント シークレットとユーザー アサーションを使用して、Microsoft Entra IDに対する認証に必要な詳細を含む OnBehalfOfCredential のインスタンスを作成します。 from @azure/keyvault-keys の使用
|
メソッド
get |
Microsoft Entra IDで認証し、成功した場合はアクセス トークンを返します。 認証が失敗した場合、失敗の詳細を含む CredentialUnavailableError がスローされます。 |
コンストラクターの詳細
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
PEM 証明書へのパスとユーザー アサーションを使用して、Microsoft Entra IDに対する認証に必要な詳細を含む OnBehalfOfCredential のインスタンスを作成します。
from @azure/keyvault-keys の使用KeyClient
例:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
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 のインスタンスを作成します。
from @azure/keyvault-keys の使用KeyClient
例:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
clientSecret,
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>