commit ce9d221709cbc824a23701a69afe14df0d69b7ee
parent a320478c039e9750cf92e63e78185cdad5be8f89
Author: Christian Grothoff <christian@grothoff.org>
Date: Mon, 8 May 2023 17:03:02 +0200
rename /auth to /token
Diffstat:
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/core/api-challenger.rst b/core/api-challenger.rst
@@ -42,7 +42,7 @@ the user to enter the received challenge value.
The user can then enter the answer to the challenge which is then submitted to the ``/solve`` endpoint. If the answer is correct, the user will be redirected to the client redirect URI that was specified by the OAuth 2.0 client upon ``/login``, together with an authorization grant.
Given this authorization grant, the OAuth 2.0 client can then use the
-``/auth`` endpoint to obtain an access token which will grant it access to the
+``/token`` endpoint to obtain an access token which will grant it access to the
resource. Using the ``/info`` endpoint the client can then finally obtain the
verified address of the user. The user-agent should finally be redirected to
some confirmation site affirming the end of the process.
@@ -89,7 +89,7 @@ Setup
An ``Authorization`` header (for now always using a ``bearer`` token) should
be included to provide the client's credentials to authorize access to the
challenger service. This token must match the ``client_secret`` in the
- later ``/auth`` request.
+ later ``/token`` request.
**Response:**
@@ -206,7 +206,7 @@ Solve
Auth
----
-.. http:post:: /auth
+.. http:post:: /token
This endpoint is used by the client to provide
its grant, demonstrating that it has the right to
@@ -261,7 +261,7 @@ Info
**Request:**
- Must include the grant token from ``/auth`` as a bearer token in an ``Authorization`` header.
+ Must include the grant token from ``/token`` as a bearer token in an ``Authorization`` header.
**Response:**