summaryrefslogtreecommitdiff
path: root/manpages/taler.conf.5.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2023-01-10 14:04:54 +0100
committerChristian Grothoff <christian@grothoff.org>2023-01-10 14:04:54 +0100
commita47232f256ae2d1463efa15e284ad36c2887e1c2 (patch)
tree7330f25b170646ed708af060d8e1ad56e43f0476 /manpages/taler.conf.5.rst
parent74bc9dcddc6e27cb12448382b34427ba6d03c607 (diff)
downloaddocs-a47232f256ae2d1463efa15e284ad36c2887e1c2.tar.gz
docs-a47232f256ae2d1463efa15e284ad36c2887e1c2.tar.bz2
docs-a47232f256ae2d1463efa15e284ad36c2887e1c2.zip
clarify KYC options for oauth2.0 some more
Diffstat (limited to 'manpages/taler.conf.5.rst')
-rw-r--r--manpages/taler.conf.5.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst
index 4ab82356..357c23fc 100644
--- a/manpages/taler.conf.5.rst
+++ b/manpages/taler.conf.5.rst
@@ -174,13 +174,13 @@ KYC_OAUTH2_VALIDITY
Duration (e.g. "12 months") of the validity of the performed KYC check. Can be "forever".
KYC_OAUTH2_AUTH_URL
- URL of the OAuth2 endpoint to be used for KYC checks. Example: "http://localhost:8888/oauth/v2/login" (or "/token")
+ URL of the OAuth2 endpoint to be used for KYC checks. This is where the server will ultimately send the authorization token from the client and obtain its access token (which currently must be a "bearer" token). Example: "http://localhost:8888/oauth/v2/auth" (or "/token")
KYC_OAUTH2_LOGIN_URL
- URL of the OAuth2 endpoint to be used for KYC checks. Example: "http://localhost:8888/oauth/v2/login"
+ URL of the OAuth2 endpoint to be used for KYC checks. The login URL will be encoded as part of the 'redirect_uri' argument of the request to the KYC_AUTH2_AUTH_URL. Typically, the user will then be redirected to this URL to log in. Example: "http://localhost:8888/oauth/v2/login"
KYC_OAUTH2_INFO_URL
- URL of the endpoint where the OAuth 2.0 token can be used to download the user's details. Example: "http://localhost:8888/api/user/me"
+ URL of the endpoint where the OAuth 2.0 token can be used to download the user's details. The server will use the access token obtained from the KYC_AUTH2_AUTH_URL to show that it is authorized to obtain the details. Example: "http://localhost:8888/api/user/me" or "http://localhost:8888/oauth/v2/info"
KYC_OAUTH2_CLIENT_ID
Client ID of the exchange when it talks to the KYC OAuth2 endpoint.
@@ -189,7 +189,7 @@ KYC_OAUTH2_CLIENT_SECRET
Client secret of the exchange to use when talking to the KYC Oauth2 endpoint.
KYC_OAUTH2_POST_URL
- URL to which the exchange will redirect the client's browser after successful authorization/login for the KYC process.
+ URL to which the exchange will redirect the client's browser after successful authorization/login for the KYC process. Example: "http://example.com/thank-you"
EXCHANGE KYC KYCAID OPTIONS