diff options
author | Vivien Kraus <vivien@planete-kraus.eu> | 2021-08-13 01:02:17 +0200 |
---|---|---|
committer | Vivien Kraus <vivien@planete-kraus.eu> | 2021-08-13 02:00:31 +0200 |
commit | c9447c0d28f6c45a1ba4962a4265bcbb67f97b6c (patch) | |
tree | aa2f89bd1361d3e76641714dd347b02ce97f258a /doc | |
parent | d48941a18ab6765a849641bcf506a69634693db3 (diff) |
Clarify that @var{subject} is optional
Diffstat (limited to 'doc')
-rw-r--r-- | doc/disfluid.texi | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/disfluid.texi b/doc/disfluid.texi index 0a2c489..4e120f8 100644 --- a/doc/disfluid.texi +++ b/doc/disfluid.texi @@ -873,12 +873,18 @@ The list of accounts is stored on the file system. You can manipulate the accounts with the @emph{(webid-oidc client accounts)} module. @deftp {Record type} <account> @var{subject} @var{issuer} @var{id-token} @var{access-token} @var{refresh-token} @var{keypair} -Store information about an account. @var{subject} and @var{issuer} are -required, they must bue URIs. If the access token was not invalidated, -then @var{id-token} contains a (decrypted) identity token, and -@var{access-token} an encrypted access token. If you got a -@var{refresh-token} for this account, it is also stored, along with -the @var{keypair} that is server-side bound to it. +Store information about an account. @var{subject} is optional, +@var{issuer} is required, but they must both be URIs. In a typical +application, you would ask the user for per @var{issuer}, without +bothering perse with a webid (it can be long to type), and then start +making requests with this account. When you need an authorization +code, you will know the user’s webid. + +If the access token was not invalidated, then @var{id-token} contains +a (decrypted) identity token, and @var{access-token} an encrypted +access token. If you got a @var{refresh-token} for this account, it is +also stored, along with the @var{keypair} that is server-side bound to +it. The optional parameters are @code{#f} when we don’t have them. @end deftp |