ClientCredentialClient class

Concesión de credenciales de cliente de OAuth2.0

Extends
@azure/msal-common.BaseClient

Propiedades heredadas

authority
logger

Métodos

acquireToken(CommonClientCredentialRequest)

API pública para adquirir un token con ClientCredential Flow para clientes confidenciales

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

busca la memoria caché si los tokens ya están almacenados en caché

Métodos heredados

createTokenQueryParameters(BaseAuthRequest)

Crea una cadena de consulta para la solicitud /token.

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

Encapsula sendPostRequestAsync con la lógica de preflight y postflight necesaria.

updateAuthority(string, string)

Actualiza el objeto authority del cliente. La detección de puntos de conexión debe completarse.

Detalles del constructor

ClientCredentialClient(ClientConfiguration, IAppTokenProvider)

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

Parámetros

configuration
@azure/msal-common.ClientConfiguration
appTokenProvider
IAppTokenProvider

Detalles de las propiedades heredadas

authority

authority: Authority

Valor de propiedad

@azure/msal-common.Authority

Heredado de BaseClient.authority

logger

logger: Logger

Valor de propiedad

Heredado de BaseClient.logger

Detalles del método

acquireToken(CommonClientCredentialRequest)

API pública para adquirir un token con ClientCredential Flow para clientes confidenciales

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

Parámetros

request
CommonClientCredentialRequest

CommonClientCredentialRequest proporcionado por el desarrollador

Devoluciones

Promise<null | AuthenticationResult>

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

busca la memoria caché si los tokens ya están almacenados en caché

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

Parámetros

config

@azure/msal-common.ClientConfiguration | ManagedIdentityConfiguration

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

null | @azure/msal-common.ServerTelemetryManager

Devoluciones

Promise<[null | AuthenticationResult, CacheOutcome]>

Detalles de los métodos heredados

createTokenQueryParameters(BaseAuthRequest)

Crea una cadena de consulta para la solicitud /token.

function createTokenQueryParameters(request: BaseAuthRequest): string

Parámetros

request
BaseAuthRequest

Devoluciones

string

Heredado de BaseClient.createTokenQueryParameters

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

Encapsula sendPostRequestAsync con la lógica de preflight y postflight necesaria.

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

Parámetros

thumbprint
RequestThumbprint

Solicitud de huella digital para la limitación

tokenEndpoint

string

Punto de conexión al que se va a convertir el POST

options
NetworkRequestOptions

Cuerpo y encabezados que se van a incluir en la solicitud POST

correlationId

string

CorrelationId para telemetría

Devoluciones

Promise<NetworkResponse<T>>

Heredado de BaseClient.sendPostRequest

updateAuthority(string, string)

Actualiza el objeto authority del cliente. La detección de puntos de conexión debe completarse.

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

Parámetros

cloudInstanceHostname

string

correlationId

string

Devoluciones

Promise<void>

Heredado de BaseClient.updateAuthority