Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex. Please visit Webex for Developers to manage your apps.

Admin API

Manage Webex users, licenses, and hybrid services programmatically with the Webex Admin APIs.

anchorWhat's possible with Admin APIs

The Webex APIs include several APIs that allow administrators to programmatically perform administrative actions such as provisioning a user or assigning a license to a user. By automating administration, user management and provisioning can be performed from an existing tool, rather than using the Webex Control Hub.

Using these APIs, an admin can, for example:

If your organization uses the Cisco Directory Connector to synchronize Webex user accounts with Active Directory accounts, then you cannot create or delete Webex users via the People API.

anchorAdmin Audit Events

Full administrators for an organization can use the Admin Audit Events API to retrieve information about significant actions taken by administrators in Webex Control Hub. See this article for detailed information about the types of events you can retrieve.

Administrators with accounts created before 2019 who have never logged into Webex Control Hub will need to log into Webex Control Hub at least once to enable access to the Admin Audit Events API.


Use of these APIs requires you to be an administrator of an organization. If you are not an administrator of an organization, but wish to develop against these APIs, see below for instructions on how to get administrator access to an Administration Sandbox organization.

If you are an administrator, log into this site to get a development auth token with the necessary scopes.

To create an Integration that will act on behalf of an administrator, include one or more of the following scopes when requesting an auth token via OAuth:

Change BroadWorks Enterprise configuration, provisioned as part of Webex for BroadWorks Solution.
See details for any device in your organization
Create, update and delete devices and device configurations in your organization
Access to read licenses available in your user's organizations
Access to read your user's organizations
Access to read your user's company directory
Access to write to your user's company directory
See details for any places and place service in your organization
Create, update and delete any place and place service in your organization
Access to read your organization's resource group memberships
Access to update your organization's resource group memberships
Access to read your organization's resource groups
Access to read roles available in your user's organization
Read or List BroadWorks Enterprise, provisioned as part of Webex for BroadWorks Solution.
Access to read hybrid clusters for your organization
Access to read hybrid connectors for your organization
Read or List BroadWorks Subscribers, provisioned as part of Webex for BroadWorks Solution.
Provision, Update or Remove a BroadWorks Subscriber as part of Webex for BroadWorks Solution.
anchorAdministration Sandbox

If you would like to develop against the Admin APIs but you are not an administrator of your Webex Organization, you can apply for administrator rights to our Sandbox Organization. The Admin Sandbox will allow you to use a separate Webex account that is an administrator in a dummy organization for purposes of testing and developing your code.

Use of the Admin Sandbox requires that you understand and agree to the following:

  • You will need a separate email address from the one you currently use for Webex. We will create a new Webex account for this email address and assign it to the Admin Sandbox organization. This new Webex account will be an administrator of the Admin Sandbox Organization.
  • The email address you use for the Sandbox account cannot have been previously used for a Webex account and cannot be associated with a domain that has been claimed by an existing Webex organization. This means an alias for your work email address will probably not work, as your company has likely claimed your entire email domain for their Organization. Using a personal email address or a web email service is recommended.
  • You will be an admin in the Sandbox Organization, along with every other developer who has been granted access to the Sandbox organization. This means you will have the ability to remove other users, claim domains, and other functions a Webex organization admin has the ability to do. Play nice. Kicking other users, altering data, and generally monkeying about in the admin console won't be tolerated and we'll permanently ban you from the Sandbox if you're being malicious.
  • To use the Admin APIs or the interactive Webex for Developers documentation as an admin, you will need to sign into the Webex for Developers web site with the new administrator account using your alternate email address. You'll need to generate authentication tokens as this administrator account, rather than from your normal account. Your normal account will not have any access to the administrative APIs or the Admin Sandbox.
  • When your account is created for the Admin Sandbox, you will receive an email inviting you to administer the organization. You will need to follow the instructions in that email to complete your activation.

To request access to the administrator sandbox, send an email from the email address used on your existing Webex account to devsupport@webex.com, requesting Admin Sandbox access, and including the email address you would like to have enabled for sandbox access.