kumi/django-oidc-provider
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update Docs.

Browse source
This commit is contained in:
Juan Ignacio Fiorentino 2015-03-02 17:51:35 -03:00
parent f60ac01d97
commit 604f94e15b
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc.md
View file

@ -75,10 +75,12 @@ REQUIRED. The OP server url. For example `http://localhost:8000`.
##### LOGIN_URL ##### LOGIN_URL
REQUIRED. Used to log the user in. [Read more in Django docs](https://docs.djangoproject.com/en/1.7/ref/settings/#login-url). REQUIRED. Used to log the user in. [Read more in Django docs](https://docs.djangoproject.com/en/1.7/ref/settings/#login-url).
Default is `/accounts/login/`. Default is `/accounts/login/`.
##### OIDC_CODE_EXPIRE ##### OIDC_CODE_EXPIRE
OPTIONAL. Expressed in seconds. OPTIONAL. Expressed in seconds.
Default is `60*10`. Default is `60*10`.
##### OIDC_EXTRA_SCOPE_CLAIMS ##### OIDC_EXTRA_SCOPE_CLAIMS
@ -126,11 +128,15 @@ If a field is empty or ``None`` will be cleaned from the response.
##### OIDC_IDTOKEN_EXPIRE ##### OIDC_IDTOKEN_EXPIRE
OPTIONAL. Expressed in seconds. OPTIONAL. Expressed in seconds.
Default is `60*10`. Default is `60*10`.
##### OIDC_IDTOKEN_SUB_GENERATOR ##### OIDC_IDTOKEN_SUB_GENERATOR
OPTIONAL. Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client. OPTIONAL. Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client.
Is a function that receives both `user` and `client` objects. Default is:
Is just a function that receives both `user` and `client` objects, returns a string.
Default is:
```python ```python
def default_sub_generator(user, client): def default_sub_generator(user, client):
@ -139,6 +145,7 @@ def default_sub_generator(user, client):
##### OIDC_TOKEN_EXPIRE ##### OIDC_TOKEN_EXPIRE
OPTIONAL. Token object expiration after been created. Expressed in seconds. OPTIONAL. Token object expiration after been created. Expressed in seconds.
Default is `60*60`. Default is `60*60`.
## Users And Clients ## Users And Clients