DeleteOAuthV2Info

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Información | Muestras | Elemento referencia | Resultado | Esquema | Temas relacionados

Qué

Borra el token de autorización o el token de acceso de OAuth V2 especificados.

Ejemplos

Borra tokens de acceso

A continuación, se muestra una política de ejemplo que se usa para borrar un token de acceso de OAuth 2.0. El siguiente ejemplo localiza el token de acceso que se borrará en el mensaje de la solicitud mediante la búsqueda de un encabezado llamado access_token

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

A continuación, se muestra un ejemplo de una política que se usa para borrar un código de autorización de OAuth 2.0. El ejemplo a continuación, se localiza el código de autorización que se debe borrar del mensaje de solicitud mediante la búsqueda de un parámetro de consulta llamada code.

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

Referencia de elementos

La referencia del elemento describe los elementos y atributos de la 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 Descripción Predeterminado Presencia
async

Configúralo como true para especificar que la política debe ejecutarse en un grupo de subprocesos diferente del grupo que entrega el flujo de solicitud/respuesta. El valor predeterminado es false

Esta configuración solo se usa para la optimización interna.

 falso Opcional
continueOnError

Se espera que la mayoría de las políticas muestren un error cuando se produzca un error. Si configuras este atributo como true, la ejecución del flujo continúa con errores.

 falso Opcional
habilitado Determina si se aplica o no una política. Si se configura como false, se inhabilita una política, y no se aplicará (aunque la política permanece adjunta a un flujo). true Opcional
name

El nombre interno de la política. Este nombre se menciona en elementos del paso para adjuntar la política a un flujo.

Nota: Los caracteres que puedes usar en el nombre están restringidos a: A-Z0-9._\-$ %. La IU de administración aplica restricciones adicionales, como quita automáticamente los caracteres que no son alfanuméricos.

 N/A Obligatorio

Elemento <AccessToken>

Identifica la variable en la que se encuentra el token de acceso que se borrará. Por ejemplo, si el token de acceso se adjunta para solicitar un mensaje como un parámetro de consulta llamado "access_token", especifica request.queryparam.access_token. Puedes usar cualquier variable válida que haga referencia al token. O bien, puedes pasar la string del token literal (este es un caso raro).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Predeterminado: N/A
Presencia: Se requiere <AccessToken> o <AuthorizationCode>.
Tipo: String

Atributos

Atributo Descripción Predeterminado Presencia
ref

Una variable de token de acceso. Por lo general, se recupera de una variable de flujo. Por ejemplo, request.header.token o request.queryparam.token.

 N/A Opcional

Elemento <AuthorizationCode>

Identifica la variable en la que se encuentra el código de autorización que se borrará. Por ejemplo, si el código de Auth está adjunto para solicitar un mensaje como un parámetro de consulta llamado “código”, especifica request.queryparam.code. Puedes usar cualquier variable válida que haga referencia al token. O bien, puedes pasar la string del token literal (este es un caso raro).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Predeterminado: N/A
Presencia: Se requiere <AccessToken> o <AuthorizationCode>.
Tipo: String

Atributos

Atributo Descripción Predeterminado Presencia
ref

Una variable de token de acceso. Por lo general, se recupera de una variable de flujo. Por ejemplo, request.header.code o request.queryparam.code.

 N/A Opcional

Elemento <DisplayName>

Un nombre de lenguaje natural que etiqueta la política en el editor de proxy de la IU de administración. Si se omite, se usa el atributo de nombre de política.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Predeterminado: El valor del atributo name de la política.
Presencia: Opcional
Tipo: String

Salida

Si la operación se realiza correctamente, la política muestra un estado 200.

Si se produce un error, la política muestra el error 404 y el resultado es similar al siguiente (dependiendo de si borras un token de acceso o código de autenticación):

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}

Esquema

Un esquema XML (.xsd) define cada tipo de política. Como referencia, los esquemas de políticas están disponibles en GitHub.

Temas relacionados