Browse Source

[Docs] Updated OAuth 2 Documentation

version-14
Revant Nandgaonkar 8 years ago
parent
commit
b3da13d86f
2 changed files with 9 additions and 4 deletions
  1. +5
    -0
      frappe/docs/user/en/guides/integration/how_to_setup_oauth.md
  2. +4
    -4
      frappe/docs/user/en/guides/integration/using_oauth.md

+ 5
- 0
frappe/docs/user/en/guides/integration/how_to_setup_oauth.md View File

@@ -28,6 +28,11 @@ Go to


<img class="screenshot" src="{{docs_base_url}}/assets/img/oauth_provider_settings.png"> <img class="screenshot" src="{{docs_base_url}}/assets/img/oauth_provider_settings.png">


### Add Primary Server

This is the main server hosting all the users. e.g. `https://frappe.io`. To setup this as the main server, go to *Setup* > *Integrations* > *Social Login Keys* and enter `https://frappe.io` in the field `Frappe Server URL`. This URL repeats in all other Frappe servers who connect to this server to authenticate. Effectively, this is the main Identity Provider (IDP).

Under this server add as many `OAuth Client`(s) as required.


## Add a Client App ## Add a Client App




+ 4
- 4
frappe/docs/user/en/guides/integration/using_oauth.md View File

@@ -8,7 +8,7 @@ Once the client and provider settings are entered, following steps can be used t


URL: URL:
``` ```
[GET] 0.0.0.0:8000/api/method/frappe.integration_broker.oauth2.authorize
[GET] 0.0.0.0:8000/api/method/frappe.integrations.oauth2.authorize
``` ```
Params: Params:
``` ```
@@ -38,7 +38,7 @@ http://localhost:3000/oauth_code?error=access_denied


URL: URL:
``` ```
[POST] 0.0.0.0:8000/api/method/frappe.integration_broker.oauth2.get_token
[POST] 0.0.0.0:8000/api/method/frappe.integrations.oauth2.get_token
``` ```
Params: Params:
``` ```
@@ -62,7 +62,7 @@ Response:


URL: URL:
``` ```
[POST] 0.0.0.0:8000/api/method/frappe.integration_broker.oauth2.get_token
[POST] 0.0.0.0:8000/api/method/frappe.integrations.oauth2.get_token
``` ```
Params: Params:
``` ```
@@ -85,7 +85,7 @@ Response:


URL: URL:
``` ```
[POST] 0.0.0.0:8000/api/method/frappe.integration_broker.oauth2.revoke_token
[POST] 0.0.0.0:8000/api/method/frappe.integrations.oauth2.revoke_token
``` ```
Params: Params:
``` ```


Loading…
Cancel
Save