[Index]

Model: device/spark/User

Webex users

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

You can view, update, and add Webex users into VOSS via:

Note

VOSS also allows for the periodic logging and inspection of changes made to data directly in the Webex Control Hub. Contact VOSS if this functionality is to be exposed. The view/WebexAuditEvent and data/WebexAuditEvents models are used for this purpose.

Related topics

Webex User Details in the User Guide

Manage Users

On the Webex User Services > Manage Users page (relation/MultiVendorSubscriber) you can select a user to view and manage their user details, licenses, calling settings, phones, or services. You can also access quick actions available for the user, and enable or disable their login.

Note

If the user is associated with a phone (device) you can click the link adjacent to the device to go to relation/WebexDevice to view and manage the device settings.

Multiple Jabber devices can be added to a Webex user as long as the user does not have an existing device of the same device type.

Access profile dependency for Add Cisco Webex (+)

To enable the Add (+) quick action for Cisco Webex on a user's management page, your access profile must include the following entry:

Note

This dependency applies only to the Add quick action (the + icon) for provisioning Cisco Webex on a user. It does not replace other Webex workflows (for example, Webex Quick User via view/WebexTeamsSubscriberQas).

Related topics

Sync Webex user with flow through provisioning

Sync with flow through for Webex users requires pre-configuring several settings in Automate (including flow through provisioning criteria) before the initial sync from the Webex Control Hub. See: Flow through provisioning (FTP).

This set up allows Automate to apply the correct configuration, licenses, and services to imported users, and to move users to sites. Once you run the sync, users are imported, provisioned, licensed, and moved to the correct synced in sites, as users - in accordance with configured Webex App user model filter criteria and user profile.

Important

For Webex Control Hub users with Webex Calling Professional licenses and a location assigned, this location won't be overwritten by any site setting configured in the Automate user move component (model filter criteria) of flow through provisioning.

The flowchart sets out the sync with flow through of Cisco Webex users and services.

To access the flowcharts, view the topic via the release documentation at: https://documentation.voss-solutions.com/automate.html

Related topics

Flow Through Provisioning in the Core Feature Guide

Provisioning users with Cisco Webex

This section describes how to provision Cisco Webex for a user, either via the Users list view, or via Webex Quick User.

Related topics

Provision Cisco Webex via Cisco User list view

This procedure provisions a user with Cisco Webex, via the Cisco User list view.

Prerequisite:

To provision a user with Webex:

  1. In the Admin Portal, go to Cisco Users.

  2. From the Users list, click on a user you wish to provision with Cisco Webex.

  3. On the Webex App tab/panel, at Webex App User, expand and then fill out settings:

    Note

    • The Invite Pending checkbox is read-only, and defines whether the user's Webex account is active (checkbox is flagged). When the checkbox is clear, the Webex account is not active.
    • Options in the Manager ID field and Location field depend on the Cisco Webex server to which the Cisco Webex Service is synced.

    • At Calling Behavior, choose an option, either of the following:

      • Calling in Webex App
      • Calling in Webex App (Unified CM)
      • Cisco Jabber app
      • Third-Party app

    • At Assigned Licenses, select a license. Options depend on the Cisco Webex server to which the Cisco Webex Service is synced.

    • At Roles, select relevant roles.

      No administrator privileges .
      Full administrator privileges

      Access to all of Portal features, including:

      • Assign roles
      • Company policy and templates
      • Device management licenses and upgrades
      Read-only administrator privileges View only access to privileges available to a full administrator.
      Support Administrator Access to user information and support logs.
      User and Device Administrator .
      Device Administrator .

  4. Save your changes.

    The user is provisioned with Cisco Webex. To verify, ensure the value in the Webex App column in the Cisco Users list view is set to Enabled.

Provision Webex user via Webex Quick User

This procedure enables Cisco Webex for a user via Cisco Quick Add User.

Prerequisite:

  1. In the Admin portal, select the relevant site.

  2. Go to Webex Quick User (view/WebexTeamsSubscriberQas).

  3. At Username, select the user to be provisioned with Cisco Webex.

  4. Select the Webex App checkbox to enable Cisco Webex for the user.

  5. From the Webex Teams User Template drop-down list, choose the template you want to assign to the user.

  6. Click Save. Cisco Webex is provisioned for the user.

    To verify that Cisco Webex is enabled for the user, ensure the Webex App column in the Users list view displays the text, Enabled.

Note

When Cisco Webex Calling (with UCM) is removed from a Webex User, the 'On-Prem UCM Calling' license is removed from the Webex User.

Model Details: device/spark/User

Title Description Details
Id
  • Field Name: id
  • Type: String
  • MaxLength: 1024
Avatar
  • Field Name: avatar
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: lastName
  • Type: String
  • MaxLength: 1024
Email Address *
  • Field Name: email
  • Type: String
  • MaxLength: 1024
Webex Calling - Professional
  • Field Name: calling_pro
  • Type: Boolean
Webex Contact Center
  • Field Name: contact_center
  • Type: Boolean
Work Phone Work number for the person. e.g. +1 408 526 7209. This is only settable for a person with a Webex Calling license.
  • Field Name: workNumber
  • Type: String
  • MaxLength: 1024
Extension Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.
  • Field Name: extension
  • Type: String
  • MaxLength: 1024
Mobile Phone Mobile number for the person. e.g. +1 408 526 7209.
  • Field Name: mobileNumber
  • Type: String
  • MaxLength: 1024
Alternative Phone 1 First alternative number for the person. e.g. +1 408 526 7209.
  • Field Name: alternativeOneNumber
  • Type: String
  • MaxLength: 1024
Alternative Phone 2 Second alternative number for the person. e.g. +1 408 526 7209.
  • Field Name: alternativeTwoNumber
  • Type: String
  • MaxLength: 1024
Phone Numbers Phone numbers for the person. Only settable for Webex Calling. Needs a Webex Calling license.
  • Field Name: phoneNumbers.[n]
  • Type: Array
Type The type of phone number.
  • Field Name: phoneNumbers.[n].type
  • Type: String
  • MaxLength: 1024
  • Choices: ["Work", "Mobile", "Fax"]
Number The phone number e.g. +1 408 526 7209
  • Field Name: phoneNumbers.[n].value
  • Type: String
  • MaxLength: 1024
Primary Whether this is the primary phone number
  • Field Name: phoneNumbers.[n].primary
  • Type: Boolean
Phone Number Type Internal field: PRIMARY or SECONDARY (used for processing, converted to primary boolean)
  • Field Name: phoneNumbers.[n].phoneNumberType
  • Type: String
  • MaxLength: 1024
SIP Addresses The users sip addresses.
  • Field Name: sipAddresses.[n]
  • Type: Array
Type The type of SIP address.
  • Field Name: sipAddresses.[n].type
  • Type: String
  • MaxLength: 1024
Number The SIP address
  • Field Name: sipAddresses.[n].value
  • Type: String
  • MaxLength: 1024
Primary
  • Field Name: sipAddresses.[n].primary
  • Type: Boolean
Addresses The users addresses.
  • Field Name: addresses.[n]
  • Type: Array
Type The type of address.
  • Field Name: addresses.[n].type
  • Type: String
  • MaxLength: 1024
Country The user's country. Example value: US
  • Field Name: addresses.[n].country
  • Type: String
  • MaxLength: 1024
Locality The user's locality, often city. Example value: Milpitas
  • Field Name: addresses.[n].locality
  • Type: String
  • MaxLength: 1024
Region The user's region, often state. Example value: California
  • Field Name: addresses.[n].region
  • Type: String
  • MaxLength: 1024
Street Address The user's street. Example value: 1099 Bird Ave.
  • Field Name: addresses.[n].streetAddress
  • Type: String
  • MaxLength: 1024
Postal Code The user's postal or zip code. Example value: 99212
  • Field Name: addresses.[n].postalCode
  • Type: String
  • MaxLength: 1024
Display Name *
  • Field Name: displayName
  • Type: String
  • MaxLength: 1024
Nickname
  • Field Name: nickName
  • Type: String
  • MaxLength: 1024
Department
  • Field Name: department
  • Type: String
  • MaxLength: 1024
Manager
  • Field Name: manager
  • Type: String
  • MaxLength: 1024
Manager ID
  • Field Name: managerId
  • Type: String
  • MaxLength: 1024
Title
  • Field Name: title
  • Type: String
  • MaxLength: 1024
Time Zone
  • Field Name: timezone
  • Type: String
  • MaxLength: 1024
Location
  • Field Name: locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Date Created
  • Field Name: created
  • Type: String
  • MaxLength: 1024
  • Format: date-time
Last Modified
  • Field Name: lastModified
  • Type: String
  • MaxLength: 1024
  • Format: date-time
Status
  • Field Name: status
  • Type: String
  • MaxLength: 1024
User Type Default: person
  • Field Name: type
  • Type: String
  • Default: person
  • MaxLength: 1024
  • Choices: ["Person", "Bot", "App User (Guest User)"]
Invite Pending
  • Field Name: invitePending
  • Type: Boolean
Login Enabled
  • Field Name: loginEnabled
  • Type: Boolean
Field to pass selected number from QAS workflow
  • Field Name: line
  • Type: String
  • MaxLength: 1024
Roles
  • Field Name: roles
  • Type: Object
No administrator privileges Default: true
  • Field Name: roles.none
  • Type: Boolean
  • Default: true
Full administrator privileges - User Management - Company Policy & Templates - Analytics & Reports - Support Metrics & Notifications - Licenses & Upgrades - Assign Roles
  • Field Name: roles.full
  • Type: Boolean
Read-only administrator privileges Read-only view of the portal. No changes will be accepted.
  • Field Name: roles.readonly
  • Type: Boolean
Support Administrator - Analytics & Reports - Support Metrics & Notifications
  • Field Name: roles.support
  • Type: Boolean
User and Device Administrator - User Management - Device Management - Licenses & Upgrades
  • Field Name: roles.user_device
  • Type: Boolean
Device Administrator - Device Management
  • Field Name: roles.device
  • Type: Boolean
Advanced Help Desk Administrator - Advanced Help Desk Management
  • Field Name: roles.advanced_help_desk
  • Type: Boolean
Help Desk Administrator - Help Desk Management
  • Field Name: roles.help_desk
  • Type: Boolean
Partner Administrator - Partner Administration
  • Field Name: roles.partner
  • Type: Boolean
Partner Full Administrator - Full Partner Administration
  • Field Name: roles.partner_full
  • Type: Boolean
Partner Read-only Administrator - Read-only Partner Administration
  • Field Name: roles.partner_readonly
  • Type: Boolean
Wholesale Administrator - Wholesale Administration
  • Field Name: roles.wholesale
  • Type: Boolean
Assigned Licenses
  • Field Name: licenses.[n]
  • Type: Array
License Select the license to assign to this user.
  • Field Name: licenses.[n].license
  • Type: String
  • Target: device/spark/License
  • Target attr: unique_name
  • MaxLength: 1024
  • Format: uri
Settings
  • Field Name: settings
  • Type: Object
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how a user makes calls in Webex App.
  • Field Name: settings.calling.calling_behaviour
  • Type: String
  • MaxLength: 1024
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app", "Third-Party app"]
Use Organization's Domain Enabling this will use the Webex App organization domain for Calling in Webex App (Unified CM)
  • Field Name: settings.calling.use_org_domain
  • Type: Boolean
UC Manager Profile
  • Field Name: settings.calling.calling_behaviour_uc_manager_profile
  • Type: String
  • Target: device/spark/CallingProfile
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Create iPhone Device Default: true
  • Field Name: settings.calling.SparkiPhoneDevice
  • Type: Boolean
  • Default: true
Create Android Device Default: true
  • Field Name: settings.calling.SparkAndroidDevice
  • Type: Boolean
  • Default: true
Create Tablet Device Default: true
  • Field Name: settings.calling.SparkTabletDevice
  • Type: Boolean
  • Default: true
Create CSF Device Default: true
  • Field Name: settings.calling.SparkCSFDevice
  • Type: Boolean
  • Default: true