Política SetOAuthV2Info

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

Confira a documentação da Apigee Edge.

Ícone da política

Conteúdo

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 a seguir descreve atributos comuns a todos os elementos pai de políticas:

Atributo Descrição Padrão Presença
name

O nome interno da política. O valor do atributo name pode conter letras, números, espaços, hifens, sublinhados e pontos. Esse valor não pode exceder 255 caracteres.

Opcionalmente, use o elemento <DisplayName> para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.

 N/A Obrigatório
continueOnError

Defina como false para retornar um erro quando uma política falhar. Esse é o comportamento esperado na maioria das políticas.

Defina como true para que a execução do fluxo continue mesmo depois que uma política falhar. Consulte também:

 falso Opcional
enabled

Defina como true para aplicar a política.

Defina como false para desativar a política. A política não será aplicada mesmo se ela permanecer anexada a um fluxo.

 true Opcional
async

Esse atributo está obsoleto.

 falso Obsoleto

Elemento <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>
Padrão

N/A

Se você omitir esse elemento, será 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 Presença
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 Presença
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}

Schema

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

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause
steps.oauth.v2.access_token_expired 500 The access token sent to the policy is expired.
steps.oauth.v2.invalid_access_token 500 The access token sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Please see Oauth2.0 Access Token Verification throws "Invalid API call as no apiproduct match found" error for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.cause = Invalid Access Token

Example error response

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

Example fault rule

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

Temas relacionados