ClientCredentialClient class

Concessão de credencial de cliente OAuth2.0

Extends
@azure/msal-common.BaseClient

Propriedades herdadas

authority
logger

Métodos

acquireToken(CommonClientCredentialRequest)

API pública para adquirir um token com o Fluxo ClientCredential para clientes confidenciais

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

procurará o cache se os tokens já estiverem armazenados em cache

Métodos herdados

createTokenQueryParameters(BaseAuthRequest)

Cria uma cadeia de caracteres de consulta para a solicitação /token

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

Encapsula sendPostRequestAsync com a lógica necessária de pré-vôo e postflight

updateAuthority(string, string)

Atualiza o objeto de autoridade do cliente. A descoberta de ponto de extremidade deve ser concluída.

Detalhes do construtor

ClientCredentialClient(ClientConfiguration, IAppTokenProvider)

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

Parâmetros

configuration
@azure/msal-common.ClientConfiguration
appTokenProvider
IAppTokenProvider

Detalhes das propriedades herdadas

authority

authority: Authority

Valor da propriedade

@azure/msal-common.Authority

Herdado de BaseClient.authority

logger

logger: Logger

Valor da propriedade

Herdado de BaseClient.logger

Detalhes do método

acquireToken(CommonClientCredentialRequest)

API pública para adquirir um token com o Fluxo ClientCredential para clientes confidenciais

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

Parâmetros

request
CommonClientCredentialRequest

CommonClientCredentialRequest fornecido pelo desenvolvedor

Retornos

Promise<null | AuthenticationResult>

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

procurará o cache se os tokens já estiverem armazenados em cache

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

Retornos

Promise<[null | AuthenticationResult, CacheOutcome]>

Detalhes do método herdado

createTokenQueryParameters(BaseAuthRequest)

Cria uma cadeia de caracteres de consulta para a solicitação /token

function createTokenQueryParameters(request: BaseAuthRequest): string

Parâmetros

request
BaseAuthRequest

Retornos

string

Herdado de BaseClient.createTokenQueryParameters

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

Encapsula sendPostRequestAsync com a lógica necessária de pré-vôo e postflight

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

Parâmetros

thumbprint
RequestThumbprint

Solicitar impressão digital para limitação

tokenEndpoint

string

Ponto de extremidade para fazer o POST para

options
NetworkRequestOptions

Corpo e cabeçalhos a serem incluídos na solicitação POST

correlationId

string

CorrelationId para telemetria

Retornos

Promise<NetworkResponse<T>>

Herdado de BaseClient.sendPostRequest

updateAuthority(string, string)

Atualiza o objeto de autoridade do cliente. A descoberta de ponto de extremidade deve ser concluída.

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

Parâmetros

cloudInstanceHostname

string

correlationId

string

Retornos

Promise<void>

Herdado de BaseClient.updateAuthority