Widerrufen des Endpunkts

Der oauth2/revoke Endpunkt/widerruft das Zugriffstoken eines Benutzers, das Amazon Cognito ursprünglich mit dem von Ihnen bereitgestellten Aktualisierungstoken ausgestellt hat. Dieser Endpunkt widerruft auch alle nachfolgenden Zugriffs- und Identitätstoken desselben Aktualisierungstoken. Nachdem der Endpunkt die Token widerrufen hat, können Sie die widerrufenen Zugriffs-Token nicht verwenden, um auf APIs zuzugreifen, die Amazon-Cognito-Token authentifizieren.

POST /oauth2/revoke

Der /oauth2/revoke Endpunkt unterstützt ausschließlich HTTPS POST. Der Benutzer-Pool sendet Anforderungen direkt an diesen Endpunkt und nicht über den System-Browser.

Anfrageparameter im Header

Authorization

Wenn Ihr App-Client über einen geheimen Clientschlüssel verfügt, muss die Anwendung dessen client_id und client_secret im Autorisierungsheader über die Basic-HTTP-Autorisierung weitergeben. Der Geheim-Schlüssel ist Basic Base64Encode(client_id:client_secret).

Content-Type

Es muss sich immer um handeln 'application/x-www-form-urlencoded'.

Anfrageparameter im Fließtext

token

(Erforderlich) Das Aktualisierungstoken, das der Client widerrufen möchte. Die Anforderung widerruft auch alle Zugriffstoken, die Amazon Cognito mit diesem Aktualisierungstoken ausgegeben hat.

Erforderlich

client_id

(Optional) Die App-Client-ID für das Token, das Sie widerrufen möchten.

Erforderlich, wenn der Client öffentlich ist und keinen Geheim-Schlüssel hat.

Beispiel für einen Widerrufsanforderung

Beispiel 1: Widerrufen eines Token für einen App-Client ohne Client-Schlüssel

    POST /oauth2/revoke HTTP/1.1
        Host: https://mydomain.auth.us-east-1.amazoncognito.com
        Accept: application/json
        Content-Type: application/x-www-form-urlencoded
        token=2YotnFZFEjr1zCsicMWpAA&
        client_id=djc98u3jiedmi283eu928

Beispiel 2: Widerrufen eines Token für einen App-Client mit Client-Schlüssel

    POST /oauth2/revoke HTTP/1.1
        Host: https://mydomain.auth.us-east-1.amazoncognito.com
        Accept: application/json
        Content-Type: application/x-www-form-urlencoded
        Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
        token=2YotnFZFEjr1zCsicMWpAA

Antwort auf einen Fehler

Eine erfolgreiche Antwort enthält einen leeren Körper. Die Fehlerantwort ist ein JSON-Objekt mit einem error-Feld und in manchen Fällen ein error_description-Feld.

Endpunktfehler

• Ihnen werden HTTP 400 und der Fehler invalid_request angezeigt, wenn das Token in der Anforderung nicht vorhanden ist oder wenn die Funktion für den App-Client deaktiviert ist.

• Wenn das Token, das Amazon Cognito in der Widerrufsanfrage gesendet hat, kein Aktualisierungstoken ist, erhalten Sie ein HTTP 400 und den Fehler unsupported_token_type.

• Wenn die Client-Anmeldeinformationen nicht gültig sind, wird Ihnen HTTP 401 und der Fehler invalid_client angezeigt.

• Wenn das Token widerrufen wurde oder der Client ein ungültiges Token übermittelt hat, erhalten Sie ein HTTP 200-OK.