TokenRequestContext Classe

  • Referência
Pacote:
com.azure.core.credential
Artefato Maven:
com.azure:azure-core:1.46.0
  • java.lang.Object
    • com.azure.core.credential.TokenRequestContext

public class TokenRequestContext

O TokenRequestContext é uma classe usada para fornecer informações e contexto adicionais ao solicitar um token de acesso de uma origem de autenticação. Ele permite personalizar a solicitação de token e especificar parâmetros adicionais, como escopos, declarações ou opções de autenticação.

O TokenRequestContext normalmente é usado com mecanismos de autenticação que exigem configurações ou opções mais avançadas, como a autenticação do Azure Active Directory (Azure AD).

Aqui está uma visão geral de alto nível de como você pode usar o TokenRequestContext:

  1. Crie uma instância da TokenRequestContext classe e configure as propriedades necessárias. A TokenRequestContext classe permite que você especifique os escopos ou recursos para os quais você deseja solicitar um token de acesso, bem como quaisquer declarações ou opções adicionais.
  2. Passe a instância TokenRequestContext para o cliente ou mecanismo de autenticação apropriado ao solicitar um token de acesso. O método específico ou a API para fazer isso dependerá do mecanismo de autenticação que você está usando. Por exemplo, se você estiver usando a Identidade do Azure para autenticação do AAD, passará a instância TokenRequestContext para o método getToken da TokenCredential implementação.
  3. O cliente ou mecanismo de autenticação manipulará a solicitação de token e retornará um token de acesso que pode ser usado para autenticar e autorizar solicitações para os serviços do Azure.

Resumo do Construtor

Construtor Description
TokenRequestContext()

Cria uma instância de solicitação de token.

Resumo do método

Modificador e tipo Método e descrição
TokenRequestContext addScopes(String[] scopes)

Adiciona um ou mais escopos aos escopos de solicitação.
String getClaims()

Obtenha as declarações adicionais a serem incluídas no token.
List<String> getScopes()

Obtém os escopos necessários para o token.
String getTenantId()

Obtenha a ID do locatário a ser usada para a solicitação de autenticação.
boolean isCaeEnabled()

Obtenha o status que indica se a CAE (Avaliação Contínua de Acesso) está habilitada para o token solicitado.
TokenRequestContext setCaeEnabled(boolean enableCae)

Indica se a CAE (Avaliação Contínua de Acesso) deve ser habilitada para o token solicitado.
TokenRequestContext setClaims(String claims)

Defina as declarações adicionais a serem incluídas no token.
TokenRequestContext setScopes(List<String> scopes)

Define os escopos necessários para o token.
TokenRequestContext setTenantId(String tenantId)

Defina a ID do locatário a ser usada para a solicitação de autenticação.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

TokenRequestContext

public TokenRequestContext()

Cria uma instância de solicitação de token.

Detalhes do método

addScopes

public TokenRequestContext addScopes(String[] scopes)

Adiciona um ou mais escopos aos escopos de solicitação.

Parameters:

scopes - um ou mais escopos a serem adicionados

Returns:

o próprio TokenRequestContext

getClaims

public String getClaims()

Obtenha as declarações adicionais a serem incluídas no token.

Returns:

as declarações adicionais a serem incluídas no token.

getScopes

public List getScopes()

Obtém os escopos necessários para o token.

Returns:

os escopos necessários para o token

getTenantId

public String getTenantId()

Obtenha a ID do locatário a ser usada para a solicitação de autenticação.

Returns:

a ID de locatário configurada.

isCaeEnabled

public boolean isCaeEnabled()

Obtenha o status que indica se a CAE (Avaliação Contínua de Acesso) está habilitada para o token solicitado.

Returns:

o sinalizador que indica se a autenticação cae deve ser usada ou não.

setCaeEnabled

public TokenRequestContext setCaeEnabled(boolean enableCae)

Indica se a CAE (Avaliação Contínua de Acesso) deve ser habilitada para o token solicitado.

Se uma API de recurso implementar a CAE e o aplicativo declarar que pode manipular a CAE, o aplicativo obterá tokens da CAE para esse recurso. Por esse motivo, se você declarar a CAE do seu aplicativo pronta, seu aplicativo precisará lidar com o desafio de declaração de CAE para todas as APIs de recurso que aceitam tokens de acesso de identidade da Microsoft. Se você não tratar as respostas da CAE nessas chamadas à API, o aplicativo poderá terminar em um loop que repete uma chamada à API com um token que ainda está no ciclo de vida retornado do token, mas que foi revogado devido à CAE.

Parameters:

enableCae - o sinalizador que indica se a CAE (Avaliação contínua de acesso) deve ser habilitada para o token solicitado.

Returns:

o TokenRequestContext atualizado.

setClaims

public TokenRequestContext setClaims(String claims)

Defina as declarações adicionais a serem incluídas no token.

Parameters:

claims - as declarações adicionais a serem incluídas no token.

Returns:

o TokenRequestContext atualizado em si

setScopes

public TokenRequestContext setScopes(List scopes)

Define os escopos necessários para o token.

Parameters:

scopes - os escopos necessários para o token

Returns:

o próprio TokenRequestContext

setTenantId

public TokenRequestContext setTenantId(String tenantId)

Defina a ID do locatário a ser usada para a solicitação de autenticação.

Parameters:

tenantId - o locatário a ser usado ao solicitar o token.

Returns:

o TokenRequestContext atualizado em si

Aplica-se a