Merge pull request #91 from xtremerui/pr/add-oauth-doc

add docs for generic oauth 2.0 connector

content/docs/connectors/_index.md

@@ -24,6 +24,7 @@ Dex implements the following connectors:
 | [SAML 2.0](/docs/connectors/saml/) | no | yes | no | stable |
 | [GitLab](/docs/connectors/gitlab/) | yes | yes | yes | beta | |
 | [OpenID Connect](/docs/connectors/oidc/) | yes | yes | yes | beta | Includes Salesforce, Azure, etc. |
+| [OAuth 2.0](/docs/connectors/oauth/) | no | yes | yes | alpha |
 | [Google](/docs/connectors/google/) | yes | yes | yes | alpha | |
 | [LinkedIn](/docs/connectors/linkedin/) | yes | no | no | beta | |
 | [Microsoft](/docs/connectors/microsoft/) | yes | yes | no | beta | |

content/docs/connectors/oauth.md

@@ -0,0 +1,74 @@
+---
+title: "Authentication Through an OAuth 2.0 Provider"
+linkTitle: "OAuth 2.0"
+description: ""
+date: 2021-03-15
+draft: true
+toc: true
+weight: 2055
+---
+
+## Overview
+
+Dex users can make use of this connector to work with standards-compliant [OAuth 2.0](https://oauth.net/2/) authorization providers, in case those authorization providers are not already in the Dex connectors list.
+
+## Configuration
+
+The following is an example of a configuration for using OAuth connector with Reddit.
+
+```yaml
+connectors:
+- type: oauth
+  # ID of OAuth 2.0 provider
+  id: reddit 
+  # Name of OAuth 2.0 provider
+  name: reddit
+  config:
+    # Connector config values starting with a "$" will read from the environment.
+    clientID: $REDDIT_CLIENT_ID
+    clientSecret: $REDDIT_CLIENT_SECRET
+    redirectURI: http://127.0.0.1:5556/callback
+
+    tokenURL: https://www.reddit.com/api/v1/access_token
+    authorizationURL: https://www.reddit.com/api/v1/authorize
+    userInfoURL: https: https://www.reddit.com/api/v1/me
+
+    # Optional: Specify whether to communicate to Auth provider without
+    # validating SSL certificates
+    # insecureSkipVerify: false
+
+    # Optional: The location of file containing SSL certificates to commmunicate
+    # to Auth provider
+    # rootCAs: /etc/ssl/reddit.pem
+
+    # Optional: List of scopes to request Auth provider for access user account
+    # scopes:
+    #  - identity
+
+    # Optional: Configurable keys for user ID look up
+    # Default: id
+    # userIDKey:
+
+    # Auth roviders return non-standard user identity profile
+    # Use claimMapping to map those user infomations to standard claims:
+    claimMapping:
+      # Optional: Configurable keys for user name look up
+      # Default: user_name
+      # userNameKey:
+
+      # Optional: Configurable keys for preferred username look up
+      # Default: preferred_username
+      # preferredUsernameKey:
+
+      # Optional: Configurable keys for user groups look up
+      # Default: groups
+      # groupsKey:
+
+      # Optional: Configurable keys for email look up
+      # Default: email
+      # emailKey:
+
+      # Optional: Configurable keys for email verified look up
+      # Default: email_verified
+      # emailVerifiedKey:
+```