From 6309cff957b129a27a16dca0a4ea18b635c964ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Wed, 18 Jun 2025 11:36:55 +0200 Subject: [PATCH] Apply review suggestions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kévin Commaille --- content/client-server-api/_index.md | 57 ++++++++++++++++++++++------- 1 file changed, 43 insertions(+), 14 deletions(-) diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index 0df0a8f6..f73d300c 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -1487,24 +1487,53 @@ When a user wants to log out from a client, the client SHOULD use OAuth 2.0 token revocation as defined in [RFC 7009](https://datatracker.ietf.org/doc/html/rfc7009). The client makes a `POST` request to the `revocation_endpoint` that can be found -in the authorization server metadata. +in the [authorization server metadata](#server-metadata-discovery). The body of the request includes the following parameters, encoded as `application/x-www-form-urlencoded`: -- `token`: This parameter MUST contain either the access token or the refresh - token to be revoked. -- `token_type_hint`: This parameter is OPTIONAL, and if present, MUST have a - value of either `access_token` or `refresh_token`. The server MAY use this - value to optimize the token lookup process. -- `client_id`: The client identifier obtained during client registration. This - parameter is OPTIONAL. - - If the `client_id` is not provided, or does not match the client associated - with the token, the server SHOULD still revoke the token. This behavior is - meant to help good actors like secret scanning tools to proactively revoke - leaked tokens. The server MAY also warn the user that one of their sessions - may be compromised in this scenario. + + + + + + + + + + + + + + + + + + + + + +
ParameterValue
token + Required. MUST contain either the access token or the + refresh token to be revoked. +
token_type_hint + Optional. If present, MUST have a value of either + access_token or refresh_token. The server MAY + use this value to optimize the token lookup process. +
client_id +

+ Optional. The client identifier obtained during + client registration. +

+

+ If the client_id is not provided, or does not match the + client associated with the token, the server SHOULD still revoke the + token. This behavior is meant to help good actors like secret scanning + tools to proactively revoke leaked tokens. The server MAY also warn + the user that one of their sessions may be compromised in this + scenario. +

+
For example, revoking using the access token: