What is the query to fetch user details by email in Content Hub

Question

I have created a user in Content Hub with Username as [email protected]. For its Email property, I have set the same value i.e., [email protected]

Assuming that there could be multiple users with same Username and same Email, I would like to fetch all the users by passing email as parameter. The email can be a user's Username or Email or both.

I'm using Postman to test the queries.

When I execute this query, the output is as expected. There is only one returned result and the identifier is that of the User's.

{{Hostname}}/api/entities/query?query=Definition.Name=='User' AND String('Username')=='[email protected]'

But, when I execute this query, there is an output with 1 returned result, but the identifier is that of User Profile, which is not desired. I'm expecting the User Identifier in results and not the User Profile details.

{{Hostname}}/api/entities/query?query=String('Email')=='[email protected]'

I also tried this, which returns no results:

{{Hostname}}/api/entities/query?query=Definition.Name=='User' AND String('Email')=='[email protected]'

How can I fetch the User's details (and not User Profile) by passing email as the parameter.

UPDATE:

Here is the result, when I hit the UserToUserProfile URL

Answer 1

In order to fetch the User by email, you will need to run two queries as below.

1. Search for the email property on the UserProfile entity definition with the query as below.

/api/entities/query?query=Definition.Name=='M.UserProfile' AND String('Email')=='{Email_Address}'

Since email property exist on M.UserProfile entity, hence we first need to get the user profile.

2. Once the user profile is retrieved, we can fetch the User by reading UserToUserProfile relation in the above api response.

This relation contains the User associated with the user profile. Using this way we can fetch the user details using email in Content Hub.

Moreover, in case you are using Web SDK, you can use following snippet to fetch user by email.

using Stylelabs.M.Base.Querying;
using Stylelabs.M.Base.Querying.Linq;
using Stylelabs.M.Framework.Essentials.LoadConfigurations;
using Stylelabs.M.Sdk.Contracts.Base;
using Stylelabs.M.Sdk.WebClient;
using Stylelabs.M.Sdk.WebClient.Authentication;
using System;
using System.Linq;
using System.Threading.Tasks;

string email = "{{EmailAddress}}";
var query = Query.CreateQuery(entities =>
            from e in entities
            where e.DefinitionName == "M.UserProfile"
            && e.Property("Email") == email
            select e);
           
var queryResult = await MClient.Querying.SingleAsync(query, EntityLoadConfiguration.Full);
var userProfileRelation = await queryResult.GetRelationAsync<IChildToOneParentRelation>("UserToUserProfile");
if (userProfileRelation != null)
{
   var userProfileId = userProfileRelation.GetId();
   var user = await MClient.Entities.GetAsync(userProfileId.Value, EntityLoadConfiguration.Full);
}

Hope this helps!!!