Microsoft Entra ID
Authentication

Native Authentication User Attribute Builder

In brief

The article describing Android and iOS/macOS SDK methods for preparing built-in and custom user attributes before sign-up was deleted.

What Entra admins need to know

No administrator configuration change is identified. Development teams that used this guidance may need updated documentation.

This editorial summary was generated by AI from the documentation changes. Verify important details in the full Microsoft Learn article.

Documentation change

The comparison below shows only the changed extract. Use the full-page view for complete context.

deleted file mode 100644

title: Native authentication SDK attribute builder description: Learn how to use native authentication Android and iOS SDK attribute builders to prepare built-in and custom attributes. manager: dougeby ms.service: identity-platform ms.subservice: external ms.topic: concept-article ms.date: 08/01/2024

#Customer intent: As a dev, devops, I want to learn how to use native authentication SDK attribute builder to build attribute variables for both built-in and custom attributes, so that I can use them in my app.

Native authentication SDK attribute builder

[!INCLUDE applies-to-external-only]

In native authentication, the information you collect from the user during sign-up is configured in the user flow in the Microsoft Entra admin center. The name of the user attribute as it appears in the Microsoft Entra admin center is different from the variable name that you use when you reference it in your app.

Fortunately, the native authentication SDK enables you to build the user attributes and assign values to them before you use them in the SDKs signUp() method.

Build user attributes

Android (Kotlin)

To build user attributes in the Android SDK:

  • Use the utility class UserAttribute.Builder that the SDK provides. The UserAttributes.Builder class contains methods whose parameter is the value that you collect from the user.

  • Identify the user attributes that you want to build, then use the following code snippet to build them:

        //build the user attributes, both built-in and custom attributes
        val userAttributes = UserAttributes.Builder()
            .country(country)
            .city(city)
            .displayName(displayName)
            .givenName(givenName)
            .jobTitle(jobTitle)
            .postalCode(postalCode)
            .state(state)
            .streetAddress(streetAddress)
            .surname(surname)
            .build()
    
        CoroutineScope(Dispatchers.Main).launch {
            //use the userAttributes variable in your signUp method
            val actionResult = authAuthClientInstance.signUp(
                username = emailAddress,
                attributes = userAttributes
            )
        }
    
  • To build custom attributes, use UserAttribute.Builder class customAttribute() method. The method accepts the custom attribute's programmable name, and the value of the attribute:

       val userAttributes = UserAttributes.Builder()
           .customAttribute("extension_2588abcdwhtfeehjjeeqwertc_loyaltyNumber", loyaltyNumber)
           .build()
    
       CoroutineScope(Dispatchers.Main).launch {
           //use the userAttributes variable in your signUp method
           val actionResult = authAuthClientInstance.signUp(
               username = emailAddress,
               attributes = userAttributes
           )
       }
    

iOS/macOS (Swift)

To build user attributes in the iOS/macOS MSAL SDK:

  • Identify the user attributes that you want to build, then create a dictionary variable, where:

    • the key is the programmable name of the user attribute, as a string. The programmable name can be for built-in or custom attribute.
    • the value in the value of the user attribute that you collect from the user.
  • Identify the user attributes that you want to build, then use the following code snippet to build them:

       let attributes = [
           "country": "United States",
           "city": "Redmond",
           "displayName": displayName,
           "givenName": givenName,
           "jobTitle": jobTitle,
           "postalCode": postalCode,
           "state": state,
           "streetAddress": streetAddress,
           "surname": surname
       ]
    
       authAuthClientInstance.signUp(username: email, attributes: attributes, delegate: self)
    
  • To build custom attributes, use UserAttribute.Builder class customAttribute() method. The method accepts the custom attribute's programmable name, and the value of the attribute:

            let attributes = [
                "country": "United States",
                "extension_2588abcdwhtfeehjjeeqwertc_loyaltyNumber", loyaltyNumber
            ]
    
            authAuthClientInstance.signUp(username: email, attributes: attributes, delegate: self)
    

To learn more about the programmable names of user profile attributes, see the User profile attributes article.

Related content

Daily Entra.News

Get daily email updates

Get a concise summary of the latest Microsoft Entra updates delivered straight to your inbox.

Loading the secure signup form…