GEODE-7851: Document Pulse OAuth properties (apache#4950)

* GEODE-7851: Document Pulse OAuth properties * Fix typo, awkward sentences, and markdown spacing Co-authored-by: Jinmei Liao <[email protected]>
IronOnet · Apr 14, 2020 · f797bca · f797bca
1 parent cf8ad73
commit f797bca
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 15 deletions.
diff --git a/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb b/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb
@@ -118,14 +118,53 @@ You can configure Pulse to use any Authentication Provider that supports OpenID
 - Register with the authentication provider, obtaining a valid client ID and client secret for Pulse.
 - Configure the scopes with `CLUSTER:READ`, `CLUSTER:WRITE`, `DATA:READ` or `DATA:WRITE`.
 
-After you set up the authentication provider properly, create (or edit, if it already exists) a property file named `pulse.properties` with the following configuration:
+**Pulse Properties for OAuth Configuration**
 
-**Example pulse.properties for OAuth configuration**
+After you set up the authentication provider properly, create a properties file named `pulse.properties` (or edit it, if it already exists) to define the following required properties:
+
+- **pulse.oauth.providerId**
+
+    An ID for Pulse to use internally to identify your OAuth provider.
+
+- **pulse.oauth.providerName**
+
+    A name for Pulse to display on the login page to link to your OAuth provider. 
+
+- **pulse.oauth.clientId**
+
+    The ID with which Pulse is registered with your OAuth provider.
+
+- **pulse.oauth.clientSecret**
+
+    The secret with which Pulse is registered with your OAuth provider.
+
+- **pulse.oauth.authorizationUri**
+
+    The URI for your OAuth provider's authorization endpoint.
+
+- **pulse.oauth.tokenUri**
+
+    The URI for your OAuth provider's token endpoint.
+
+- **pulse.oauth.userInfoUri**
+
+    The URI for your OAuth provider's user info endpoint.
+
+- **pulse.oauth.jwkSetUri**
+
+    The URI for your OAuth provider's JSON Web Key (JWK) Set endpoint.
+
+- **pulse.oauth.userNameAttributeName**
+
+    The attribute name used to access the user's name from your OAuth provider's user info response.
+
+**Example pulse.properties for OAuth Configuration**
 
 ``` pre
-pulse.oauth.provider=uaa
-pulse.oauth.clientId=<client id>
-pulse.oauth.clientSecret=<client secret>
+pulse.oauth.providerId=uaa
+pulse.oauth.providerName=UAA
+pulse.oauth.clientId=pulse
+pulse.oauth.clientSecret=example-pulse-client-secret
 pulse.oauth.authorizationUri=http://example.com/uaa/oauth/authorize
 pulse.oauth.tokenUri=http://example.com/uaa/oauth/token
 pulse.oauth.userInfoUri=http://example.com/uaa/userinfo

diff --git a/geode-pulse/src/main/resources/pulse.properties b/geode-pulse/src/main/resources/pulse.properties
@@ -28,13 +28,33 @@ pulse.port=10334
 #pulse.useSSL.locator=true
 #pulse.useSSL.manager=true
 
-###### use pulse.properties to customize oauth behavior ######
-#pulse.oauth.providerId=uaa/google/etc.
-#pulse.oauth.providerName=
-#pulse.oauth.clientId=
-#pulse.oauth.clientSecret=
-#pulse.oauth.authorizationUri=
-#pulse.oauth.tokenUri=
-#pulse.oauth.userInfoUri=
-#pulse.oauth.jwkSetUri=
-#pulse.oauth.userNameAttributeName=
+# OAuth Provider Properties
+
+# An ID for Pulse to use internally to identify your OAuth provider
+#pulse.oauth.providerId=uaa
+
+# A name for Pulse to display on the login page to link to your OAuth
+# provider
+#pulse.oauth.providerName=UAA
+
+# The ID with which Pulse is registered with your OAuth provider
+#pulse.oauth.clientId=pulse
+
+# The secret with which Pulse is registered with your OAuth provider
+#pulse.oauth.clientSecret=example-pulse-client-secret
+
+# The URI for your OAuth provider's authorization endpoint
+#pulse.oauth.authorizationUri=http://example.com/uaa/oauth/authorize
+
+# The URI for your OAuth provider's token endpoint
+#pulse.oauth.tokenUri=http://example.com/uaa/oauth/token
+
+# The URI for your OAuth provider's user info endpoint
+#pulse.oauth.userInfoUri=http://example.com/uaa/userinfo
+
+# The URI for your OAuth provider's JSON Web Key (JWK) Set endpoint
+#pulse.oauth.jwkSetUri=http://example.com/uaa/token_keys
+
+# The attribute name used to access the user's name from your OAuth
+# provider's user info response
+#pulse.oauth.userNameAttributeName=user_name