ClientCredentialClient class

OAuth2.0-clientreferentie verlenen

Uitbreiding
@azure/msal-common.BaseClient

Overgenomen eigenschappen

authority
logger

Methoden

acquireToken(CommonClientCredentialRequest)

Openbare API voor het verkrijgen van een token met ClientCredential Flow voor vertrouwelijke clients

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

cache opzoeken als de tokens al in de cache zijn opgeslagen

Overgenomen methoden

createTokenQueryParameters(BaseAuthRequest)

Hiermee maakt u een querytekenreeks voor de /token-aanvraag

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

Verpakt sendPostRequestAsync met de benodigde preflight- en postflight-logica

updateAuthority(string, string)

Hiermee wordt het instantieobject van de client bijgewerkt. Eindpuntdetectie moet worden voltooid.

Constructordetails

ClientCredentialClient(ClientConfiguration, IAppTokenProvider)

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

Parameters

configuration
@azure/msal-common.ClientConfiguration
appTokenProvider
IAppTokenProvider

Details van overgenomen eigenschap

authority

authority: Authority

Waarde van eigenschap

@azure/msal-common.Authority

Overgenomen van BaseClient.authority

logger

logger: Logger

Waarde van eigenschap

Overgenomen van BaseClient.logger

Methodedetails

acquireToken(CommonClientCredentialRequest)

Openbare API voor het verkrijgen van een token met ClientCredential Flow voor vertrouwelijke clients

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

Parameters

request
CommonClientCredentialRequest

CommonClientCredentialRequest geleverd door de ontwikkelaar

Retouren

Promise<null | AuthenticationResult>

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

cache opzoeken als de tokens al in de cache zijn opgeslagen

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

Parameters

config

@azure/msal-common.ClientConfiguration | ManagedIdentityConfiguration

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

null | @azure/msal-common.ServerTelemetryManager

Retouren

Promise<[null | AuthenticationResult, CacheOutcome]>

Details overgenomen methode

createTokenQueryParameters(BaseAuthRequest)

Hiermee maakt u een querytekenreeks voor de /token-aanvraag

function createTokenQueryParameters(request: BaseAuthRequest): string

Parameters

request
BaseAuthRequest

Retouren

string

Overgenomen van BaseClient.createTokenQueryParameters

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

Verpakt sendPostRequestAsync met de benodigde preflight- en postflight-logica

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

Parameters

thumbprint
RequestThumbprint

Vingerafdruk aanvragen voor beperking

tokenEndpoint

string

Eindpunt om de POST naar

options
NetworkRequestOptions

Hoofdtekst en headers die moeten worden opgenomen in de POST-aanvraag

correlationId

string

CorrelationId voor telemetrie

Retouren

Promise<NetworkResponse<T>>

Overgenomen van BaseClient.sendPostRequest

updateAuthority(string, string)

Hiermee wordt het instantieobject van de client bijgewerkt. Eindpuntdetectie moet worden voltooid.

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

Parameters

cloudInstanceHostname

string

correlationId

string

Retouren

Promise<void>

Overgenomen van BaseClient.updateAuthority