Skip to content

Commit d3704cd

Browse files
Add provider documentation index
Add an initial documentation index for the providers for aspnet-contrib#459.
1 parent 2637825 commit d3704cd

22 files changed

+67
-0
lines changed

docs/README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# OAuth Provider Documentation
2+
3+
This document contains some introductory information about how to integrate the
4+
OAuth providers in this repository into an ASP.NET Core application.
5+
6+
It assumes a general familiarity with ASP.NET Core and authorization, and is
7+
intended to demonstrate how to configure it into your application, not how it
8+
works internally. Further integration details for a given provider can be found
9+
in the services' own documentation, which are linked to in the main [README](https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers#providers "Table of OAuth providers").
10+
11+
## Generic Documentation
12+
13+
Most of the OAuth providers in this repository can be configured by just
14+
specifying two settings: `ClientId` and `ClientSecret`.
15+
16+
Let's use the Slack provider as an example:
17+
18+
```csharp
19+
services.AddAuthentication(options => /* Auth configuration */)
20+
.AddSlack(options =>
21+
{
22+
options.ClientId = "my-client-id";
23+
options.ClientSecret = "my-client-secret";
24+
});
25+
```
26+
27+
With just two settings, you can configure the Slack provider to authenticate users.
28+
29+
The providers all follow a convention, so you just need to add the appropriate
30+
NuGet package reference and replace the word `Slack` in the method name with the
31+
provider name you are integrating. So for Spotify, it would be `AddSpotify()`.
32+
33+
## Provider-Specific Documentation
34+
35+
Any providers listed here have additional configuration that is either required
36+
or optional beyond the standard built-in OAuth configuration settings.
37+
38+
The table below lists all of the providers that provide additional configuration
39+
and a link to a provider-specific document for that provider. If the provider
40+
you are using is not listed, it does not have any specific documentation and is
41+
covered by the section above.
42+
43+
| Provider | Required/Optional Settings | Documentation Link |
44+
|:-:|:-:|:-:|
45+
| Amazon | _Optional_ | [Documentation](amazon.md "Amazon provider documentation") |
46+
| Apple | **Required** | [Documentation](sign-in-with-apple.md "Apple provider documentation") |
47+
| BattleNet | | [Documentation](battlenet.md "BattleNet provider documentation") |
48+
| Bitbucket | | [Documentation](bitbucket.md "Bitbucket provider documentation") |
49+
| Discord | | [Documentation](discord.md "Discord provider documentation") |
50+
| EVEOnline | | [Documentation](eveonline.md "EVEOnline provider documentation") |
51+
| Foursquare | | [Documentation](foursquare.md "Foursquare provider documentation") |
52+
| GitHub | _Optional_ | [Documentation](github.md "GitHub provider documentation") |
53+
| Gitee | | [Documentation](gitee.md "Gitee provider documentation") |
54+
| Instagram | | [Documentation](instagram.md "Instagram provider documentation") |
55+
| LinkedIn | | [Documentation](linkedin.md "LinkedIn provider documentation") |
56+
| Odnoklassniki | | [Documentation](odnoklassniki.md "Odnoklassniki provider documentation") |
57+
| Okta | **Required** | [Documentation](okta.md "Okta provider documentation") |
58+
| Patreon | | [Documentation](patreon.md "Patreon provider documentation") |
59+
| QQ | | [Documentation](qq.md "QQ provider documentation") |
60+
| Reddit | | [Documentation](reddit.md "Reddit provider documentation") |
61+
| Salesforce | | [Documentation](salesforce.md "Salesforce provider documentation") |
62+
| StackExchange | | [Documentation](stackexchange.md "StackExchange provider documentation") |
63+
| SuperOffice | **Required** | [Documentation](superoffice.md "SuperOffice provider documentation") |
64+
| Trakt | | [Documentation](trakt.md "Trakt provider documentation") |
65+
| Twitch | | [Documentation](twitch.md "Twitch provider documentation") |
66+
| Vkontakte | | [Documentation](vkontakte.md "Vkontakte provider documentation") |
67+
| Weibo | | [Documentation](weibo.md "Weibo provider documentation") |

docs/amazon.md

Whitespace-only changes.

docs/battlenet.md

Whitespace-only changes.

docs/bitbucket.md

Whitespace-only changes.

docs/discord.md

Whitespace-only changes.

docs/eveonline.md

Whitespace-only changes.

docs/foursquare.md

Whitespace-only changes.

docs/gitee.md

Whitespace-only changes.

docs/instagram.md

Whitespace-only changes.

docs/linkedin.md

Whitespace-only changes.

docs/odnoklassniki.md

Whitespace-only changes.

docs/okta.md

Whitespace-only changes.

docs/patreon.md

Whitespace-only changes.

docs/qq.md

Whitespace-only changes.

docs/reddit.md

Whitespace-only changes.

docs/salesforce.md

Whitespace-only changes.

docs/stackexchange.md

Whitespace-only changes.

docs/superoffice.md

Whitespace-only changes.

docs/trakt.md

Whitespace-only changes.

docs/twitch.md

Whitespace-only changes.

docs/vkontakte.md

Whitespace-only changes.

docs/weibo.md

Whitespace-only changes.

0 commit comments

Comments
 (0)