View Issue Details

IDProjectCategoryView StatusLast Update
0010575Talerdocumentationpublic2025-11-11 12:30
Reporterhtgoebel Assigned Toschanzen  
PrioritynormalSeveritytextReproducibilityhave not tried
Status assignedResolutionopen 
Product Version1.0 
Target Version1.5 
Summary0010575: Enhance documentation for Authentication
DescriptionThe section "Authentication" in the merchant backend documentations currently is confusing and would befit from some improvements. It is confusing since it writes about "the /private/auth/ API" but not about private endpoints in general, Also the description about how to obtain a "login token" is not obvious.

- Don't mention "the /private/auth/ API" here since the authentication schemes apply to all endpoints.
- Deprecated method behind current ones.
- Mention Basic Auth (and that it is only valid for /private/auth and /private/token)
- Deprecated "token", last sentence: "login token", but this term was not used before.
- Non-deprected "token" uses "bearer token", "authentication token"
- How to retrieve a token should be more prominent. Since this is the only non-deprected way of authentication, I suggest putting this into (short) section of its own.
- "A login token is commonly only valid for a limited period of time": Mention that this period can be defined when retrieving a token.
- Endpoint releated to authentication (/private/auth, /private/token) should go into this section. At least they should go into a separrate section "Authentication Management" in "Instance Management" and not be hidden under "Setting up instances".
TagsNo tags attached.

Activities

Christian Grothoff

2025-11-11 12:30

manager   ~0026373

Martin, can you please look into this? Seems to be largely related to things you worked on...

Issue History

Date Modified Username Field Change
2025-11-10 21:35 htgoebel New Issue
2025-11-11 12:29 Christian Grothoff Assigned To => schanzen
2025-11-11 12:29 Christian Grothoff Status new => assigned
2025-11-11 12:30 Christian Grothoff Severity feature => text
2025-11-11 12:30 Christian Grothoff Product Version => 1.0
2025-11-11 12:30 Christian Grothoff Target Version => 1.5
2025-11-11 12:30 Christian Grothoff Note Added: 0026373