Skip to main content

UserService.GetUserByEmailLite

Reference​

API.Contracts.User UserService.GetUserByEmailLite(string userEmail)

Returns a lite user object for the user associated with the specified email, with only essential fields populated. Designed for Custom Programs needing basic info about a specific user without full payload overhead.

Parameters​

  • userEmail: The email address of the user.

Returns​

  • API.Contracts.User with only:
    • Id
    • UserName
    • UserEmail
    • TypeInstanceId
    • Roles
  • All other properties are default values.

Caveats​

  • Internal use only: Not exposed via API endpoints or proxy services.
  • Intended for Custom Program consumption.

Usage​

// Returns details of the user associated with the given email
var user = UserService.GetUserByEmailLite(userEmail);
// user.Id, user.UserName, user.UserEmail, user.TypeInstanceId, user.Roles are populated for the specified user

Sample Response​

{
  "id": "03f63b17-3ee5-474e-8336-b134007b906e",
  "userEmail": "admin@acmecorp.com",
  "userName": "Tenant Admin",
  "roles": [ "Tenant Administrator", "None" ],
  "typeInstanceId": "958d3709-5861-4ebc-a0e0-b134007b8fe5"
}

Design Considerations​

  • Lite service minimizes payload and processing.
  • Not accessible outside Custom Programs.