Documentation updates

* Mention SAML callback * Give sidebar more room
stormpath · Feb 3, 2016 · 25c3523 · 25c3523
1 parent 4eec555
commit 25c3523
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/docs/app/styles/main.scss b/docs/app/styles/main.scss
@@ -113,7 +113,7 @@ padding: 5px 30px 5px 30px;
 /*
  * Sidebar
  */
-$sidebarWidth: 275px;
+$sidebarWidth: 375px;
 .sidebar {
   padding: 20px 10px;
   background-color: #f5f5f5;

diff --git a/docs/app/views/oauthStormpathTokenAuthenticationResult.md b/docs/app/views/oauthStormpathTokenAuthenticationResult.md
@@ -1,7 +1,9 @@
 ## OAuthStormpathTokenAuthenticationResult
 
-An `OAuthStormpathTokenAuthenticationResult` is returned by the [OAuthStormpathTokenAuthenticator](oauthStormpathTokenAuthenticator).
-It encapsulates an authentication result from an ID Site callback, and allows you to get the account that has authenticated.
+An `OAuthStormpathTokenAuthenticationResult` is returned by the
+[OAuthStormpathTokenAuthenticator](oauthStormpathTokenAuthenticator).
+It encapsulates an authentication result from an ID Site or SAML callback, and
+allows you to get the account that has authenticated.
 
 
 ---

diff --git a/docs/app/views/oauthStormpathTokenAuthenticator.md b/docs/app/views/oauthStormpathTokenAuthenticator.md
@@ -1,7 +1,8 @@
 ## OAuthStormpathTokenAuthenticator
 
 Provides the ability to authenticate with Stormpath JWTs (`stormpath_token`).
-Your application will recieve this token when a user is redirected to your application from an ID Site.
+Your application will recieve this token when a user is redirected to your
+application from an ID Site or SAML provider.
 
 ---
 
@@ -54,7 +55,8 @@ A new [`OAuthStormpathTokenAuthenticator`](oauthStormpathTokenAuthenticator) ins
 Authenticates a `stormpath_token` and returns a [OAuthStormpathTokenAuthenticationResult](outhStormpathTokenAuthenticationResult), which
 can provide the [Account](account) that has authenticated.
 
-The `stormpath_token` is the value of the `jwtResponse` parameter in the callback URL, e.g. `https://myapp.com/idsite/callback?jwtResponse=<stormpath_token>`.
+The `stormpath_token` is the value of the `jwtResponse` parameter in the
+callback URL, e.g. `https://myapp.com/idSiteCallback?jwtResponse=<stormpath_token>`.
 
 
 #### Usage
@@ -89,7 +91,7 @@ authenticator.authenticate(data, function(err, authenticationResult) {
       <td>
         <p>An object literal, with the following properties:</p>
         <ul>
-          <li>`stormpath_token` - REQUIRED - A Stormpath JWT from an ID Site callback.</li>
+          <li>`stormpath_token` - REQUIRED - A Stormpath JWT from an ID Site or SAML callback.</li>
         </ul>
       </td>
     </tr>