Manage Users and Roles

Was this helpful?

Before your team can start using Apigee, you need to have an account, that is, an organization, and an account within that organization. Your organization was given an Apigee account as part of the set up. If you find that you don't have an account, contact Apigee Support. Support can also help if you need to delete an account.

If you're an administrator, you have access to the Admin tab where you can add and modify users. All new users are added as orgadmins which means that they can add new users or modify existing users.

Back to top

User roles

In Apigee, user roles form the basis of role-based access, meaning that you can control what functions a person can access by assigning them a role. The following roles are available: 

Role Permissions
User

Allowed

  • Can see the list of all the org's APIs and create new ones. They can also see the details of each of the org's APIs, modify them, and delete them. 
  • Can deploy to the test environment.
  • Can see the API Products available in the org.
  • They can see Developers in the org but cannot modify them.
  • Can create and delete trace sessions and get their data in all environments.
  • Can see the list of all Analytics custom reports but cannot create any.

Not allowed

  • Cannot deploy to production environment
  • Cannot create or delete API products
Business User

Allowed

  • Can see the list of all the org's APIs, but cannot create new ones. In addition, they cannot modify or delete existing APIs.
  • Can see the list of all the org's API Products and create new ones. They can also modify and delete existing API products.
  • Can see the list of all the org's Developers and create new ones. They can also modify or delete existing ones.
  • Can see the list of all the org's Apps and create, modify or delete them.
  • Can see the list of all Analytics custom reports and create new ones.

Not allowed

  • Cannot deploy APIs to any environment.
Organization Administrator

Allowed

  • Can add, delete, modify and deploy APIs to all environments.
  • Can add, modify and delete Developers and Apps.
  • Can create and delete trace sessions and get their data in all environments.
  • Can view and create custom reports.

Not allowed

  • Cannot add or delete environments. 
Operations Administrator

Allowed

  • Can view and deploy APIs in all environments.
  • Can view API products, Developers and Apps
  • Can view custom reports.
  • Can create and delete trace sessions and get their data in all environments.
  • Can add or delete environments.

Not allowed

  • Cannot add or modify APIs
  • Cannot create new API Products, Developers and Apps
  • Cannot add custom reports

Note: You can configure more complex roles and permissions using the User API. See Setting up role-based access control in an organization for more.

Back to top

Viewing user data

The Users table on the Admin tab lists all of the users attached to the current account. You can see the name of the current account by clicking the Home icon. For each user you can see:

  • Name: The name of the user you entered when you created the user.
  • Role: The role of the user, which determines the degree of access. By default, all users have a user role that gives them full access to all features in Apigee
  • Primary email: The email address you entered when you created the user.
Back to top

Adding users

Users of the management system are members of the API team who develop and test API, or run reports, not external developers. You can add developers through the Developer tab or they can add themselves through your developer portal.

  1. Click the Admin tab.
  2. Click + User. The "Add a User" screen appears.
  3. Enter the user's First Name, Last Name, and Email.
  4. Select the Role you want to offer to the users. Select either User or Administrator.
  5. Click Save.
Back to top

Deleting users

There are two ways to delete a user:

  • To remove a user from your account, select the user in the Users table and click Delete. This only removes the user from the current account. If the user is a member of multiple accounts, they remain in the system.
  • To remove a user from Apigee completely, contact Apigee Support.
Back to top