Using the nameidentifier claim as a user's global unique identifier

MatthiasLA · December 3, 2019, 9:40pm

Hi.
I have a quick question about referencing users in my database model.

I am using Asp.Net and Entity Framework and I was wondering if it is okay to use the value from the nameidentifier claim, that I get from Auth0, as a reference in records in a database?

Is it the correct value to use, or should I use another value?
How will this affect my solution in the future if I decided to change things up?

I am still learning and was wondering if it would have any consequences or I am on the right track in regards to this.

markd · December 4, 2019, 4:06pm

Hi @MatthiasLA,

I’m only guessing here , but if nameIdentifier is being set equal to the user’s root user_id attribute, that value is guaranteed to be unique within the given database, so it may be safe to use as a key into other databases, since you can always take those fields with you if you migrated to another solution.

That said, personally I would recommend implementing your own unique identifier. The example rule linked below would add a standard UUID to a user’s profile if they do not already have one. This is what I am pushing for where I work, though we haven’t implemented this yet. I just like the idea of using 1. an actual UUID standardized unique identifier and 2. something that is in no way linked to the underlying IAM service.

github.com

dmark/auth0-cli-utilities/blob/master/rules/add-uuid-to-app-metadata.js

function (user, context, callback) {
  // Generates a version 4 random UUID. Namespace UUIDs do not appear
  // to be an option in Auth0 at this time.
  const { v4: uuidv4 } = require('uuid');

  user.app_metadata = user.app_metadata || {};
  user.app_metadata.uuid = user.app_metadata.uuid || uuid();
  
  auth0.users.updateAppMetadata(user.user_id, user.app_metadata)
    .then(function(){
    callback(null, user, context);
  })
    .catch(function(err){
    callback(err);
  });
}

MatthiasLA · December 6, 2019, 12:47pm

Hi @markd.
Thanks a lot for the explanation. It sounds like a lot fo the same thoughts I have had, I just wanted to make sure that it was the right approach.
The user_id attribute in Auth0 is in fact the id of the user, but with “auth|” put in front, which means it is very much tied into Auth0.
I will mark your comment as answer to end the question.

Best
Matthias

markd · December 6, 2019, 2:40pm

That’s correct. The root level user_id will have a prefix indicating what source system was used to create the profile. So auth0| for an Auth0 database user, google-apps| for a G Suite enterprise connection, google-oauth2| for Google social login etc.

You can take the user_id field with you if you leave Auth0 but personally I do prefer to have a plain industry standard UUID.

konrad.sopala · December 9, 2019, 11:06am

Thanks Mark for sharing the knowledge on this front!

system · December 24, 2019, 11:06am

This topic was automatically closed 15 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Using another user identifier (UUID) than the user_id Help user-creation , uuid , user_id	10	19355	March 2, 2018
Unique "username" for all users Help user-profile , user-management	4	2944	January 10, 2023
How to add a user ID generated from my own database as a custom user ID claim in the ID token, signed and issued by auth0 Help user-profile , user-management	0	32	October 2, 2024
Storing ID Best Practices -> Relationships in Database Help auth0 , api	3	5641	December 30, 2019
Beginner question - how can i store some user id in my db, and what about cookies? Help user-management , user-search	1	1958	March 23, 2023

Using the nameidentifier claim as a user's global unique identifier

Related Topics