ClientCredentialClient class

Udělení přihlašovacích údajů klienta OAuth2.0

Extends
@azure/msal-common.BaseClient

Zděděné vlastnosti

authority
logger

Metody

acquireToken(CommonClientCredentialRequest)

Veřejné rozhraní API pro získání tokenu pomocí clientCredential Flow pro důvěrné klienty

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

vyhledá mezipaměť, pokud už jsou tokeny uložené v mezipaměti.

Zděděné metody

createTokenQueryParameters(BaseAuthRequest)

Vytvoří řetězec dotazu pro požadavek /token.

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

Zalamuje sendPostRequestAsync s nezbytnou předběžnou a pozletovou logikou.

updateAuthority(string, string)

Aktualizuje objekt autority klienta. Zjišťování koncových bodů musí být dokončeno.

Podrobnosti konstruktoru

ClientCredentialClient(ClientConfiguration, IAppTokenProvider)

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

Parametry

configuration
@azure/msal-common.ClientConfiguration
appTokenProvider
IAppTokenProvider

Podrobnosti zděděných vlastností

authority

authority: Authority

Hodnota vlastnosti

@azure/msal-common.Authority

Zděděno z BaseClient.authority

logger

logger: Logger

Hodnota vlastnosti

Zděděno z BaseClient.logger

Podrobnosti metody

acquireToken(CommonClientCredentialRequest)

Veřejné rozhraní API pro získání tokenu pomocí clientCredential Flow pro důvěrné klienty

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

Parametry

request
CommonClientCredentialRequest

CommonClientCredentialRequest poskytovaný vývojářem

Návraty

Promise<null | AuthenticationResult>

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

vyhledá mezipaměť, pokud už jsou tokeny uložené v mezipaměti.

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

Parametry

config

@azure/msal-common.ClientConfiguration | ManagedIdentityConfiguration

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

null | @azure/msal-common.ServerTelemetryManager

Návraty

Promise<[null | AuthenticationResult, CacheOutcome]>

Podrobnosti zděděných metod

createTokenQueryParameters(BaseAuthRequest)

Vytvoří řetězec dotazu pro požadavek /token.

function createTokenQueryParameters(request: BaseAuthRequest): string

Parametry

request
BaseAuthRequest

Návraty

string

Zděděno z BaseClient.createTokenQueryParameters

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

Zalamuje sendPostRequestAsync s nezbytnou předběžnou a pozletovou logikou.

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

Parametry

thumbprint
RequestThumbprint

Vyžádání kryptografického otisku pro omezování

tokenEndpoint

string

Koncový bod pro vytvoření post na

options
NetworkRequestOptions

Text a hlavičky, které se mají zahrnout do požadavku POST

correlationId

string

Id korelace pro telemetrii

Návraty

Promise<NetworkResponse<T>>

Zděděno z BaseClient.sendPostRequest

updateAuthority(string, string)

Aktualizuje objekt autority klienta. Zjišťování koncových bodů musí být dokončeno.

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

Parametry

cloudInstanceHostname

string

correlationId

string

Návraty

Promise<void>

Zděděno z BaseClient.updateAuthority