次の方法で共有

OnBehalfOfCredential class

  • リファレンス
パッケージ:
@azure/identity

On Behalf Of フローを使用して、Microsoft Entra ID への認証を有効にします。

コンストラクター

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

クライアント getAssertion とユーザー アサーションを使用して Microsoft Entra ID に対する認証に必要な詳細を含む、OnBehalfOfCredential のインスタンスを作成します。

@azure/keyvault-keysからの KeyClient の使用例:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  getAssertion: () => { return Promise.resolve("my-jwt")},
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

PEM 証明書へのパスとユーザー アサーションを使用して Microsoft Entra ID に対する認証に必要な詳細を含む、OnBehalfOfCredential のインスタンスを作成します。

@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");
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

クライアント シークレットとユーザー アサーションを使用して Microsoft Entra ID に対する認証に必要な詳細を含む、OnBehalfOfCredential のインスタンスを作成します。

@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");

メソッド

getToken(string | string[], GetTokenOptions)

Microsoft Entra ID を使用して認証し、成功した場合はアクセス トークンを返します。 認証に失敗すると、CredentialUnavailableError がスローされ、エラーの詳細が表示されます。

コンストラクターの詳細

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

クライアント getAssertion とユーザー アサーションを使用して Microsoft Entra ID に対する認証に必要な詳細を含む、OnBehalfOfCredential のインスタンスを作成します。

@azure/keyvault-keysからの KeyClient の使用例:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  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)

PEM 証明書へのパスとユーザー アサーションを使用して Microsoft Entra ID に対する認証に必要な詳細を含む、OnBehalfOfCredential のインスタンスを作成します。

@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 のインスタンスを作成します。

@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>