taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit 870b84496c94ec439f00bad21ef6b68c99cdc2c4
parent ce9d221709cbc824a23701a69afe14df0d69b7ee
Author: Christian Grothoff <christian@grothoff.org>
Date:   Mon,  8 May 2023 20:16:07 +0200

rename /login to /authorize

Diffstat:
Mcore/api-challenger.rst | 16++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/core/api-challenger.rst b/core/api-challenger.rst @@ -30,7 +30,7 @@ challenger service (via command-line). Henceforth, that client can use the challenger service when it needs a user to prove that the user is able to receive messages at a particular address. -In that case, it makes a request to the ``/login`` endpoint of the challenger +In that case, it makes a request to the ``/authorize`` endpoint of the challenger service using its client secret for authentication. The challenger service will return a Web page asking the client to provide its address. @@ -39,7 +39,7 @@ to the ``/challenge`` endpoint and the challenger service will send a challenge to the user's address and generate a form asking 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. +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 ``/authorize``, together with an authorization grant. Given this authorization grant, the OAuth 2.0 client can then use the ``/token`` endpoint to obtain an access token which will grant it access to the @@ -104,7 +104,7 @@ Setup .. ts:def:: ChallengeSetupResponse interface ChallengeSetupResponse { - // Nonce to use when constructing ``/login`` endpoint. + // Nonce to use when constructing ``/authorize`` endpoint. nonce: string; } @@ -115,8 +115,8 @@ Setup Login ----- -.. http:get:: /login/$NONCE -.. http:post:: /login/$NONCE +.. http:get:: /authorize/$NONCE +.. http:post:: /authorize/$NONCE This endpoint is used by the user-agent. It will return a form to enter the address. @@ -188,9 +188,9 @@ Solve The user is redirected to the client to pass the grant to the client. The target will be the redirect URI specified by the client upon - ``/login``, plus a ``code`` argument with the + ``/authorize``, plus a ``code`` argument with the authorization code, and the ``state`` argument - from the ``/login``. + from the ``/authorize`` endpoint. :http:statuscode:`403 Forbidden`: The solution of the user is invalid. The body is typically again the challenge form (same as @@ -218,7 +218,7 @@ Auth specifying the ``client_id``, ``redirect_uri``, ``client_secret``, ``code`` and ``grant_type``. The ``grant_type`` must be set to ``authorization_code``. The ``redirect_uri`` must match the URI from - ``/login``. The ``code`` must be the authorization code that ``/solve`` + ``/authorize``. The ``code`` must be the authorization code that ``/solve`` returned to the user. The ``client_id`` and ``client_secret`` must match the usual client credentials.