ClientCertificateCredential class
PEMでエンコードされた証明書を用いてMicrosoft Entra IDへの認証を可能にし、アプリ登録に割り当てられます。 証明書認証を構成する方法の詳細については、以下を参照してください。
コンストラクター
| Client |
Microsoft Entra IDに対して証明書を認証するために必要な詳細を含むClientCertificateCredentialのインスタンスを作成します。 |
| Client |
Microsoft Entra IDに対して証明書を認証するために必要な詳細を含むClientCertificateCredentialのインスタンスを作成します。 |
| Client |
Microsoft Entra IDに対して証明書を認証するために必要な詳細を含むClientCertificateCredentialのインスタンスを作成します。 |
メソッド
| get |
Microsoft Entra IDで認証し、成功するとアクセストークンを返します。 認証に失敗すると、CredentialUnavailableError がスローされ、エラーの詳細が表示されます。 |
コンストラクターの詳細
ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)
Microsoft Entra IDに対して証明書を認証するために必要な詳細を含むClientCertificateCredentialのインスタンスを作成します。
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)パラメーター
- tenantId
-
string
Microsoft Entra テナント(ディレクトリ)ID。
- clientId
-
string
テナント内のアプリ登録のクライアント (アプリケーション) ID。
- configuration
- ClientCertificatePEMCertificate
PEM でエンコードされた証明書を文字列として含む、その他のパラメーターが必要です。 型が無視された場合は、PEM でエンコードされた証明書の値がスローされます。
認証要求を行うクライアントを構成するためのオプション。
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)
Microsoft Entra IDに対して証明書を認証するために必要な詳細を含むClientCertificateCredentialのインスタンスを作成します。
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)パラメーター
- tenantId
-
string
Microsoft Entra テナント(ディレクトリ)ID。
- clientId
-
string
テナント内のアプリ登録のクライアント (アプリケーション) ID。
- configuration
- ClientCertificatePEMCertificatePath
ファイルシステム上の証明書のパスなど、必要なその他のパラメーター。 型が無視された場合、PEM 証明書へのパスの値がスローされます。
認証要求を行うクライアントを構成するためのオプション。
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)
Microsoft Entra IDに対して証明書を認証するために必要な詳細を含むClientCertificateCredentialのインスタンスを作成します。
new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)パラメーター
- tenantId
-
string
Microsoft Entra テナント(ディレクトリ)ID。
- clientId
-
string
テナント内のアプリ登録のクライアント (アプリケーション) ID。
- certificatePath
-
string
ファイルシステム上の PEM でエンコードされた公開/秘密キー証明書へのパス。 証明書が PEM 形式であり、公開キーと秘密キーの両方が含まれていることを確認します。
認証要求を行うクライアントを構成するためのオプション。
メソッドの詳細
getToken(string | string[], GetTokenOptions)
Microsoft Entra IDで認証し、成功するとアクセストークンを返します。 認証に失敗すると、CredentialUnavailableError がスローされ、エラーの詳細が表示されます。
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>パラメーター
- scopes
-
string | string[]
トークンがアクセスできるスコープの一覧。
- options
- GetTokenOptions
この TokenCredential 実装が行う可能性がある要求を構成するために使用されるオプション。
返品
Promise<AccessToken>