Política DeleteOAuthV2Info

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

O que

Exclui o código de autorização OAuth V2 especificado ou o token de acesso.

Amostras

Excluir token de acesso

Veja abaixo um exemplo de política usada para excluir um token de acesso do OAuth 2.0. O exemplo abaixo localiza o token de acesso a ser excluído na mensagem de solicitação procurando um cabeçalho chamado access_token.

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

Excluir código de autorização

Veja abaixo um exemplo de política usada para excluir um código de autorização do OAuth 2.0. O exemplo abaixo localiza o código de autenticação a ser excluído na mensagem da solicitação procurando um parâmetro de consulta chamado code.

<DeleteOAuthV2Info name="DeleteAuthCode">
     <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
</DeleteOAuthV2Info>

Referência de elemento

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

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

Atributos <DeleteOAuthV2Info>

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Atributo Descrição Padrão Presença
async

Defina como true para especificar que a política precisa ser executada em um pool de linhas de execução diferente daquele que atende ao fluxo de solicitação/resposta. O padrão é false.

Essa configuração é usada apenas para otimização interna.

 falso Opcional
continueOnError

Espera-se que a maioria das políticas retorne um erro quando ocorre uma falha. Ao definir esse atributo como true, a execução do fluxo continua em caso de falha.

 falso Opcional
ativada Determina se uma política é aplicada ou não. Se definida como false, uma política será desativada e não aplicada (mesmo que permaneça anexada a um fluxo). true Opcional
name

O nome interno da política. Esse nome é mencionado nos elementos da etapa para anexar a política a um fluxo.

Observação: os caracteres que podem ser usados no nome são restritos a: A-Z0-9._\-$ %. A interface de gerenciamento aplica outras restrições, como removendo automaticamente os caracteres que não são alfanuméricos.

 N/A Obrigatório

Elemento <AccessToken>

Identifica a variável em que o token de acesso a ser excluído está localizado. Por exemplo, se o token de acesso estiver anexado à mensagem de solicitação como um parâmetro de consulta chamado "access_token", 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: É necessário <AccessToken> ou <AuthorizationCode>.
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. Por exemplo, request.header.token ou request.queryparam.token.

 N/D Opcional

Elemento <AuthorizationCode>

Identifica a variável em que o código de autorização a ser excluído está localizado. Por exemplo, se o código de autenticação estiver anexado à mensagem de solicitação como um parâmetro de consulta chamado "code", especifique request.queryparam.code. 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).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Padrão: N/A
Presença: É necessário <AccessToken> ou <AuthorizationCode>.
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. Por exemplo, request.header.code ou request.queryparam.code.

 N/D Opcional

Elemento <DisplayName>

Um nome em linguagem natural que rotula a política no editor de proxy da interface de gerenciamento. Se omitido, o atributo do nome da política será usado.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Padrão: O valor do atributo name da política.
Presença: Opcional
Tipo: String

Referência de erros

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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.invalid_access_token 401 The access token sent to the policy is invalid.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 The authorization code sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Please see this Apigee Community post 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.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.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.DeleteTokenInfo.cause = Invalid Access Token

Example error response

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

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

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.

Temas relacionados