Skip to main content
jannieza
Participant
May 24, 2019
Answered

UMAPI: For which account types is "id" populated? (id: string; The user’s unique identifier.)

  • May 24, 2019
  • 1 reply
  • 938 views

Using the user management api to build basic license reporting:

Would like the id returned for all users in my organization as some email addresses (which is our primary key) seems incorrect.

I receive most attributes, but there is no data for id.

Should an email need to update (incorrect, surname updates) , would like to use the id as secondary key, to point those out.

1.Is this (id) attribute available?

2.Is the (id) attribute available for AdobeID type users?

I utilize:

Get User Information

GET /v2/usermanagement/organizations/{orgId}/users/{userString}

GET /v2/usermanagement/users/{orgId}/{page}

Documentation on Attributes:

user: A user object containing relevant properties. Properties that are not populated are not returned in the response. Some properties are not applicable for particular account types.

  • country: string; A valid ISO 2-character country code.
  • domain: string; The user’s domain.
  • email: string; The user’s email address.
  • firstname: string; The user’s first name.
  • groups: string[]; The list of groups that the user is a current member of, including user groups, product profiles, product admin groups, and group-specific admin groups. Administrative groups are named with a prefix and the group name. For example, _product_admin_Photoshop, _admin_DesignTools, or _developer_Marketing. Organization-wide admin groups are:
  • id: string; The user’s unique identifier.
  • lastname: string; The user’s last name.
  • status: string; A user’s status with the organization. Only “active” users are returned by Get User Information and Get Users in Organization. One of the following:
    • “active”: Normal status for a user account in good standing.
    • “disabled”: Disabled temporarily - user is not allowed to login, but is not removed.
    • “locked”: Disabled permanently - user is not allowed to login, but is not removed.
    • “removed”: The user account is being removed.
  • type: string; The user type, one of: { "adobeID", "enterpriseID", "federatedID", "unknown" }; See Identity Types for more information.
  • username: string; The user’s username (applicable for Enterprise and Federated users). For most AdobeID users, this value is the same as the email address.
  • adminRoles: string[]; Deprecated. Administrative roles are reflected in group memberships, returned in the groups field.
This topic has been closed for replies.
Correct answer luciann58355119

Hi,

There may be a documentation error, as the id no longer returns in new the version, therefore you cannot obtain it via UMAPI.

To extract all your users from the org use the getUsers: Get Users in Organization , then parse the response to reach the info for a particular user.

When you use the update function of the API, do not expect it to work for letter case updates. You can however, update the email to be something different (ex: abc@domain.com -> ABC@domain.com will fail; abc@domain.com -> abcD@domain.com will work)

1 reply

luciann58355119Correct answer
Adobe Employee
May 24, 2019

Hi,

There may be a documentation error, as the id no longer returns in new the version, therefore you cannot obtain it via UMAPI.

To extract all your users from the org use the getUsers: Get Users in Organization , then parse the response to reach the info for a particular user.

When you use the update function of the API, do not expect it to work for letter case updates. You can however, update the email to be something different (ex: abc@domain.com -> ABC@domain.com will fail; abc@domain.com -> abcD@domain.com will work)

jannieza
janniezaAuthor
Participant
May 24, 2019

Thanks for the reply, much appreciated.