summaryrefslogtreecommitdiff
path: root/doc/disfluid.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/disfluid.texi')
-rw-r--r--doc/disfluid.texi43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/disfluid.texi b/doc/disfluid.texi
index 8f22927..16cb1e3 100644
--- a/doc/disfluid.texi
+++ b/doc/disfluid.texi
@@ -1549,6 +1549,7 @@ the user.
* Request authentication::
* Hello world::
* Reverse proxy::
+* Client pages::
@end menu
@node Error signalling
@@ -1698,6 +1699,48 @@ Return the header set by the reverse proxy to hold the authenticated
webid.
@end deffn
+@node Client pages
+@section Client pages
+The @emph{(webid-oidc server endpoint client)} module defines an
+endpoint to serve the public pages for a client application.
+
+@deftp {Class} <client-id> (<endpoint>) @var{client-id} @var{redirect-uris} @var{client-name} @var{client-uri} @var{grant-types} @var{response-types}
+During the OIDC authorization process, the identity provider must
+check some things against the public URI of a client application. This
+endpoint will respond to this query.
+
+You can construct it with @code{#:@var{redirect-uris}} (a list of
+URIs), @code{#:@var{client-id}} (an URI, or string encoding an URI),
+@code{#:@var{client-name}} (a string), @code{#:@var{grant-types}} (a
+list of symbols or strings), @code{#:@var{response-types}} (a list of
+symbols or strings).
+@end deftp
+
+@deffn {Generic} redirect-uris @var{client-id}
+Return the list of approved redirection URIs.
+@end deffn
+
+@deffn {Generic} client-id @var{client-id}
+Return the URI where the application can be queried by the identity
+provider.
+@end deffn
+
+@deffn {Generic} client-name @var{client-id}
+Return the associated name. Please note that the companion
+implementation of the identity provider in this package will not
+display the name to the user, because it can be misleading.
+@end deffn
+
+@deffn {Generic} client-uri @var{client-id}
+Return the URI where people can find information about the
+application. Also not hidden by the identity provider.
+@end deffn
+
+@deftp {Class} <redirect-uri> (<endpoint>)
+This endpoint receives an authorization code, and display it to the
+user, asking to paste it in the application.
+@end deftp
+
@node Running an Identity Provider
@chapter Running an Identity Provider