API and user interface role mapping
Each user role is associated with one of two system records: the membership record, which is bound to a company, or the user record, which is bound to a user. In the user interface, the distinction is not apparent; in API requests and responses, the roles associated with the different records appear in different objects.
In the user interface, Company Administrators manage roles associated with the membership record through App Manager, but only AppDirect employees can manage user record roles. See the following topics and sections for more information on roles:
Role names in the AppMarket user interface differ slightly from the role values that appear in API requests and responses.
In API requests and responses, membership record roles are included in
the "roles"
array in the
UserCompanyMembershipAccountV2
object. User record roles are included in the "roles"
array in the
UserAccountV2
object.
Various API calls use or return one or both of the
UserCompanyMembershipAccountV2
and UserAccountV2
objects either
explicitly or contained within other objects. You might therefore see
two "roles"
arrays in a single request or response, although the
arrays contain different role information.
The following table maps the role names as they appear in API requests and responses to the role names as they appear in the user interface, and lists the associated record.
API role | Role in user interface | Associated Record |
---|---|---|
ROLE_USER | User | User |
ROLE_CORPORATE_ADMIN | Network Manager | User |
ROLE_CHANNEL_PRODUCT_SUPPORT | Product Support | Membership |
ROLE_SALES_SUPPORT | Sales Support | Membership |
ROLE_RESELLER | Reseller | Membership |
ROLE_RESELLER_MANAGER | Reseller Manager | Membership |
ROLE_CHANNEL_SUPPORT | Customer Support | Membership |
ROLE_SYS_ADMIN | Company Admin | Membership |
ROLE_BILLING_ADMIN | Billing Admin | Membership |
ROLE_DEVELOPER | Developer | Membership |
ROLE_CHANNEL_ADMIN | Marketplace Manager | Membership |
All users have the User role and it cannot be removed.
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!