Política DeleteOAuthV2Info

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

A política DeleteOAuthv2Info elimina o código de autorização ou o token de acesso OAuth V2 especificado.

Esta política é uma política extensível e a utilização desta política pode ter implicações de custo ou utilização, consoante a sua licença do Apigee. Para ver informações sobre os tipos de políticas e as implicações de utilização, consulte Tipos de políticas.

Amostras

Elimine o token de acesso

Segue-se um exemplo de uma política usada para eliminar uma chave de acesso OAuth 2.0. O exemplo abaixo localiza o token de acesso a eliminar na mensagem de pedido procurando um cabeçalho denominado access_token.

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

Elimine o código de autorização

Segue-se um exemplo de política usada para eliminar um código de autorização OAuth 2.0. O exemplo abaixo localiza o código de autorização a eliminar na mensagem de pedido procurando um parâmetro de consulta denominado code.

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

Referência do elemento

A referência do elemento descreve os elementos e os 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 Predefinição Presença
assíncrono

Definido como true para especificar que a política deve ser executada num conjunto de threads diferente do conjunto que presta serviço ao fluxo de pedido/resposta. A predefinição é false.

Esta definição é usada apenas para otimização interna.

 falso Opcional
continueOnError

A maioria das políticas deve devolver um erro quando ocorre uma falha. Se definir este 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 estiver definida como false, a política é "desativada" e não é aplicada (embora a política permaneça associada a um fluxo). verdadeiro Opcional
nome

O nome interno da política. Este nome é referenciado nos elementos de passos para anexar a política a um fluxo.

Nota: os carateres que pode usar no nome estão restritos a: A-Z0-9._\-$ %. A IU do Apigee aplica restrições adicionais, como a remoção automática de carateres que não sejam alfanuméricos.

 N/A Obrigatória

Elemento <AccessToken>

Identifica a variável onde se encontra o token de acesso a eliminar. Por exemplo, se o token de acesso estiver anexado à mensagem de pedido como um parâmetro de consulta denominado "access_token", especifique request.queryparam.access_token. Pode usar qualquer variável válida que faça referência ao token. Em alternativa, pode transmitir a string do token literal (caso raro).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinição: N/A
Presença: É necessário <AccessToken> ou <AuthorizationCode>.
Tipo: String

Atributos

Atributo Descrição Predefinição Presença
ref

Uma variável de token de acesso. Normalmente, é obtido de uma variável de fluxo. Por exemplo: request.header.token ou request.queryparam.token.

 N/A Opcional

Elemento <AuthorizationCode>

Identifica a variável onde se encontra o código de autorização a eliminar. Por exemplo, se o código de autorização estiver anexado à mensagem de pedido como um parâmetro de consulta denominado "code", especifique request.queryparam.code. Pode usar qualquer variável válida que faça referência ao token. Em alternativa, pode transmitir a string do token literal (caso raro).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Predefinição: N/A
Presença: É necessário <AccessToken> ou <AuthorizationCode>.
Tipo: String

Atributos

Atributo Descrição Predefinição Presença
ref

Uma variável de token de acesso. Normalmente, é obtido de uma variável de fluxo. Por exemplo: request.header.code ou request.queryparam.code.

 N/A Opcional

Elemento<DisplayName>

Um nome em linguagem natural que etiqueta a política no editor de proxy da IU do Apigee. Se for omitido, é usado o atributo de nome da política.

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

Referência de erro

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.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 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.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>

Esquema

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

Tópicos relacionados