.. _offboard-user-webex-ms:



Offboard user (Webex or Microsoft)
-----------------------------------

.. _25.2|EKB-23523:
.. _25.4|EKB-27248:


.. tip:: 

   :ref:`use-action-search-to-navigate-automate`


.. 
   model: view/SubscriberQos



Offboard a Microsoft or Webex user 
......................................

This procedure offboards a user provisioned with the Microsoft Teams or Webex service and moves the user from the site to 
the customer level.

.. note:: 

   The form displays read-only fields to indicate the user's provisioned services, Microsoft or Webex. 
   The **Hybrid Status Message** field displays the user's hybrid status (for a user with Cisco-Microsoft 
   services). See :ref:`cisco-ms-hybrid-subscribers`. 
   
   Custom strings may also exist on the form. 
   These are configured via the field display policy for the model, ``view/SubscriberQos``.

.. note::

   During offboarding, vendor-specific username fields on the system user for Microsoft and Webex services are 
   automatically updated by the offboarding workflows. Identity values are cleared or retained as required based 
   on the user's remaining service associations, and no manual cleanup or System User Audit run is required 
   as part of the Webex or Microsoft offboarding process.


1. In the Admin Portal, go to **Webex User Services** or **Microsoft User Services**. 
2. Click **Offboard User**. 
3. Select the username. 
4. Optionally, at **Offboarding Quick Add Group**, select a Quick Add Group, or leave the 
   field blank to apply the system default behavior. 

   .. note:: 

      Quick add groups in the drop-down are enabled for user offboarding. 

      If you don't see the **Offboarding Quick Add Group** drop-down on this form, it's hidden via the 
      field display policy (FDP), which means that the system default behavior applies when offboarding 
      users. The system default for offboarding is to remove the user's licenses and services.

      If you wish to customize how and whether licenses, and/or lines, and/or or services are removed when offboarding, 
      you can set up this behavior in a custom configuration template (CFT), and associate it to a 
      Quick Add Group used for offboarding to define how users are to be offboarded and de-provisioned.

      .. image:: /src/images/ms-qag-offboard.png 

5. Optionally, if the user has the read-only **Webex Teams Provisioned** checkbox enabled (indicating the 
   user has Webex services), you can choose to select **Remove Webex User if permitted** to remove the 
   user during offboarding. 

6. Click **Save**. 

   The user is moved to the sync source hierarchy, (typically, customer). For a Webex user, 
   this includes moving the Contact Center and or Wholesale user (if these exist). If you've 
   chosen to remove the Webex user, the user is removed from the system.

7. Verify that the user is de-provisioned and offboarded as defined via the configuration template 
   in the Quick Add Group you chose, either a customized offboarding Quick Add Group, or the 
   system default behavior. 
   
   The system default behavior for user offboarding removes the user's licenses and services:
   
   .. important:: 

      The offboard user transaction for a Microsoft user requires a sync with the Microsoft Cloud and 
      relies on waiting for incoming new data from Microsoft. For this reason, you may expect some 
      delay (between 30 and 60 seconds), before the user's new status (unlicensed and/or services removed) 
      displays in Automate. For example, the user may still appear as licensed in Automate, and 
      values such as *PhoneSystem* may still display as an assigned service in the Automate cache, 
      even though the user is unlicensed and services are removed. 



.. rubric:: Related topics 

* :ref:`quick-add-subscriber-groups`
* :ref:`offboarding-ms`


Expose custom string fields on Offboard User 
...............................................

This procedure exposes custom string fields on the **Offboard User** page (`view/SubscriberQos`), 
providing flexibility for adding additional details for a user, if required to set specific values
that for can example trigger workflows during off-boarding. 

.. note:: 
   
   The **Offboard User** page allows for the exposure of up to ten custom string fields and up 
   to 10 custom boolean fields to the field display policy (FDP) you apply to the **Offboard User** page 
   (`view/SubscriberQos`). Values are: 

   * **Custom String 1** (``customString1``) to **Custom String 10** (``customString10``)
   * **Custom Boolean 1** (``customBoolean1``) to **Custom Boolean 10** (``customBoolean10``)



1. Log in to the Admin Portal as Provider admin or higher. 
2. Create or update the Customers data model field display policy: 

   * Go to **Field Display Policies**, and locate the entry for 
     target model type `view/SubscriberQos`. 
   * Click on the default field display policy (FDP) for the model (the FDP named `default`). 
   * Clone (copy) the default FDP for the model, and give the clone a new name. 

     .. note:: 

        You can't modify default FDPs that ship with the system. This allows you to refer to or revert 
        to a system default at any time, if required.  

   * Modify the new FDP (the clone). 

     .. note:: 

        You can add a new group of fields containing only the new custom fields, or add fields to existing field groups.

   * Save your changes.

3. Update the dashboard (:ref:`automate-dashboards`) or menu layout (:ref:`menu-layouts`) to apply the 
   FDP, and save your changes.

4. Log out, then log in again as Provider admin. 

   Role-based access profile changes refresh so that you can view the updated menu layouts and 
   FDPs you applied, including new custom fields.