Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
![](https://docs.apigee.com/static/api-platform/images/icon_policy_security.jpg?authuser=8&hl=pt)
O que
Exclui o código de autorização OAuth V2 especificado ou o token de acesso.
Exemplos
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 Essa configuração é usada apenas para otimização interna. |
false | Opcional |
continueOnError |
Espera-se que a maioria das políticas retorne um erro quando ocorre uma falha. Ao definir esse
atributo como |
false | Opcional |
ativado | 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). |
verdadeiro | 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:
|
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, |
N/A | 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, |
N/A | 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
Nesta seção, descrevemos os códigos e as mensagens de erro retornados, além das variáveis de falha definidas pelo Edge quando esta política aciona um erro. Essas informações são importantes para saber se você está desenvolvendo regras de falha para lidar com falhas. Para saber mais, consulte O que você precisa saber sobre erros de política e Como lidar com falhas.
Erros de execução
Esses erros podem ocorrer quando a política é executada.
Código de falha | Status HTTP | Causa |
---|---|---|
steps.oauth.v2.invalid_access_token |
401 | O token de acesso enviado para a política é inválido. |
steps.oauth.v2.invalid_request-authorization_code_invalid |
401 | O código de autorização enviado para a política é inválido. |
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound |
401 | Consulte esta postagem da comunidade da Apigee para informações sobre como solucionar esse erro. |
Erros de implantação
Consulte a mensagem relatada na IU para informações sobre erros de implantação.
Variáveis de falha
Essas variáveis são definidas quando essa política aciona um erro no ambiente de execução.
Variáveis | Onde | Exemplo |
---|---|---|
fault.name="fault_name" |
fault_name é o nome da falha, conforme listado na tabela Erros de ambiente 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 da política especificada pelo usuário que gerou a falha. | oauthV2.DeleteTokenInfo.failed = true |
oauthV2.policy_name.fault.name |
policy_name é o nome da política especificada pelo usuário que gerou a falha. | oauthV2.DeleteTokenInfo.fault.name = invalid_access_token |
oauthv2.policy_name.fault.cause |
policy_name é o nome da política especificada pelo usuário que gerou a falha. | oauthV2.DeleteTokenInfo.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="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ítica
estão disponíveis no GitHub.