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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
Templates
=========
A set of templates is provided. These templates range from Django Admin Site alternatives to manage the Apps that use your App as a provider, to Error and Authorization Templates.
You can override default templates located in ``templates/oauth2_provider`` folder and provide a custom layout.
To override these templates you just need to create a folder named ``oauth2_provider`` inside your templates folder and, inside this folder, add a file that matches the name of the template you're trying to override.
.. important:
In ``INSTALLED_APPS`` on ``settings.py``, ``'django.contrib.staticfiles'``, must be before ``'oauth2_provider'``.
.. note:
Every view provides access only to data belonging to the logged in user who performs the request.
The templates available are:
- `base.html`_
- `authorize.html`_
- `Management`_:
- `Application`_:
- `application_list.html`_
- `application_form.html`_
- `application_registration_form.html`_
- `application_detail.html`_
- `application_confirm_delete.html`_
- `Token`_:
- `authorized-tokens.html`_
- `authorized-token-delete.html`_
base.html
---------
If you just want a different look and feel you may only override this template.
To inherit this template just add ``{% extends "oauth2_provider/base.html" %}`` in the first line of the other templates. This is what is done with the default templates.
The blocks defined in it are:
- ``title`` inside the HTML title tag;
- ``css`` inside the head;
- ``content`` in the body.
.. note:
See ` Django docs on template inheritance <https://docs.djangoproject.com/en/dev/ref/templates/language/#template-inheritance>`_ for more information on the use of blocks.
authorize.html
--------------
Authorize is rendered in :class:`~oauth2_provider.views.base.AuthorizationView` (``authorize/``).
This template gets passed the following context variables:
- ``scopes`` - :obj:`list` with the scopes requested by the application;
.. caution::
See :ref:`settings_default_scopes` to understand what is returned if no scopes are requested.
- ``scopes_descriptions`` - :obj:`list` with the descriptions for the scopes requested;
- ``application`` - An :class:`~oauth2_provider.models.Application` object
.. note::
If you haven't created your own Application Model (see how in :ref:`extend_app_model`), you will get an
:class:`~oauth2_provider.models.AbstractApplication` object.
- ``client_id`` - Passed in the URI, already validated.
- ``redirect_uri`` - Passed in the URI (optional), already validated.
.. note::
If it wasn't provided on the request, the default one has been set (see :meth:`~oauth2_provider.models.AbstractApplication.default_redirect_uri`).
- ``response_type`` - Passed in the URI, already validated.
- ``state`` - Passed in the URI (optional).
- ``form`` - An :class:`~oauth2_provider.forms.AllowForm` with all the hidden fields already filled with the values above.
.. important::
One extra variable, named ``error`` will also be available if an Oauth2 exception occurs.
This variable is a :obj:`dict` with ``error`` and ``description``
Example (this is the default page you may find on ``templates/oauth2_provider/authorize.html``): ::
{% extends "oauth2_provider/base.html" %}
{% load i18n %}
{% block content %}
<div class="block-center">
{% if not error %}
<form id="authorizationForm" method="post">
<h3 class="block-center-heading">{% trans "Authorize" %} {{ application.name }}?</h3>
{% csrf_token %}
{% for field in form %}
{% if field.is_hidden %}
{{ field }}
{% endif %}
{% endfor %}
<p>{% trans "Application requires the following permissions" %}</p>
<ul>
{% for scope in scopes_descriptions %}
<li>{{ scope }}</li>
{% endfor %}
</ul>
{{ form.errors }}
{{ form.non_field_errors }}
<div class="control-group">
<div class="controls">
<input type="submit" class="btn btn-large" value="Cancel"/>
<input type="submit" class="btn btn-large btn-primary" name="allow" value="Authorize"/>
</div>
</div>
</form>
{% else %}
<h2>Error: {{ error.error }}</h2>
<p>{{ error.description }}</p>
{% endif %}
</div>
{% endblock %}
Management
----------
The management templates are Django Admin Site alternatives to manage the Apps.
Application
```````````
All templates receive :class:`~oauth2_provider.models.Application` objects.
.. note::
If you haven't created your own Application Model (see how in :ref:`extend_app_model`), you will get an
:class:`~oauth2_provider.models.AbstractApplication` object.
application_list.html
~~~~~~~~~~~~~~~~~~~~~
Rendered in :class:`~oauth2_provider.views.base.ApplicationList` (``applications/``).
This class inherits :class:`django.views.generic.edit.ListView`.
This template gets passed the following template context variable:
- ``applications`` - a :obj:`list` with all the applications, may be ``None``.
application_form.html
~~~~~~~~~~~~~~~~~~~~~
Rendered in :class:`~oauth2_provider.views.base.ApplicationUpdate` (``applications/<pk>/update/``).
This class inherits :class:`django.views.generic.edit.UpdateView`.
This template gets passed the following template context variables:
- ``application`` - the :class:`~oauth2_provider.models.Application` object.
- ``form`` - a :obj:`~django.forms.Form` with the following fields:
- ``name``
- ``client_id``
- ``client_secret``
- ``client_type``
- ``authorization_grant_type``
- ``redirect_uris``
- ``post_logout_redirect_uris``
.. caution::
In the default implementation this template in extended by `application_registration_form.html`_.
Be sure to provide the same blocks if you are only overriding this template.
application_registration_form.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Rendered in :class:`~oauth2_provider.views.base.ApplicationRegistration` (``applications/register/``).
This class inherits :class:`django.views.generic.edit.CreateView`.
This template gets passed the following template context variable:
- ``form`` - a :obj:`~django.forms.Form` with the following fields:
- ``name``
- ``client_id``
- ``client_secret``
- ``client_type``
- ``authorization_grant_type``
- ``redirect_uris``
- ``post_logout_redirect_uris``
.. note::
In the default implementation this template extends `application_form.html`_.
application_detail.html
~~~~~~~~~~~~~~~~~~~~~~~
Rendered in :class:`~oauth2_provider.views.base.ApplicationDetail` (``applications/<pk>/``).
This class inherits :class:`django.views.generic.edit.DetailView`.
This template gets passed the following template context variable:
- ``application`` - the :class:`~oauth2_provider.models.Application` object.
application_confirm_delete.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Rendered in :class:`~oauth2_provider.views.base.ApplicationDelete` (``applications/<pk>/delete/``).
This class inherits :class:`django.views.generic.edit.DeleteView`.
This template gets passed the following template context variable:
- ``application`` - the :class:`~oauth2_provider.models.Application` object.
.. important::
To override successfully this template you should provide a form that posts to the same URL, example:
``<form method="post" action="">``
Token
`````
All templates receive :class:`~oauth2_provider.models.AccessToken` objects.
authorized-tokens.html
~~~~~~~~~~~~~~~~~~~~~~
Rendered in :class:`~oauth2_provider.views.base.AuthorizedTokensListView` (``authorized_tokens/``).
This class inherits :class:`django.views.generic.edit.ListView`.
This template gets passed the following template context variable:
- ``authorized_tokens`` - a :obj:`list` with all the tokens that belong to applications that the user owns, may be ``None``.
.. important::
To override successfully this template you should provide links to revoke the token, example:
``<a href="{% url 'oauth2_provider:authorized-token-delete' authorized_token.pk %}">revoke</a>``
authorized-token-delete.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Rendered in :class:`~oauth2_provider.views.base.AuthorizedTokenDeleteView` (``authorized_tokens/<pk>/delete/``).
This class inherits :class:`django.views.generic.edit.DeleteView`.
This template gets passed the following template context variable:
- ``authorized_token`` - the :class:`~oauth2_provider.models.AccessToken` object.
.. important::
To override successfully this template you should provide a form that posts to the same URL, example:
``<form method="post" action="">``
|
