Webex Admin

Integration Scopes

Use this reference to select the minimum Webex Suite and Webex Contact Center scopes that your integration needs.

anchorSelect scopes

Scopes limit the resources and operations available to an access token. Select scopes when you create an integration, then request a space-separated subset of those registered scopes during authentication.

The user authorizing the integration must also have permission to perform the requested operations. Granting an administrative scope does not give a non-administrator access to administrative functions.

anchorAvailable scopes

anchor

The following list combines the scopes available for Webex Suite and Webex Contact Center integrations.

Webex Contact Center scopes

Many Webex Contact Center scopes use the cjp: prefix. Common examples include cjp:config_read, cjp:config_write, cjp:task_read, cjp:task_write, and cjp:user. Some Contact Center APIs use other scope families, so verify the required scopes in each API reference and request only the scopes your integration needs.

Scope

Usage

spark-compliance:events_read

Access to read events in your user's organization

spark-admin:messages_write

Access to delete messages in all rooms/spaces in your user\'s organization. New integrations, please use spark-compliance:messages_write instead

spark-compliance:messages_write

Delete messages in all spaces in your user's organization

spark-admin:messages_read

Access to read messages in all spaces in your user's organization. New integrations, please use spark-compliance:messages_read instead

spark-compliance:messages_read

Access to read messages in your user's organization

spark-compliance:recordings_write

Access to update/delete converged recording resources in your user’s organization

spark-compliance:recordings_read

Access to read converged recording resources in your user’s organization.

spark-compliance:memberships_write

Access to create/update/delete memberships in your user's organization

spark-compliance:memberships_read

Access to read memberships in your user's organization

spark-compliance:meetings_write

Access to update/delete recordings and transcripts in your user’s organization.

spark-compliance:meetings_read

Access to read recording and transcript resources in your user’s organization.

spark-compliance:rooms_write

Access to modify rooms in your user's organization

spark-compliance:rooms_read

Access to read rooms in your user's organization

spark-compliance:teams_read

Access to read teams in your user's organization

spark-compliance:team_memberships_write

Access to update team memberships in your user's organization

spark-compliance:team_memberships_read

Access to read team memberships in your user's organization

spark-compliance:webhooks_write

Delete org wide webhooks

spark-compliance:webhooks_read

Inspect org wide webhooks

audit:events_read

Access to the audit log for an organization

spark-admin:calling_cdr_read

Access comprehensive Call Detail Records for Webex Calling, including PII-protected phone numbers.

spark-admin:recordings_write

Update and delete access to converged recording resources for admins in your user's organization.

spark-admin:recordings_read

Read access to converged recording resources for admins in your user's organization.

spark-admin:reports_write

Manage partner reports.

spark-admin:reports_read

Fetch partner reports and templates.

spark-admin:broadworks_subscribers_write

Provision, Update or Remove a BroadWorks Subscriber as part of Webex for BroadWorks Solution.

spark-admin:broadworks_subscribers_read

Read or List BroadWorks Subscribers, provisioned as part of Webex for BroadWorks Solution.

spark-admin:broadworks_enterprises_write

Change BroadWorks Enterprise configuration, provisioned as part of Webex for BroadWorks Solution.

spark-admin:broadworks_enterprises_read

Read or List BroadWorks Enterprise, provisioned as part of Webex for BroadWorks Solution.

spark-admin:wholesale_billing_reports_write

Create or Delete Wholesale Billing Reports associated with a Partner, subscribed to Webex for Wholesale solution.

spark-admin:wholesale_billing_reports_read

Read or List Wholesale Billing Reports associated with a Partner, subscribed to Webex for Wholesale solution.

spark-admin:wholesale_sub_partners_write

Create or delete sub-partners associated with a partner, subscribed to the Webex for Wholesale solution.

spark-admin:wholesale_sub_partners_read

Read or list sub-partners associated with a partner, subscribed to the Webex for Wholesale solution.

spark-admin:wholesale_customers_write

Provision, Update or Remove a Customer as part of Webex Wholesale Solution.

spark-admin:wholesale_customers_read

Read or List Customers, provisioned as part of Webex Wholesale Solution.

spark-admin:wholesale_subscribers_write

Provision, Update or Remove a Subscriber as part of Webex Wholesale Solution.

spark-admin:wholesale_subscribers_read

Read or List Subscribers, provisioned as part of Webex Wholesale Solution.

spark-admin:wholesale_workspace_write

Allows the user to convert a wholesale workspace from NORMAL to CONVERSION

spark-admin:people_write

Access to write to your user's company directory

spark-admin:people_read

Access to read your user's company directory

spark-admin:licenses_read

Access to read licenses available in your user's organizations

spark-admin:roles_read

Access to read roles available in your user's organization

spark-admin:telephony_config_write

Create, edit and delete telephony configuration

spark-admin:telephony_config_read

Read and list telephony configuration

spark-admin:telephony_pstn_write

Scope to limit the write access for partner telephony PSTN

spark-admin:telephony_pstn_read

Scope to limit the read access for partner telephony PSTN

spark-admin:workspaces_read

See details for your workspaces

spark-admin:workspace_locations_write

Create, modify and delete your workspace locations

spark-admin:workspace_locations_read

See details for your workspace locations

spark-admin:workspace_metrics_read

See metrics for your workspaces

spark-admin:places_write

Create, update and delete any place and place service in your organization

spark-admin:places_read

See details for any places and place service in your organization

spark-admin:locations_write

Create and edit location configuration.

spark-admin:locations_read

Read and list location configuration.

spark-admin:devices_write

Create, update and delete devices and device configurations in your organization

spark-admin:devices_read

See details for any device in your organization

spark-admin:organizations_read

Access to read your user's organizations

spark-admin:resource_groups_read

Access to read your organization's resource groups

identity:contacts_read

Read contacts.

spark-admin:resource_group_memberships_write

Access to update your organization's resource group memberships

spark-admin:resource_group_memberships_read

Access to read your organization's resource group memberships

spark-admin:call_qualities_read

Access to read organization's call qualities

spark-admin:calls_write

Allow administrator to invoke call commands on any user in their organization

spark-admin:hybrid_clusters_read

Access to read hybrid clusters for your organization

spark-admin:hybrid_connectors_read

Access to read hybrid connectors for your organization

identity:tokens_write

Admin can delete token for a user

identity:tokens_read

Admin can list token Ids for a user

identity:groups_rw

Read Write groups

identity:groups_read

Read group

identity:organizations_rw

Modify organizations data like name

identity:organizations_read

Read an organizations data, like name

identity:contacts_rw

Manage contacts.

Identity:one_time_password

Request a one time password for people, devices, and things.

identity:placeonetimepassword_create

Access to a one time password to a place to create an activation code

Identity:Config

Identity:Config

Identity:Organization

Identity:Organization

cjp:config

Manage contact center configurations in your user's organization

cjp:config_write

Manage or delete contact center configurations in your user's organization

cjp:config_read

Access contact center configurations in your user's organization

cjp:user

Access agent and supervisor actions that can be performed from the Agent/Supervisor Desktop

meeting:admin_recordings_write

Manage or delete recordings of all Webex users of your organization

meeting:admin_recordings_read

Retrieve recordings of all Webex users of your organization

meeting:admin_transcripts_read

Retrieve Webex meetings transcripts of all Webex users of your organization

meeting:admin_participants_read

Read participant information from meetings for all Webex users of your organization

meeting:admin_schedule_write

Create, manage, or cancel meetings of all Webex users of your organization

meeting:admin_schedule_read

Retrieve meetings of all Webex users of your organization

meeting:admin_preferences_write

Manage meeting preferences of all Webex users of your organization

meeting:admin_preferences_read

Retrieve Webex meeting preferences of all Webex users of your organization

meeting:admin_config_write

Manage Webex meeting configurations as an administrator

meeting:admin_config_read

Retrieve Webex meeting configurations as an administrator

meeting:recordings_write

Manage or delete your meeting recordings for playback

meeting:recordings_read

Retrieve your Webex meeting recordings for playback

meeting:transcripts_read

Retrieve your Webex meetings transcripts

meeting:summaries_read

Retrieve your Webex meetings summaries

meeting:summaries_write

Make changes to your Webex meeting summaries

meeting:controls_write

Update meeting controls for in-progress meetings

meeting:controls_read

Read meeting control information for in-progress meetings

meeting:participants_write

Manage participants within meetings

meeting:participants_read

Read participant information from meetings

meeting:schedules_write

Create, manage, or cancel your scheduled Webex meetings

meeting:schedules_read

Retrieve your Webex meeting lists and details

meeting:preferences_write

Edit your Webex meeting preferences

meeting:preferences_read

Retrieve your Webex meeting preferences

spark:recordings_write

Updated and delete access to converged recordings for recording owners.

spark:recordings_read

Read access to converged recordings for recording owners.

spark:all

Full access to your Webex account

spark:applications_token

Retrieve Service App token. Not for FedRAMP customers.

spark:messages_write

Post and delete messages on your behalf

spark:messages_read

Read the content of rooms that you are in

spark:memberships_write

Invite people to rooms on your behalf

spark:memberships_read

List people in the rooms you are in

spark:xsi

Access to your Webex Calling resources (e.g. calls & call settings)

spark:xapi_statuses

Retrieve all information from RoomOS-enabled devices.

spark:xapi_commands

Execute all commands on RoomOS-enabled devices.

spark:calls_write

Allow users to invoke call commands on themselves

spark:calls_read

List all active calls you are part of / List call history from Webex Calling

spark:webrtc_calling

Access webrtc services for Webex calling

spark:people_read

Read your users' company directory

spark:rooms_write

Manage rooms on your behalf

spark:rooms_read

List the titles of rooms that you are in

spark:teams_write

Create teams on your users' behalf

spark:teams_read

List the teams your user's a member of

spark:team_memberships_write

Add people to teams on your users' behalf

spark:team_memberships_read

List the people in the teams your user belongs to

spark:devices_write

Modify and delete your devices

spark:devices_read

See details for your devices

spark:telephony_config_write

Create, edit and delete your telephony configuration

spark:telephony_config_read

Read and list your telephony configuration

spark:places_write

Create, modify and delete places and place services you manage

spark:places_read

See details for places and place services you manage

spark:organizations_read

Access to read your user's organizations

spark:mcp

Access MCP servers hosted on Webex Agentic Platform

spark:webhooks_read

spark:webhooks_read

spark:webhooks_write

spark:webhooks_write

application:webhooks_write

application:webhooks_read

List webhooks for Service App authorization. Not for FedRAMP customers.

wxc-dedicateduc:admin_perfmon_read

spark-admin:calls_read

Access to list all calls in your user's organization

webexsquare:admin

webexsquare:admin

guest-issuer:read

Retrieve guest and guest metadata via Service App

guest-issuer:write

Create and manage guest users via Service App

cjds:admin_org_read

cjds:admin_org_read

cjds:admin_org_write

cjds:admin_org_write

cloud-contact-center:pod_conv

cloud-contact-center:pod_conv

meeting:group_meeting_write

Permission to update or delete meeting content—including recordings, transcriptions, and related metadata—as well as the ability to start or stop recordings for meetings hosted by users within a managed group

meeting:group_meeting_read

Read access to meeting content—including recordings, transcriptions, and related metadata—as well as the ability to view recording controls (such as start/stop recording status) for meetings hosted by users within a managed group

cjp:task_write

Create tasks

cjp:task_read

Ability to inspect tasks

spark-admin:datasource_read

Allows a Service App to read datasources usually for Bring Your own Virtual Agent (BYOVA) use cases.

spark-admin:datasource_write

Allows a Service App to create new datasources and update existing datasources usually for Bring Your own Virtual Agent (BYOVA) use cases.

spark-admin:metrics_read

Retrieve Webex metrics

guest-meeting:rw

Ability to orchestrate guest-to-guest meetings via Service App

anchorImportant scope behavior

anchor

Administrative scopes

Scopes beginning with spark-admin require a user with administrative access to the organization. Requesting one of these scopes does not elevate the authorizing user's role.

For Webex Contact Center administrator APIs, the authorizing user must have the appropriate Webex Contact Center administrator role in Control Hub. See Webex Contact Center administrator roles and privileges.

Compliance scopes

Scopes beginning with spark-compliance require an organization compliance officer. See the Compliance Guide.

`spark:all`

The spark:all scope grants access to Webex account features that are not covered by other user-level scopes. It does not include spark-admin privileges. Some Webex SDK calling features require spark:all; most integrations should request narrower scopes.

`spark:kms`

Webex adds spark:kms to an integration's selected scopes so it can interact with encrypted content such as messages. The generated authorization URL includes this scope. If you build the authorization URL yourself, include spark:kms when the APIs you call require access to encrypted content.

anchorNext steps

anchor

After selecting scopes, create the integration and implement the OAuth authentication flow.

Webex Admin

Integration Scopes

anchorSelect scopes

anchorAvailable scopes

Webex Contact Center scopes

anchorImportant scope behavior

Administrative scopes

Compliance scopes

spark:all

spark:kms

anchorNext steps

In This Article

`spark:all`

`spark:kms`