account-linkage

Azure AD B2C account linkage

With Azure AD B2C an account can have multiple identities, local (username and password) or social/enterprise identity (such as Facebook or AAD). This Azure AD B2C sample demonstrates how to link and unlink existing Azure AD B2C account to a social identity.

Prerequisites

• You can automate the pre requisites if you already have an Azure AD B2C tenant. Some policies can be deployed directly through this app via the Experimental menu.

• You will require to create an Azure AD B2C directory.

• To use the sample policies in this repo, follow the instructions here to setup your AAD B2C environment for Custom Policies.

• For any custom policy sample which makes use of Extension attributes, follow the guidance on storing the extension properties and adding the application objectID. The AAD-Common Technical profile will always need to be modified to use your ApplicationId and ObjectId.

How it works

• In Azure AD B2C, local accounts sign-in names (user name or email address) are stored in the signInNames collection in the user record. The signInNames contains one or more signInName records that specify the sign-in names for the user. Each sign-in name must be unique across the tenant.

• Social accounts' identities are stored in userIdentities collection. The entry specifies the issuer (identity provider name) such as facebook.com and the issuerUserId, which is a unique user identifier for the issuer. The userIdentities attribute contains one or more UserIdentity records that specify the social account type and the unique user identifier from the social identity provider.

• Combine local account with social identity. As mentioned, local account sign-in names, and social account identities are stored in different attributes. signInNames is used for local account, while userIdentities for social account. A single Azure AD B2C account, can be a local account only, social account only, or combine a local account with social identity in one user record. This behavior allows you to manage a single account, while a user can sign in with the local account credential(s) or with the multiple social identities.

• UserIdentity Type - Contains information about the identity of a social account user in an Azure AD B2C tenant:

  • issuer The string representation of the identity provider that issued the user identifier, such as facebook.com.
  • issuerUserId The unique user identifier used by the social identity provider in base64 format.

• Depending on the identity provider, the Social user ID is a unique value for a given user per application or development account. Configure the Azure AD B2C policy with the same application ID that was previously assigned by the social provider. Or another application within the same development account.

With the link and unlink policies, we append and remove soical identiites to the userIdentities collection. Whether it's a social account, we add new userIdentitie, or a local account and we add the first userIdentities to the collection. So, an account may look like this one:

"displayName": "Andrew Taylor",
"signInNames": [
    {
        "type": "emailAddress",
        "value": "[email protected]"
    }
],
"userIdentities": [{
        "issuer": "Facebook.com",
        "issuerUserId": "MTIzNDU2Nzg5MA=="
    },
    {
        "issuer": "Live.com",
        "issuerUserId": "MDk4NzY1NDMyMQ=="
    }
]

Link flow

1. To link a local or social account to another social identity, user first sign-in (with a local or social account).
2. The policy reads the account from the directory, and checks the value of the userIdentities attribute. As mentioned above, this attribute is a collection. So, the policy extracts the names of the issuer to a string collection. Based on this string collection, the policy show/hide the social identities. For example, if the collection is empty, user will see the four options to link with: Facebook, Microsoft, Google, and Twitter. But, after user linked a Facebook account, on the next time user execute the link policy, the user will see only: Microsoft, Google, and Twitter.
3. User clicks on one of the social identity buttons, which takes the user to the social identity provider to complete the sign-in.
4. After user complete the sign-in with the selected identity provider, the policy tries to find such an account in the directory. If found, the policy displays an error message "You facebook.com identity already exists...". If not found, the policy adds the new social identity to the userIdenitites collection and update the account
5. Azure AD B2C issues an access token.

Unlink flow

1. To unlink a local or social account to another social identity, user first sign-in (with a local or social account).
2. The policy reads the account from the directory, and checks the value of the userIdentities attribute. The policy extracts the names of the issuer to a string collection. Based on this string collection, the policy show/hide the social identities. For example, if the collection has facebook.com, user will see the only Facebook option. But, if user linked Facebook and Twitter identities. The policy will show both Facebook and Twitter.
3. User clicks on one of the social identity buttons, which takes the user to the social identity provider to complete the sign-in.
4. After user complete the sign-in with the selected identity provider, the policy removed that issuer from the userIdenitites collection and update the account.
5. Azure AD B2C issues an access token.

Technical profiles

For each social identity provider, there are four technical profiles. For example:

• Facebook-OAUTH-Base define the basic functionality to sign-in with Facebook account.
• Facebook-OAUTH-SignIn includes the Facebook-OAUTH-Base technical profile, and set the output claims, output claims transformation, and session manager to sign-in with Facebook.
• Facebook-OAUTH-Link includes the Facebook-OAUTH-Base technical profile, and set the output claims, output claims transformation, and session manager to sign-in with Facebook to link an account.
• Facebook-Unlink remove the Facebook issuer from the userIdentities collection.

Community Help and Support

Use Stack Overflow to get support from the community. Ask your questions on Stack Overflow first and browse existing issues to see if someone has asked your question before. Make sure that your questions or comments are tagged with [azure-ad-b2c]. If you find a bug in the sample, please raise the issue on GitHub Issues. To provide product feedback, visit the Azure Active Directory B2C Feedback page.

Notes

This sample policy is based on SocialAndLocalAccounts starter pack. All changes are marked with Sample: comment inside the policy XML files. Make the necessary changes in the Sample action required sections.