Glossary

The following table defines common terms used throughout the User Management API documentation:

Term Meaning
Access Token The OAuth token generated by the authorization server from the JWT exchange which starts every UMAPI session. (This token usually begins with the letters ‘ey’.) The header name is Authorization, and this parameter, preceded by the word ‘Bearer’ and a space, is its value, as in Authorization: Bearer ey....
Admin Console A central location for managing your Adobe entitlements across your entire organization, available at https://adminconsole.adobe.com/enterprise.
AdobeID An Identity Type that is created, owned, and managed by the end user. Adobe performs authentication, and the end user manages the identity. Users retain complete control over files and data associated with their ID. See full discussion at Identity Types.
API Key The API key specified in the Adobe IO Console for the UMAPI integration used to authorize this session. See the Getting Started documentation for details. The header name is X-Api-Key and this parameter is its value.
Deployment Administrator Creates, manages, and deploys software packages and updates to end users. See full discussion at Administrative Roles.
Developer Users given this role for a specific product profile are considered to be a developer for that product profile. See full discussion at Administrative Roles.
Enterprise ID An Identity Type that is created, owned, and managed by an organization. Adobe hosts the Enterprise ID and performs authentication, but the organization maintains the Enterprise ID. End-users cannot sign up and create an Enterprise ID, nor can they sign up for additional products and services from Adobe using an Enterprise ID. See full discussion at Identity Types.
Federated ID An Identity Type that is created and owned by an organization, and linked to the enterprise directory through federation. The organization manages credentials and processes Single Sign-On through a SAML2 identity provider. UMAPI clients with email-federated domains must always identity users by email. See full discussion at Identity Types.
usertype unknown In some cases a userType may contain the value unknown. In these cases the user may not contain the necessary values to identify the user type.
Group type The group type is returned in user-group API responses. User-groups are always of type USER_GROUP
Identity Types The Identity Types resource explains the different account types that are available: Adobe, Enterprise, and Federated IDs.
Organization ID The unique identifier for an organization. This is a string of the form A495E53@AdobeOrg where the prefix before the @ is a hexadecimal number. You can find this value as part of the URL path for the organization in the Admin Console or in the adobe.io console for your User Management integration.
Product Administrator A user role in an organization. A user with this role (an admin) administers the assigned products, managing all associated administrative functions, such as creating product profiles and adding users and user-groups to the organization. See full discussion at Administrative Roles.
Product Profile A set of specific entitlements and roles for a product, defined in the Admin Console. Users and user groups can belong to product profiles.
Product Profile Administrator A user role in an organization. A user with this role administers assigned Product Profile descriptions, managing all associated administrative functions, such as adding and removing users from Product Profiles. See full discussion at Administrative Roles.
System Administrator A user role in an organization. A “super user” for the organization who is allowed to perform all administrative tasks, including the capabilities granted to User Group admin, Product admin, Product Profile admin, Support admin and Deployment admin. See full discussion at Administrative Roles.
Support Administrator See full discussion at Administrative Roles.
User Group A group of loosely associated users. Typically used to organize a set of related users by department or function. For example: U.S.FinanceOperations, EU Human Resources
User-group ID A unique Adobe-assigned number used to identify a user-group. For examples, 46842488
User-group Administrator A user role in an organization. Administers assigned user-group descriptions, managing all associated administrative functions, such as adding and removing users from groups. See full discussion at Administrative Roles.