Skip to content

Commit

Permalink
Fix function references in docs
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick Uiterwijk <patrick@puiterwijk.org>
  • Loading branch information
puiterwijk committed May 24, 2016
1 parent 49756d8 commit 2d039f0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,27 +39,27 @@ instance of the :class:`OpenID` object first::

Alternatively the object can be instantiated without the application in
which case it can later be registered for an application with the
:meth:`~OpenIDConnect.init_app` method.
:meth:`~flask_oidc.OpenIDConnect.init_app` method.

Note that you should probably provide the library with a place to store the
credentials it has retrieved for the user. These need to be stored in a place
where the user themselves or an attacker can not get to them.
To provide this, give an object that has ``__setitem__`` and ``__getitem__``
dict APIs implemented as second argument to the :meth:`~OpenIDConnect.__init__`
dict APIs implemented as second argument to the :meth:`~flask_oidc.OpenIDConnect.__init__`
call.
Without this, the library will only work on a single thread, and only retain
sessions until the server is restarted.

Using this library is very simple: you can use
:data:`~OpenIDConnect.user_loggedin` to determine whether a user is currently
:data:`~flask_oidc.OpenIDConnect.user_loggedin` to determine whether a user is currently
logged in using OpenID Connect.

If the user is logged in, you an use :meth:`~OpenIDConnect.user_getfield` and
:meth:`~OpenIDConnect.user_getinfo` to get information about the currently
If the user is logged in, you an use :meth:`~flask_oidc.OpenIDConnect.user_getfield` and
:meth:`~flask_oidc.OpenIDConnect.user_getinfo` to get information about the currently
logged in user.

If the user is not logged in, you can send them to any function that is
decorated with :meth:`~OpenIDConnect.require_login` to get them automatically
decorated with :meth:`~flask_oidc.OpenIDConnect.require_login` to get them automatically
redirected to login.


Expand All @@ -86,7 +86,7 @@ Resource server

Also, if you have implemented an API that can should be able to accept tokens
issued by the OpenID Connect provider, just decorate those API functions with
:meth:`~OpenIDConnect.accept_token`::
:meth:`~flask_oidc.OpenIDConnect.accept_token`::

@app.route('/api')
@oidc.accept_token()
Expand Down

0 comments on commit 2d039f0

Please sign in to comment.