Users API

Manage the users in your organization.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/v1, unless otherwise noted.

User

For more information, see User.
MethodEndpointDescription
post/users

Creates a global user.

Notes:

  • Apigee Edge for Private Cloud only. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.
  • This API cannot be executed using the Try this API panel.

After you create the user in an organization, you must assign the user to a role in an organization. Roles determine the access rights of the user on Edge. The user cannot sign in to the Edge UI, and does not appear in the list of users in the Edge UI, until you assign it to a role in an organization. See Add a user to a role.

See About global users for more on Edge users, user types, and user roles.

delete/users/{user_email}

Deletes a user.

Notes:

  • Apigee Edge for Private Cloud only. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.
  • This API cannot be executed using the Try this API panel.

See About global users for more on Edge users, user types, and user roles.

get/users/{user_email}

Gets user details.

Notes:

  • Apigee Edge for Private Cloud only. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.
  • This API cannot be executed using the Try this API panel.

See About global users for more on Edge users, user types, and user roles.

put/users/{user_email}

Updates a user.

Notes:

  • Apigee Edge for Private Cloud only. If you are using Apigee Edge for Public Cloud, contact Apigee Support for assistance.
  • This API cannot be executed using the Try this API panel.

When calling this API:

  • You must pass first name, last name, and email address to the call, even if you are not changing the values.
  • The password is the only optional property. Only specify password when you want to change the user's password.

To view the current information about a user, see Get user.

See About global users for more on Edge users, user types, and user roles.