ClientCredentialClient class

OAuth2.0 クライアント資格情報の付与

Extends
@azure/msal-common.BaseClient

継承されたプロパティ

authority
logger

メソッド

acquireToken(CommonClientCredentialRequest)

機密クライアントの ClientCredential Flow を使用してトークンを取得するパブリック API

getCachedAuthenticationResult(CommonClientCredentialRequest, ClientConfiguration | ManagedIdentityConfiguration, ICrypto, Authority, CacheManager, null | ServerTelemetryManager)

トークンが既にキャッシュされている場合はキャッシュを検索します

継承されたメソッド

createTokenQueryParameters(BaseAuthRequest)

/token 要求のクエリ文字列を作成します

sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)

必要なプレフライトおよびポストフライト ロジックで sendPostRequestAsync をラップします

updateAuthority(string, string)

クライアントの authority オブジェクトを更新します。 エンドポイントの検出を完了する必要があります。

コンストラクターの詳細

ClientCredentialClient(ClientConfiguration, IAppTokenProvider)

new ClientCredentialClient(configuration: ClientConfiguration, appTokenProvider?: IAppTokenProvider)

パラメーター

configuration
@azure/msal-common.ClientConfiguration
appTokenProvider
IAppTokenProvider

継承されたプロパティの詳細

authority

authority: Authority

プロパティ値

@azure/msal-common.Authority

Inherited From BaseClient.authority

logger

logger: Logger

プロパティ値

Inherited From BaseClient.logger

メソッドの詳細

acquireToken(CommonClientCredentialRequest)

機密クライアントの ClientCredential Flow を使用してトークンを取得するパブリック API

function acquireToken(request: CommonClientCredentialRequest): Promise<null | AuthenticationResult>

パラメーター

request
CommonClientCredentialRequest

開発者が提供する CommonClientCredentialRequest

返品

Promise<null | AuthenticationResult>

getCachedAuthenticationResult(CommonClientCredentialRequest, ClientConfiguration | ManagedIdentityConfiguration, ICrypto, Authority, CacheManager, null | ServerTelemetryManager)

トークンが既にキャッシュされている場合はキャッシュを検索します

function getCachedAuthenticationResult(request: CommonClientCredentialRequest, config: ClientConfiguration | ManagedIdentityConfiguration, cryptoUtils: ICrypto, authority: Authority, cacheManager: CacheManager, serverTelemetryManager?: null | ServerTelemetryManager): Promise<[null | AuthenticationResult, CacheOutcome]>

パラメーター

config

@azure/msal-common.ClientConfiguration | ManagedIdentityConfiguration

cryptoUtils
ICrypto
authority
@azure/msal-common.Authority
cacheManager
@azure/msal-common.CacheManager
serverTelemetryManager

null | @azure/msal-common.ServerTelemetryManager

返品

Promise<[null | AuthenticationResult, CacheOutcome]>

継承済みメソッドの詳細

createTokenQueryParameters(BaseAuthRequest)

/token 要求のクエリ文字列を作成します

function createTokenQueryParameters(request: BaseAuthRequest): string

パラメーター

request
BaseAuthRequest

返品

string

Inherited From BaseClient.createTokenQueryParameters

sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)

必要なプレフライトおよびポストフライト ロジックで sendPostRequestAsync をラップします

function sendPostRequest<T>(thumbprint: RequestThumbprint, tokenEndpoint: string, options: NetworkRequestOptions, correlationId: string): Promise<NetworkResponse<T>>

パラメーター

thumbprint
RequestThumbprint

調整のために拇印を要求する

tokenEndpoint

string

POST を作成するエンドポイント

options
NetworkRequestOptions

POST 要求に含める本文とヘッダー

correlationId

string

テレメトリの CorrelationId

返品

Promise<NetworkResponse<T>>

Inherited From BaseClient.sendPostRequest

updateAuthority(string, string)

クライアントの authority オブジェクトを更新します。 エンドポイントの検出を完了する必要があります。

function updateAuthority(cloudInstanceHostname: string, correlationId: string): Promise<void>

パラメーター

cloudInstanceHostname

string

correlationId

string

返品

Promise<void>

Inherited From BaseClient.updateAuthority