Added username and primary email address to SSO token data

Author: Max Scholz

README.md

@@ -79,6 +79,6 @@ To run the tests a simple `# mvn test` command in the root directory will suffic
 
 ## License
 
-Copyright 2017 Staffbase GmbH.
+Copyright 2020 Staffbase GmbH.
 
 Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

src/main/java/com/staffbase/plugins/sdk/sso/SSOData.java

@@ -1,8 +1,8 @@
 /**
  * SSO implementation, based on this doc:
- * https://developers.staffbase.com/api/plugin-sso/
+ * https://developers.staffbase.com/guide/customplugin-overview
  *
- * @copyright 2017 Staffbase GmbH.
+ * @copyright 2020 Staffbase GmbH.
  * @author    Thilo Schmalfuß
  * @author    Vitaliy Ivanov
  * @license   http://www.apache.org/licenses/LICENSE-2.0
@@ -74,13 +74,23 @@ public class SSOData {
    */
   public static final String KEY_USER_EXTERNAL_ID = "external_id";
 
+  /**
+   * The key in the JWT claims for fetching the requesting user's username.
+   */
+  public static final String KEY_USER_USERNAME= "username";
+
+    /**
+   * The key in the JWT claims for fetching the requesting user's primary email address.
+   */
+  public static final String KEY_USER_PRIMARY_EMAIL_ADDRESS = "primary_email_address";
+
   /**
    * The key in the JWT claims for fetching the requesting user's first name.
    */
   public static final String KEY_USER_FIRST_NAME = "given_name";
 
   /**
-   * The key in the JWT claims for fetching the requesting users last name.
+   * The key in the JWT claims for fetching the requesting user's last name.
    */
   public static final String KEY_USER_LAST_NAME = "family_name";
 
@@ -215,6 +225,16 @@ public class SSOData {
    */
   private final String userExternalID;
 
+  /**
+   * The username of the requesting user, if given.
+   */
+  private final String userUsername;
+
+  /**
+   * The primary email address of the requesting user, if given.
+   */
+  private final String userPrimaryEmailAddress;
+
   /**
    * The first, i.e. given name of the user making the request using staffbase's SSO.
    */
@@ -264,6 +284,8 @@ public SSOData(final JwtClaims jwtClaims) throws MalformedClaimException {
     this.sessionID = jwtClaims.getClaimValue(KEY_SESSION_ID, String.class);
     this.userID = jwtClaims.getClaimValue(KEY_USER_ID, String.class);
     this.userExternalID = jwtClaims.getClaimValue(KEY_USER_EXTERNAL_ID, String.class);
+    this.userUsername = jwtClaims.getClaimValue(KEY_USER_USERNAME, String.class);
+    this.userPrimaryEmailAddress = jwtClaims.getClaimValue(KEY_USER_PRIMARY_EMAIL_ADDRESS, String.class);
     this.userFirstName = jwtClaims.getClaimValue(KEY_USER_FIRST_NAME, String.class);
     this.userLastName = jwtClaims.getClaimValue(KEY_USER_LAST_NAME, String.class);
     this.userRole = jwtClaims.getClaimValue(KEY_USER_ROLE, String.class);
@@ -403,6 +425,26 @@ public Optional<String> getUserExternalID() {
     return Optional.ofNullable(this.userExternalID);
   }
 
+  /**
+   * Get the username of the requesting user, if given.
+   *
+   * @see #userUsername
+   * @return the requesting user's username
+   */
+  public Optional<String> getUserUsername() {
+    return Optional.ofNullable(this.userUsername);
+  }
+
+  /**
+   * Get the primary email address of the requesting user, if given.
+   *
+   * @see #userPrimaryEmailAddress
+   * @return the requesting user's primary email address
+   */
+  public Optional<String> getUserPrimaryEmailAddress() {
+    return Optional.ofNullable(this.userPrimaryEmailAddress);
+  }
+
   /**
    * Get the first, i.e. given name of the user making the request using staffbase's
    * SSO.
@@ -502,6 +544,8 @@ public String toString() {
   ", branchSlug="+ this.branchSlug+
   ", userID="+ this.userID+
   ", userExternalID="+ this.userExternalID+
+  ", userUsername="+ this.userUsername+
+  ", userPrimaryEmailAddress="+ this.userPrimaryEmailAddress+
   ", userFirstName="+ this.userFirstName+
   ", userLastName="+ this.userLastName+
   ", userRole="+ this.userRole+

src/test/java/com/staffbase/plugins/sdk/sso/SSODataTest.java

@@ -1,8 +1,8 @@
 /**
  * SSO implementation test, based on this doc:
- * https://developers.staffbase.com/api/plugin-sso/
+ * https://developers.staffbase.com/guide/customplugin-overview
  *
- * @copyright 2017 Staffbase GmbH.
+ * @copyright 2020 Staffbase GmbH.
  * @author    Thilo Schmalfuß
  * @author    Vitaliy Ivanov
  * @license   http://www.apache.org/licenses/LICENSE-2.0
@@ -37,6 +37,8 @@ public class SSODataTest {
   public static final String DATA_BRANCH_SLUG = "staffbasetest";
   public static final String DATA_USER_ID = "541954c3e4b08bbdce1a340a";
   public static final String DATA_USER_EXTERNAL_ID = "jdoe";
+  public static final String DATA_USER_USERNAME = "john.doe";
+  public static final String DATA_USER_PRIMARY_EMAIL_ADDRESS = "jdoe@email.com";
   public static final String DATA_USER_FIRST_NAME = "John";
   public static final String DATA_USER_LAST_NAME = "Doe";
   public static final String DATA_USER_ROLE = "editor";
@@ -74,6 +76,8 @@ public void createWithJwtClaims() throws MalformedClaimException {
     when(claims.getClaimValue(SSOData.KEY_SESSION_ID, String.class)).thenReturn(DATA_SESSION_ID);
     when(claims.getClaimValue(SSOData.KEY_USER_ID, String.class)).thenReturn(DATA_USER_ID);
     when(claims.getClaimValue(SSOData.KEY_USER_EXTERNAL_ID, String.class)).thenReturn(DATA_USER_EXTERNAL_ID);
+    when(claims.getClaimValue(SSOData.KEY_USER_USERNAME, String.class)).thenReturn(DATA_USER_USERNAME);
+    when(claims.getClaimValue(SSOData.KEY_USER_PRIMARY_EMAIL_ADDRESS, String.class)).thenReturn(DATA_USER_PRIMARY_EMAIL_ADDRESS);
     when(claims.getClaimValue(SSOData.KEY_USER_FIRST_NAME, String.class)).thenReturn(DATA_USER_FIRST_NAME);
     when(claims.getClaimValue(SSOData.KEY_USER_LAST_NAME, String.class)).thenReturn(DATA_USER_LAST_NAME);
     when(claims.getClaimValue(SSOData.KEY_USER_ROLE, String.class)).thenReturn(DATA_USER_ROLE);
@@ -95,6 +99,8 @@ public void createWithJwtClaims() throws MalformedClaimException {
     assertEquals(DATA_SESSION_ID, ssoData.getSessionId().get());
     assertEquals(DATA_USER_ID, ssoData.getUserID().get());
     assertEquals(DATA_USER_EXTERNAL_ID, ssoData.getUserExternalID().get());
+    assertEquals(DATA_USER_USERNAME, ssoData.getUserUsername().get());
+    assertEquals(DATA_USER_PRIMARY_EMAIL_ADDRESS, ssoData.getUserPrimaryEmailAddress().get());
     assertEquals(DATA_USER_FIRST_NAME, ssoData.getUserFirstName().get());
     assertEquals(DATA_USER_LAST_NAME, ssoData.getUserLastName().get());
     assertEquals(DATA_USER_ROLE, ssoData.getUserRole().get());