Subscriber Data Export#

Filename: <YYYY-MM-DD_HHMM>_subscriber.json.gz

Layout:

ELEMENT

DESCRIPTION AND SOURCE FIELD

DATA TYPE

VERSION

provider_name

Name of the Provider

string

v2

reseller_name

Name of the Reseller

string

v2

customer_name

name of the customer

string

v1

division_name

Intermediate Node (e.g Division or other node)

string

v1

location_name

Site Name

string

v1

hierarchy

The full hierarchy path for the item being exported

string

v1

username

username of the user

device/cucm/User.userid

string

v1

first_name

First name of the user

device/cucm/User.firstName

string

v1

middle_name

Middle name of the user

device/cucm/User.middleName

string

v3

last_name

Last name of the user

device/cucm/User.lastName

string

v1

email

email address of the user

device/cucm/User.mailid

string

v1

ELEMENT

DESCRIPTION AND SOURCE FIELD

DATA TYPE

VERSION

entitlement_profile

the profile assigned to the user that defines the features they are enabled to have configured

release 19.3.4

data/HcsUserProvisioningStatusDAT.entitlement_profile

release >= 21.1

data/User.entitlement_profile

or

data/HcsUserProvisioningStatusDAT.entitlement_profile

string

v1

role

The role assigned to the user - defines privileges in the portal

data/User.role

string

v1

credential_policy

The security profile assigned to the user - defined credential and other security rules for portal access

data/User.account_information.credential_policy

string

v1

snr

Does the user have the SNR service configured

device/cucm/RemoteDestinationProfile.userId

boolean

v1

voicemail

Does the user have a voicemail box configured

device/cuc/User.Alias

boolean

v1

title

Subscriber’s title

release 19.3.4

data/NormalizedUser.title

>= release 21.1

data/User.title

or

data/NormalizedUser.title

string

v2

ELEMENT

DESCRIPTION AND SOURCE FIELD

DATA TYPE

VERSION

department

Subscriber’s department

device/cucm/User.department

string

v2

telephone_number

Subscriber’s telephone number as configured in the CUCM user record

device/cucm/User.telephoneNumber

string

v2

pager_number

Subscriber’s pager number

device/cucm/User.pagerNumber

string

v3

imp_enabled

User enabled for Unified CM IM and Presence

device/cucm/User.imAndPresenceEnable

boolean

v4

Example

(Fields marked * are new in version 2, fields marked ** are new in version 3, and fields marked *** are for v4)

[
   {
   *   "provider_name": "CS-P",
   *   "reseller_name": "CS-NB",
       "customer_name": "AAAGlobal",
       "division_name": "",
       "location_name": "AAA-Boston",
       "hierarchy": "sys.hcs.CS-P.CS-NB.AAAGlobal.AAA-Boston",
       "username": "ba_user4",
       "first_name": "Dean",
   **  "middle_name": "John",
       "last_name": "Daniels",
       "voicemail": false,
       "entitlement_profile": "AAAGlobal-Foundation-EP",
       "snr": false,
       "credential_policy": "HcsCredentialPolicy",
       "role": "AAA-BostonSelfService",
       "email": "[email protected]",
   *   "title": "Dr.",
   *   "department": "R&D",
   *   "telephone_number": "0215252020",
   **  "pager_number": "5551234545",
  ***  "imp_enabled": False
    }
]