summaryrefslogtreecommitdiff
path: root/docs/oauth2/endpoints/endpoints.rst
blob: f05c44b65f5874db3460c4107055ea5a11901083 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Provider Endpoints
==================

Endpoints in OAuth 2 are targets with a specific responsibility and often
associated with a particular URL. Because of this the word endpoint might be
used interchangeably from the endpoint url.

The main three responsibilities in an OAuth 2 flow is to authorize access to a
certain users resources to a client, to supply said client with a token
embodying this authorization and to verify that the token is valid when the
client attempts to access the user resources on their behalf.


.. toctree::
    :maxdepth: 2

    authorization
    introspect
    token
    metadata
    revocation
    resource

There are three main endpoints, the authorization endpoint which mainly
handles user authorization, the token endpoint which provides tokens and the
resource endpoint which provides access to protected resources. It is to the
endpoints you will feed requests and get back an almost complete response. This
process is simplified for you using a decorator such as the django one described
later (but it's applicable to all other web frameworks libraries).

The main purpose of the endpoint in OAuthLib is to figure out which grant type
or token to dispatch the request to.

Then, you can extend your OAuth implementation by proposing introspect,
revocation and/or providing metadata endpoints.