|
1 | 1 | OAuth2 Authentication |
2 | 2 | ===================== |
3 | 3 |
|
| 4 | +[](https://travis-ci.org/kanboard/plugin-oauth2) |
| 5 | + |
4 | 6 | Generic OAuth2 authentication plugin. |
5 | 7 |
|
6 | 8 | Author |
@@ -29,3 +31,33 @@ Configuration |
29 | 31 | ------------- |
30 | 32 |
|
31 | 33 | Go to the application settings > integrations > OAuth2 Authentication. |
| 34 | + |
| 35 | +### 1) Create a new application on the OAuth2 provider |
| 36 | + |
| 37 | +Go to the third-party authentication provider and add a new application. |
| 38 | +Copy and paste the **Kanboard callback URL** and generate a new set of tokens. |
| 39 | + |
| 40 | +The third-party provider will returns a **Client ID** and a **Client Secret**. |
| 41 | +Copy those values in the Kanboard's settings. |
| 42 | + |
| 43 | +### 2) Configure the provider in Kanboard |
| 44 | + |
| 45 | +- **Client ID**: Unique ID that comes from the third-party provider |
| 46 | +- **Client Secret**: Unique token that comes from the third-party provider |
| 47 | +- **Authorize URL**: URL used for authorization |
| 48 | +- **Token URL**: URL used to get tokens from third-party provider |
| 49 | +- **User API URL**: URL used to fetch user profile after authentication |
| 50 | +- **Username Key**: Key used to fetch the username from the user API response |
| 51 | +- **Name Key**: Key used to fetch the full name |
| 52 | +- **Email Key**: Key used to fetch the user email |
| 53 | +- **User ID Key**: Key used to fetch the unique user ID |
| 54 | + |
| 55 | +Example for Github OAuth2: |
| 56 | + |
| 57 | +- **Authorize URL**: `https://github.com/login/oauth/authorize` |
| 58 | +- **Token URL**: `https://github.com/login/oauth/access_token` |
| 59 | +- **User API URL**: `https://api.github.com/user` |
| 60 | +- **Username Key**: `login` |
| 61 | +- **Name Key**: `name` |
| 62 | +- **Email Key**: `email` |
| 63 | +- **User ID Key**: `id` |
0 commit comments