Política SetOAuthV2Info

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

O que

Permite adicionar ou atualizar atributos personalizados associados a um token de acesso. Os atributos personalizados podem incluir itens como nome do departamento, ID do cliente ou identificador de sessão. Consulte também Como personalizar tokens e códigos de autorização.

Você só pode adicionar ou modificar atributos personalizados. Essa política não pode ser usada para alterar campos como scope, status, expires_in, developer_email, client_id, org_name ou refresh_count. Se já houver um atributo, a política será atualizada. Se não existir, a política a adicionará. O token de acesso mencionado precisa ser válido e estar em um estado aprovado.

Esta é uma política extensível. O uso dela pode ter implicações no custo ou na utilização, dependendo da sua licença da Apigee. Para informações sobre tipos de política e implicações de uso, consulte Tipos de política.

Amostras

Exemplo básico

Veja abaixo um exemplo de política usada para atualizar um token de acesso do OAuth 2.0. O exemplo abaixo localiza o token de acesso na mensagem da solicitação procurando um parâmetro de consulta chamado access_token. Quando um token de acesso é apresentado por um app cliente, a política abaixo localizará o token de acesso no parâmetro de consulta. Em seguida, ele atualizará o perfil do token de acesso. Ela adiciona uma propriedade personalizada chamada department.id ao perfil.

<SetOAuthV2Info name="SetOAuthV2Info"> 
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

Referência de elemento

A referência de elementos descreve os elementos e atributos da política SetOAuthV2.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="SetOAuthV2Info-1">    
    <DisplayName>Set OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <Attributes/>
</SetOAuthV2Info>
</xml>

Atributos de <SetOAuthV2Info>

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

A tabela seguinte descreve os atributos comuns a todos os elementos principais de políticas:

Atributo	Descrição	Predefinição	Presença
`name`	O nome interno da política. O valor do atributo `name` pode conter letras, números, espaços, hífenes, sublinhados e pontos finais. Este valor não pode exceder 255 carateres. Opcionalmente, use o elemento `<DisplayName>` para etiquetar a política no editor de proxy da IU de gestão com um nome diferente em linguagem natural.	N/A	Obrigatória
`continueOnError`	Definido como `false` para devolver um erro quando uma política falha. Este comportamento é o esperado para a maioria das políticas. Definido como `true` para que a execução do fluxo continue mesmo depois de uma política falhar. Veja também: As regras de falhas são acionadas APENAS num estado de erro (acerca de continueOnError) Processar falhas no fluxo atual	falso	Opcional
`enabled`	Defina como `true` para aplicar a política. Defina como `false` para desativar a política. A política não é aplicada, mesmo que permaneça associada a um fluxo.	verdadeiro	Opcional
`async`	Este atributo foi descontinuado.	falso	Descontinuado

Elemento <DisplayName>

Use em conjunto com o atributo name para etiquetar a política no editor de proxy da IU de gestão com um nome diferente em linguagem natural.

<DisplayName>Policy Display Name</DisplayName>

Predefinição

Predefinição	N/A Se omitir este elemento, é usado o valor do atributo `name` da política.
Presença	Opcional
Tipo	String

N/A

Se omitir este elemento, é usado o valor do atributo name da política.

Presença Opcional

Tipo String

Elemento <AccessToken>

Identifica a variável em que o token de acesso está localizado. Por exemplo, se o token de acesso estiver anexado à mensagem de solicitação como um parâmetro de consulta, especifique request.queryparam.access_token. Você pode usar qualquer variável válida que faça referência ao token. Ou pode passar a string de token literal (caso raro).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>

Padrão:	N/A
Presença:	Obrigatório
Tipo:	String

Atributos

Atributo	Descrição	Padrão	Presence
ref	Uma variável de token de acesso. Normalmente, recuperado de uma variável de fluxo.	N/A	Opcional

Elemento <Attributes>

Um conjunto de atributos no perfil do token de acesso que será modificado ou aumentado.

Padrão:	N/A
Presença:	Obrigatório
Tipo:	N/A

Elemento <Attributes>/<Attribute>

Um atributo individual para atualização.

O atributo name identifica a propriedade personalizada do perfil do token de acesso a ser atualizado. Neste exemplo, mostramos como usar um valor de variável referenciado e um valor estático.

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>

Padrão:	N/A
Presença:	Opcional
Tipo:	N/A

Atributos

Atributo	Descrição	Padrão	Presence
name	Nome do atributo de perfil a ser adicionado ou alterado.	N/A
ref	O valor a ser atribuído ao atributo de perfil.	N/A	Opcional

Variáveis de fluxo

Em caso de sucesso, as seguintes variáveis de fluxo serão definidas:

oauthv2accesstoken.{policyName}.access_token
oauthv2accesstoken.{policyName}.client_id
oauthv2accesstoken.{policyName}.refresh_count
oauthv2accesstoken.{policyName}.organization_name
oauthv2accesstoken.{policyName}.expires_in //--in seconds
oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
oauthv2accesstoken.{policyName}.issued_at
oauthv2accesstoken.{policyName}.status
oauthv2accesstoken.{policyName}.api_product_list
oauthv2accesstoken.{policyName}.token_type
oauthv2accesstoken.{policyName}.{custom_attribute_name}

Esquema

Cada tipo de política é definido por um esquema XML (.xsd). Para referência, os esquemas de política estão disponíveis no GitHub.

Referência de erros

Esta secção descreve os códigos de falha e as mensagens de erro devolvidas, bem como as variáveis de falha definidas pelo Apigee quando esta política aciona um erro. Estas informações são importantes para saber se está a desenvolver regras de falhas para tratar falhas. Para saber mais, consulte o artigo O que precisa de saber acerca dos erros de políticas e o artigo Processamento de falhas.

Erros de tempo de execução

Estes erros podem ocorrer quando a política é executada.

Código de falha	Estado de HTTP	Causa
`steps.oauth.v2.access_token_expired`	`500`	O token de acesso enviado para a política expirou.
`steps.oauth.v2.invalid_access_token`	`500`	O token de acesso enviado para a política é inválido.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	`401`	Consulte o artigo A validação do token de acesso do Oauth2.0 devolve o erro "Invalid API call as no apiproduct match found" para obter informações sobre a resolução de problemas deste erro.

Erros de implementação

Consulte a mensagem comunicada na IU para obter informações sobre erros de implementação.

Variáveis de falha

Estas variáveis são definidas quando esta política aciona um erro no tempo de execução.

Variáveis	Onde	Exemplo
`fault.name="fault_name"`	`fault_name` é o nome da falha, conforme indicado na tabela Erros de tempo de execução acima. O nome da falha é a última parte do código de falha.	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` é o nome especificado pelo utilizador da política que gerou a falha.	`oauthV2.SetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` é o nome especificado pelo utilizador da política que gerou a falha.	`oauthV2.SetTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` é o nome especificado pelo utilizador da política que gerou a falha.	`oauthV2.SetTokenInfo.cause = Invalid Access Token`

Exemplo de resposta de erro

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Exemplo de regra de falha

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Política SetOAuthV2Info Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

O que

Amostras

Exemplo básico

Referência de elemento

Atributos de <SetOAuthV2Info>

Elemento <DisplayName>

Elemento <AccessToken>

Atributos

Elemento <Attributes>

Elemento <Attributes>/<Attribute>

Atributos

Variáveis de fluxo

Esquema

Referência de erros

Erros de tempo de execução

Erros de implementação

Variáveis de falha

Exemplo de resposta de erro

Exemplo de regra de falha

Temas relacionados

Política SetOAuthV2Info