Admin API

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

anchorWhat's possible with Admin APIs
anchor

The Webex Teams API includes administration APIs that allow administrators to programmatically perform administration actions such as provisioning a user. By automating administration, user management and provisioning can be centralized in an existing tool, rather than using the Webex Control Hub.

Currently, administration is focused on user provisioning. Using these APIs, an admin can:

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

anchorAuthentication
anchor

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 necessary scopes.

Creating an Integration that will act on behalf of an administrator can be done by including one or more of the following scopes when requesting an auth token via oAuth.

Scope
Usage
spark-admin:licenses_read
Access to read licenses available in your user's organizations
spark-admin:organizations_read
Access to read your user's organizations
spark-admin:people_read
Access to read your user's company directory
spark-admin:people_write
Access to write to your user's company directory
spark-admin:resource_group_memberships_read
Access to read your organization's resource group memberships
spark-admin:resource_group_memberships_write
Access to update your organization's resource group memberships
spark-admin:resource_groups_read
Access to read your organization's resource groups
spark-admin:roles_read
Access to read roles available in your user's organization
anchorAdministration Sandbox
anchor

If you would like to develop against the Admin APIs but you are not an administrator of your Webex Teams Organization, you can apply for administrator rights to our Sandbox Organization. The Admin Sandbox will allow you to use a separate Webex Teams 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 Teams. We will create a new Webex Teams account for this email address and assign it to the Admin Sandbox organization. This new Webex Teams 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 Teams account and cannot be associated with a domain that has been claimed by an existing Webex Teams 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 Teams 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 Teams account to devsupport@webex.com, requesting Admin Sandbox access, and including the email address you would like to have enabled for sandbox access.

Last updated: November 8, 2018