31,029
edits
Module OAuth: Difference between revisions
Jump to navigation
Jump to search
m
→Installation
m (→Introduction) Tag: 2017 source edit |
m (→Installation) Tag: 2017 source edit |
||
| Line 26: | Line 26: | ||
{{NoInstallModuleEn}} | {{NoInstallModuleEn}} | ||
== External documentation == | = Setup = | ||
This is some documentation on how to setup your external system to allow an OAuth2 connection | |||
== Creation of the OAuth entry == | |||
This is the first step. | |||
You must create an entry and choose the permission the according to the purpose the OAuth entry will be used for. | |||
This is some examples of value you can use according to OAuth provider and goal of the entry. Try to create 1 entry for each different purpose. | |||
=== For IMAP access === | |||
This is example of setup if you plan to use the OAuth token to read your email box with the email collector. | |||
*For Google* | |||
Client ID / Secret ID: See chapter External documentation. | |||
Scope: Choose the scope *gmail_full* | |||
*For Microsoft Office365* | |||
Client ID / Secret ID: See chapter External documentation. | |||
Scope: Choose the scope: *https://outlook.office365.com/IMAP.AccessAsUser.All*. It if fails, choose: *https://outlook.office.com/.default* | |||
=== For SMTP access === | |||
This is example of setup if you plan to use the OAuth token to send emails. | |||
*For Google* | |||
Client ID / Secret ID: See chapter External documentation. | |||
Scope: Choose the scope *gmail_full* | |||
*For Microsoft Office365* | |||
Client ID / Secret ID: See chapter External documentation. | |||
Scope: Choose the scope: *https://outlook.office365.com/SMTP.Send*. It if fails, choose: *https://outlook.office.com/.default* | |||
=== For SSO Login === | |||
This is example of setup if you plan to use the OAuth provider to login. Note that for this purpose, creating the entry is enough, no need to generate the token. | |||
*For Google* | |||
Client ID / Secret ID: See chapter External documentation. | |||
Scope: Choose the scope *openid* and *email* | |||
*For Microsoft Office365* | |||
Client ID / Secret ID: See chapter External documentation. | |||
Scope: Choose the scope *https://outlook.office.com/.default* | |||
== Generate the token == | |||
Once your OAuth entry has been created, you can switch on the second tab to generate and get your OAuth token. | |||
Note: If the goal if the OAuth entry is to be used for SSO Login, you don't need to generate the token. | |||
== External documentation == | |||
This is some documentation on how to setup your external system to allow an OAuth2 connection. This may help you to find how to get your Client ID and Secret ID to create your OAuth entry in Dolibarr. | |||
=== For Microsoft === | === For Microsoft === | ||