Allow configure username-attribute-name for aad b2c (Azure#18657)

Author: wujack778

sdk/spring/azure-spring-boot-samples/azure-spring-boot-sample-active-directory-b2c-oidc/README.md

@@ -47,6 +47,7 @@ azure:
       client-secret: ${your-client-secret}
       reply-url: ${your-reply-url} # should be absolute url.
       logout-success-url: ${your-logout-success-url}
+      user-name-attribute-name: ${your-user-name-claim}
       user-flows:
         sign-up-or-sign-in: ${your-sign-up-or-in-user-flow}
         profile-edit: ${your-profile-edit-user-flow}      # optional

sdk/spring/azure-spring-boot-samples/azure-spring-boot-sample-active-directory-b2c-oidc/src/main/java/com/azure/spring/sample/aad/b2c/controller/WebController.java

@@ -18,6 +18,7 @@ private void initializeModel(Model model, OAuth2AuthenticationToken token) {
 
             model.addAttribute("grant_type", user.getAuthorities());
             model.addAllAttributes(user.getAttributes());
+            model.addAttribute("name", user.getName());
         }
     }
 

sdk/spring/azure-spring-boot-samples/azure-spring-boot-sample-active-directory-b2c-oidc/src/main/resources/application.yml

@@ -6,7 +6,8 @@ azure:
       client-id: ${your-client-id}
       client-secret: ${your-client-secret}
       reply-url: ${your-reply-url-from-aad} # should be absolute url.
-      logout-success-url: ${you-logout-success-url}
+      logout-success-url: ${your-logout-success-url}
+      user-name-attribute-name: ${your-user-name-claim}
       user-flows:
         sign-up-or-sign-in: ${your-sign-up-or-in-user-flow}
         profile-edit: ${your-profile-edit-user-flow}     # optional

sdk/spring/azure-spring-boot-starter-active-directory-b2c/CHANGELOG.md

@@ -1,7 +1,8 @@
 # Release History
 
 ## 3.2.0-beta.1 (Unreleased)
-
+### Breaking Changes
+- Exposed `userNameAttributeName` to configure the user's name.
 
 ## 3.0.0 (2020-12-30)
 

sdk/spring/azure-spring-boot-starter-active-directory-b2c/README.md

@@ -48,7 +48,7 @@ while protecting the identities of your customers at the same time.
 
 3. Select **Keys** from your application, click **Generate key** to generate `${your-client-secret}` and then **Save**.
 
-4. Select **User flows** on your left, and then **Click** **New user flow **.
+4. Select **User flows** on your left, and then Click **New user flow**.
 
 5. Choose **Sign up or in**, **Profile editing** and **Password reset** to create user flows
 respectively. Specify your user flow **Name** and **User attributes and claims**, click **Create**.
@@ -58,6 +58,22 @@ In this documentation, you created a new Java web application using the Azure Ac
 configured a new Azure AD B2C tenant and registered a new application in it, and then configured your
 application to use the Spring annotations and classes to protect the web app.
 
+### Configurable properties
+This starter provides following properties to be customized:
+
+
+ | Parameter | Description |
+   |---|---|
+   | `azure.activedirectory.b2c.client-id` | The registered application ID in Azure AD B2C. |
+   | `azure.activedirectory.b2c.client-secret` | The client secret of a registered application. |
+   | `azure.activedirectory.b2c.logout-success-url` | The target URL after a successful logout. |
+   | `azure.activedirectory.b2c.reply-url` | The reply URL of a registered application. It's the same as the **Redirect URI** configured on Azure Portal.|   
+   | `azure.activedirectory.b2c.tenant` | The Azure AD B2C's tenant name. |
+   | `azure.activedirectory.b2c.user-flows.signUpOrSignIn` | The name of the **sign up and sign in** user flow. |
+   | `azure.activedirectory.b2c.user-flows.profileEdit` | The name of the **profile editing** user flow. |
+   | `azure.activedirectory.b2c.user-flows.passwordReset` | The name of the **password reset** user flow. |
+   | `azure.activedirectory.b2c.user-name-attribute-name` | The the attribute name of the user name.|   
+   
 ## Examples
 ### Configure and compile your app
 
@@ -97,6 +113,7 @@ application to use the Spring annotations and classes to protect the web app.
          client-secret: ${your-client-secret}
          reply-url: ${your-reply-url-from-aad} # should be absolute url.
          logout-success-url: ${you-logout-success-url}
+         user-name-attribute-name: ${your-user-name-attribute-name}
          user-flows:
            sign-up-or-sign-in: ${your-sign-up-or-in-user-flow}
            profile-edit: ${your-profile-edit-user-flow}     # optional
@@ -106,17 +123,6 @@ application to use the Spring annotations and classes to protect the web app.
            login_hint: xxxxxxxxx          # optional
            domain_hint: xxxxxxxxx         # optional
    ```
-   Where:
-
-   | Parameter | Description |
-   |---|---|
-   | `azure.activedirectory.b2c.tenant` | Contains your AD B2C's `${your-tenant-name` from earlier. |
-   | `azure.activedirectory.b2c.client-id` | Contains the `${your-client-id}` from your application that you completed earlier. |
-   | `azure.activedirectory.b2c.client-secret` | Contains the `${your-client-secret}` from your application that you completed earlier. |
-   | `azure.activedirectory.b2c.reply-url` | Contains one of the **Reply URL** from your application that you completed earlier. |
-   | `azure.activedirectory.b2c.logout-success-url` | Specify the URL when your application logout successfully. |
-   | `azure.activedirectory.b2c.user-flows` | Contains the name of the user flows that you completed earlier.
-
 7. Save and close the *application.yml* file.
 
 8. Create a folder named *controller* in the Java source folder for your application.

sdk/spring/azure-spring-boot/src/main/java/com/azure/spring/autoconfigure/b2c/AADB2CAutoConfiguration.java

@@ -148,7 +148,7 @@ private ClientRegistration b2cClientRegistration(String userFlow) {
                 .authorizationUri(AADB2CURL.getAuthorizationUrl(properties.getTenant()))
                 .tokenUri(AADB2CURL.getTokenUrl(properties.getTenant(), userFlow))
                 .jwkSetUri(AADB2CURL.getJwkSetUrl(properties.getTenant(), userFlow))
-                .userNameAttributeName("name")
+                .userNameAttributeName(properties.getUserNameAttributeName())
                 .clientName(userFlow)
                 .build();
         }

sdk/spring/azure-spring-boot/src/main/java/com/azure/spring/autoconfigure/b2c/AADB2CProperties.java

@@ -68,6 +68,11 @@ public class AADB2CProperties {
 
     private Map<String, Object> authenticateAdditionalParameters;
 
+    /**
+     * User name attribute name
+     */
+    private String userNameAttributeName;
+
     /**
      * The all user flows which is created under b2c tenant.
      */
@@ -210,4 +215,12 @@ public boolean isAllowTelemetry() {
     public void setAllowTelemetry(boolean allowTelemetry) {
         this.allowTelemetry = allowTelemetry;
     }
+
+    public String getUserNameAttributeName() {
+        return userNameAttributeName;
+    }
+
+    public void setUserNameAttributeName(String userNameAttributeName) {
+        this.userNameAttributeName = userNameAttributeName;
+    }
 }

sdk/spring/azure-spring-boot/src/test/java/com/azure/spring/autoconfigure/b2c/AADB2CAutoConfigurationTest.java

@@ -12,17 +12,18 @@
 public class AADB2CAutoConfigurationTest {
 
     private final WebApplicationContextRunner contextRunner = new WebApplicationContextRunner()
-            .withConfiguration(AutoConfigurations.of(AADB2CAutoConfiguration.class))
-            .withPropertyValues(
-                    String.format("%s=%s", AADB2CConstants.TENANT, AADB2CConstants.TEST_TENANT),
-                    String.format("%s=%s", AADB2CConstants.CLIENT_ID, AADB2CConstants.TEST_CLIENT_ID),
-                    String.format("%s=%s", AADB2CConstants.CLIENT_SECRET, AADB2CConstants.TEST_CLIENT_SECRET),
-                    String.format("%s=%s", AADB2CConstants.REPLY_URL, AADB2CConstants.TEST_REPLY_URL),
-                    String.format("%s=%s", AADB2CConstants.LOGOUT_SUCCESS_URL, AADB2CConstants.TEST_LOGOUT_SUCCESS_URL),
-                    String.format("%s=%s", AADB2CConstants.SIGN_UP_OR_SIGN_IN, AADB2CConstants.TEST_SIGN_UP_OR_IN_NAME),
-                    String.format("%s=%s", AADB2CConstants.CONFIG_PROMPT, AADB2CConstants.TEST_PROMPT),
-                    String.format("%s=%s", AADB2CConstants.CONFIG_LOGIN_HINT, AADB2CConstants.TEST_LOGIN_HINT)
-            );
+        .withConfiguration(AutoConfigurations.of(AADB2CAutoConfiguration.class))
+        .withPropertyValues(
+            String.format("%s=%s", AADB2CConstants.TENANT, AADB2CConstants.TEST_TENANT),
+            String.format("%s=%s", AADB2CConstants.CLIENT_ID, AADB2CConstants.TEST_CLIENT_ID),
+            String.format("%s=%s", AADB2CConstants.CLIENT_SECRET, AADB2CConstants.TEST_CLIENT_SECRET),
+            String.format("%s=%s", AADB2CConstants.REPLY_URL, AADB2CConstants.TEST_REPLY_URL),
+            String.format("%s=%s", AADB2CConstants.LOGOUT_SUCCESS_URL, AADB2CConstants.TEST_LOGOUT_SUCCESS_URL),
+            String.format("%s=%s", AADB2CConstants.SIGN_UP_OR_SIGN_IN, AADB2CConstants.TEST_SIGN_UP_OR_IN_NAME),
+            String.format("%s=%s", AADB2CConstants.CONFIG_PROMPT, AADB2CConstants.TEST_PROMPT),
+            String.format("%s=%s", AADB2CConstants.CONFIG_LOGIN_HINT, AADB2CConstants.TEST_LOGIN_HINT),
+            String.format("%s=%s", AADB2CConstants.USER_NAME_ATTRIBUTE_NAME, AADB2CConstants.TEST_ATTRIBUTE_NAME)
+        );
 
     @Test
     public void testAutoConfigurationBean() {
@@ -43,10 +44,12 @@ public void testPropertiesBean() {
             assertThat(properties.getClientId()).isEqualTo(AADB2CConstants.TEST_CLIENT_ID);
             assertThat(properties.getClientSecret()).isEqualTo(AADB2CConstants.TEST_CLIENT_SECRET);
             assertThat(properties.getReplyUrl()).isEqualTo(AADB2CConstants.TEST_REPLY_URL);
+            assertThat(properties.getUserNameAttributeName()).isEqualTo(AADB2CConstants.TEST_ATTRIBUTE_NAME);
 
             final String signUpOrSignIn = properties.getUserFlows().getSignUpOrSignIn();
             final Object prompt = properties.getAuthenticateAdditionalParameters().get(AADB2CConstants.PROMPT);
-            final String loginHint = String.valueOf(properties.getAuthenticateAdditionalParameters().get(AADB2CConstants.LOGIN_HINT));
+            final String loginHint =
+                String.valueOf(properties.getAuthenticateAdditionalParameters().get(AADB2CConstants.LOGIN_HINT));
 
             assertThat(signUpOrSignIn).isEqualTo(AADB2CConstants.TEST_SIGN_UP_OR_IN_NAME);
             assertThat(prompt).isEqualTo(AADB2CConstants.TEST_PROMPT);

sdk/spring/azure-spring-boot/src/test/java/com/azure/spring/autoconfigure/b2c/AADB2CConstants.java

@@ -34,6 +34,10 @@ public class AADB2CConstants {
 
     public static final String TENANT = String.format("%s.%s", PREFIX, "tenant");
 
+    public static final String TEST_ATTRIBUTE_NAME = String.format("%s.%s", PREFIX, "name");
+
+    public static final String USER_NAME_ATTRIBUTE_NAME = String.format("%s.%s", PREFIX, "user-name-attribute-name");
+
     public static final String CLIENT_ID = String.format("%s.%s", PREFIX, "client-id");
 
     public static final String CLIENT_SECRET = String.format("%s.%s", PREFIX, "client-secret");