Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/conformist-mw/django-oauth
Django OAuth2 application with consumer to authorize client and retrieve token. Also simple api with OAuth protection available
https://github.com/conformist-mw/django-oauth
Last synced: 1 day ago
JSON representation
Django OAuth2 application with consumer to authorize client and retrieve token. Also simple api with OAuth protection available
- Host: GitHub
- URL: https://github.com/conformist-mw/django-oauth
- Owner: conformist-mw
- Created: 2018-02-01T20:42:10.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T18:48:15.000Z (7 months ago)
- Last Synced: 2024-04-24T20:21:40.175Z (7 months ago)
- Language: HTML
- Size: 42 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django OAuth2 Application
Test project that allows you to create OAuth2 applications and getting tokens by client app `Consumer`.
To test api you have to create new application. Go to [/consumer](http://localhost:8000/consumer/) and login. Then click on `Applications` and create new app with grand type: _Resource owner password-based_ and client type: _confidential_
Assuming your credentials are:
```bash
client_id=qbmpPpuEnAvWoI8s55L9McafHwjHD8Wsjfm2oShu
client_secret=W39qCKpsUtXN7CchGxr9G2lgD8rLveo3gwd4eulClTuTnZKKidzx7DjUdWKIH8ndXyYFxZSKfqY6MUpzsZWGhuzscXKMpVardpsojMEoGfgjTy7jXUSgEfDwfwmLJCbo
```
## Test API
At this point you are ready to request an access token:
```bash
curl \
-X POST \
-d "grant_type=password&username=test_user1&password=password_test_user1" \
-u"qbmpPpuEnAvWoI8s55L9McafHwjHD8Wsjfm2oShu:W39qCKpsUtXN7CchGxr9G2lgD8rLveo3gwd4eulClTuTnZKKidzx7DjUdWKIH8ndXyYFxZSKfqY6MUpzsZWGhuzscXKMpVardpsojMEoGfgjTy7jXUSgEfDwfwmLJCbo" \
http://localhost:8000/auth/token/
```
#### response
```js
{
"access_token": "hu4P2IMQkrRObEx7QGXlXQ694jluTn",
"expires_in": 360000,
"token_type": "Bearer",
"scope": "read write",
"refresh_token": "HKTm13zavTQ64W44HSHsJliIcsV0kL"
}
```
Now you can request user data:
```bash
curl \
-H "Authorization: Bearer hu4P2IMQkrRObEx7QGXlXQ694jluTn" \
http://localhost:8000/api/users/
```
#### response
```js
[
{
"id":2,
"username": "test_user1",
"email": "[email protected]",
"first_name": "first",
"last_name": "user"
}
]
```
Api is per user protected, so this request is not allowed:
```bash
curl \
-H "Authorization: Bearer hu4P2IMQkrRObEx7QGXlXQ694jluTn" \
http://localhost:8000/api/users/1/
```
#### response
```js
{
"detail": "Not found."
}
```
Also you can make PUT request:
```bash
curl \
-H "Authorization: Bearer hu4P2IMQkrRObEx7QGXlXQ694jluTn" \
-X PUT \
-d"[email protected]" \
http://localhost:8000/api/users/2/
```
#### response
```js
{
"id": 2,
"username": "test_user1",
"email": "[email protected]",
"first_name": "first",
"last_name": "user"
}
```
## Test OAuth2
To test OAuth2 provider you can open app hosted at [heroku](https://django-oauth2.herokuapp.com/).
Click on _Applications_ and add new app with
- _client type_: `confidential`,
- _grant type_: `Authorizaiton code`,
- _Redirect uris_: `https://django-oauth2.herokuapp.com/consumer/exchange/`
then click **save**.
Go to the main page and attempt to retrieve token.
Hint:
- _Authorization url_ must be `https://django-oauth2.herokuapp.com/auth/authorize/`
- _Token url_ is: `https://django-oauth2.herokuapp.com/auth/token/`
## Documentation
Simple documentation available at [docs](https://django-oauth2.herokuapp.com/)
## Installation
```bash
cp env.example oauth_api/.env
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver
```