Load User

Load a user's data, using a valid management key.

This API endpoint takes the user's loginId and then returns details of a user utilizing a valid management key. The response includes the following; however, there are additional items in the response that you can see below by expanding the response 200 OK.

  • loginIds
  • userId
  • name
  • email
  • phone
  • verified settings (phone, email)
  • Tenant configurations - which tenantIds, which roleNames

Note: Suppose you frequently load a user for a specific user detail, such as their email address or a particular custom attribute. In that case, you can save execution time and additional API/SDK calls to load the user by adding the items to the custom claim. For details on adding items to the custom claims, see this documentation.

Next Steps

Once you have this data, you can utilize the response to prepare the payload to perform an Update on the user.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer <ProjectId:ManagementKey>

SecurityAuthProjectIdMgmtKey
Request
query Parameters
loginId
string
userId
string
Responses
200

OK

get/v1/mgmt/user
Request samples
Response samples
application/json
{
  • "user": {
    }
}