[Index]

Model: relation/HcsCustomerREL

Customers

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This procedure adds a new customer, and updates an existing customer.

Note

  1. Log in as Provider or Reseller administrator (depending on which organization manages the customer).

    Note

    Log in using the Provider or Reseller admin's email address (case-sensitive). You can find this email address via (default menus) User Management > Admins. Click on the admin's name to view the email address.

  2. Choose the hierarchy.

    Note

    If logged in as Provider and the customer is to be added under a reseller, set the hierarchy path to the reseller.

  3. Go to (default menus) Customer Management > Customers.

  4. On the Customers page:

  5. Fill out or update the fields on the page:

Field Description
Customer Name

Mandatory. The name of the customer.

Note that when Create Local Admin is selected, any spaces in the customer name are converted to underscores in the Customer local administrator name and email.

(Provider deployment) A customer configured in HCM-F and synced in to VOSS Automate may exist at the sys.hsc hierarchy. If customer name matches this customer, the Migrate from HCM-F to VOSS Automate checkbox is displayed. Click Save to migrate this customer to the current hierarchy. Fields are populated with the values configured in HCM-F. If you don't want to migrate the customer, enter a different customer name.
Description Customer description
Extended Name (Provider)

Descriptive name for the customer, used by external clients to correlate their own customer records with customer records stored in HCS. Extended name value is synced to the customer record in the Shared Data Repository (SDR).

Extended Name is not referenced by other components in HCS.
External Customer ID (Provider) External customer ID used by the Service Inventory service, and included as a column in the customer record of the service inventory report. Specify an External Customer ID in this field that matches the customer ID used by the external inventory tool that receives the Service Inventory reports. If the Service Inventory service is not being used, this field is not required. However, it can be used to correlate customer records in external systems with customer records in HCS.
Domain Name

Customer domain. This field is used to create email addresses for:

If the customer domain is omitted, the provider domain (or reseller domain, if the customer is under a reseller in the hierarchy and the reseller domain was provided) is used instead.
Public Sector Set the Customer as a Public Sector customer. Used for License Reporting.
Inactive Billing Exclude customer from billing (for testing). Used for License Reporting.
Field Description
Create Local Admin Defines whether a default local administrator is created for the customer.
Cloned Admin Role The Provider or Reseller role used to create a new role prefixed with the customer name. The created customer role, shown in the Default Admin Role field, is assigned to the default local administrator user. This field appears only if the Create Local Admin checkbox is selected.
Default Admin Role The created customer role that is assigned to the default local administrator. This field is read-only, and appears only if the Create Local Admin checkbox is selected.
Default Admin Password The password to assign to the default local administrator. This field appears and is mandatory only if the Create Local Admin checkbox is selected.
Repeat Default Admin Password Confirm the default local administrator password. This field appears and is mandatory only if the Create Local Admin checkbox is selected.
Field Description
Account ID The Account ID is used by external clients to correlate their own customer records with the customer records stored in HCS. This Account ID value is synced to the Customer record in the Shared Data Repository.
Deal IDs Deal IDs are used by the Hosted License Manager (HLM) service which can be activated on the Hosted Collaboration Management Fulfillment (HCM-F) server. HLM supports Point of Sales (POS) report generation. The report includes all customers on the system with aggregate license consumption at customer level. The optional Deal ID field associated with the customer is included in the report. Each customer can have zero or more Deal IDs. The Deal ID field is free text format and each deal ID is separated by a comma.
Prime Collaboration

Prime Collaboration is the application which monitors equipment used by this customer. Available Prime Collaboration applications must first be configured using the HCM-F User Interface. Then HCM-F synchronization must be executed on VOSS Automate. After the HCM-F data syncs into VOSS Automate, available Prime Collaboration applications will appear in this drop-down. Select an available Prime Collaboration application to monitor Unified Communications applications and customer equipment configured for this customer.

To un-associate Prime Collaboration for this customer, choose None.
Shared UC Applications Indicates whether the customer can use Shared UC Apps. If selected, the customer sites can use Network Device Lists that contain Shared UC Apps. Shared UC Apps are UC Apps that are defined above the Customer hierarchy level.
Disable Number Management

Enable or disable Number Management for this customer.

  • If selected, you cannot add Directory Numbers and E164 Numbers to inventories for this customer.
  • If not selected, you can add Directory Numbers and E164 Numbers to inventories for this customer.

  1. If you enable Number Management for a customer after it was disabled, run the DN Audit Tool. See Run the Directory Number Inventory Audit Tool.

  2. Click Save.

    Note

    When deleting a customer, remove any entities associated with the customer, such as LDAP, SSO providers, Devices, and NDLs.

This relation joins the HcsVossCustomerDAT with other VOSS and SDR customer models.

Model Details: relation/HcsCustomerREL

Title Description Details
Name * Customer's name
  • Field Name: name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[A-Za-z0-9_\- ]+$
Directory Domain Customer's directory domain name
  • Field Name: directoryDomain
  • Type: String
  • MaxLength: 1024
Shared UC Applications Indicates whether the Customer shares UC Application instances Default: false
  • Field Name: shared_uc_apps
  • Type: Boolean
  • Default: false
Create Local Admin Indiates whether or not an Admin User should be created Default: true
  • Field Name: create_admin
  • Type: Boolean
  • Default: true
Hierarchy Path Customer entity's hierarchy
  • Field Name: HierarchyPath
  • Type: String
  • MaxLength: 1024
Migrate from HCM-F to CUCDM Migrate HCM-F Models to CUCDM Models Default: false
  • Field Name: migrate
  • Type: Boolean
  • Default: false
Disable Number Management Disables number management Default: false
  • Field Name: disableNumMgmt
  • Type: Boolean
  • Default: false
Public Sector Default: false
  • Field Name: publicSector
  • Type: Boolean
  • Default: false
Inactive Billing Default: false
  • Field Name: inactiveBilling
  • Type: Boolean
  • Default: false
Misc Data Miscellaneous data used at run-time
  • Field Name: misc_data
  • Type: String
  • MaxLength: 1024
Hcs Customer
  • Field Name: hcsCustomer
  • Type: Object
id
  • Field Name: hcsCustomer.id
  • Type: String
  • MaxLength: 1024
Short Name *
  • Field Name: hcsCustomer.shortName
  • Type: String
  • MaxLength: 64
Extended Name
  • Field Name: hcsCustomer.extendedName
  • Type: String
  • MaxLength: 128
External Customer ID
  • Field Name: hcsCustomer.externalCustomerID
  • Type: String
  • MaxLength: 128
Deal ID Info
  • Field Name: hcsCustomer.dealIDInfo
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: hcsCustomer.description
  • Type: String
  • MaxLength: 128
Account ID
  • Field Name: hcsCustomer.accountID
  • Type: String
  • MaxLength: 64
Contact Name
  • Field Name: hcsCustomer.contactName
  • Type: String
  • MaxLength: 128
Contact Address1
  • Field Name: hcsCustomer.contactAddress1
  • Type: String
  • MaxLength: 128
Contact Address2
  • Field Name: hcsCustomer.contactAddress2
  • Type: String
  • MaxLength: 128
Contact City
  • Field Name: hcsCustomer.contactCity
  • Type: String
  • MaxLength: 64
Contact State
  • Field Name: hcsCustomer.contactState
  • Type: String
  • MaxLength: 64
Contact Post Zip
  • Field Name: hcsCustomer.contactPostZip
  • Type: String
  • MaxLength: 32
Contact Country
  • Field Name: hcsCustomer.contactCountry
  • Type: String
  • MaxLength: 32
Contact Phone Number
  • Field Name: hcsCustomer.contactPhoneNumber
  • Type: String
  • MaxLength: 64
Contact Email
  • Field Name: hcsCustomer.contactEmail
  • Type: String
  • MaxLength: 128
CUOM
  • Field Name: hcsCustomer.cUOM
  • Type: String
  • Target: /api/data/HCSHcmfCUOMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24IoNbeDGnnzhBvPnY%24Mu/eSBqSNnC115z5fuEb34qoCWrhTgLZvHWirxVDE797Z9rjB6Pa1wVcmJ7qYmPXDwD94mBYEeju/azjXwNrC1TjuumKNeC%2BmfYwwFHMt5FzuYWFtlMQJgaMNVVAoiBwidl6TJPuN0JrBTTQBaBKXUBfmqhN5cHrTU2QttPOYObcRIpzcz/kvm7MrEcmEMOpTNVIwmmzukjiN%2BhmTuxkwgfOQPOz%2BJBb70m0b9kmQOlbk6orNBwtcw%2Bee6GZ0vSza3%2BfaChbh1/fIJyggvCfn7Tn8XtfC2P/ub/UiYPd3P9wx%2B2p/7IKhecQ4IoMQsgUzzIEJFaknJu6yBz5VFKXqE/5zcr0DINundbLopqFTSITMSKl%2BQ%3D%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfCUOMDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
ELM
  • Field Name: hcsCustomer.eLM
  • Type: String
  • Target: /api/data/HCSHcmfELMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24t2LSMm7eFFw12S4H%24Xp6HA32FD5o8s7LAa4VOg6XSzFrh%2Bo/Y8oI/HozwEAzvCz1dwcpgsjKEaVykO30lrE%2BFpyXfIsUk0uWzcntiMY%2BtHNJsw1%2BcIsc9j/9foSk8xgrf7hOjJe/vUD2kXmXNGNlChaUd2dAdAwy5l7x4VWKg%2BS3KFp23qx3B9/n1S1EX7f6BhDPQ9tRKvfwzvRt5mjqAc4dR3osq%2BeFd0PheSYnR3kqKlOuO%2Bt0LXfHmdpkWq5/5ayJtB46lCWVbYU1hlUFtJKDiXi877OycdtkGVK2NaHmH4LNhufhm51eiWqADGXy69h4oPgvzKJSUhjB%2BZKSpRUhh49nKjYz3dCfKJkGegu3JKJucqR87pLNGHTxx/CDp%24%3D%3D
  • Target Model Type: data/HCSHcmfELMDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
CUCDM
  • Field Name: hcsCustomer.cUCDM
  • Type: String
  • Target: /api/data/HCSHcmfCUCDMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24UCUD8vmmyzK2ciLo%24/%2BSrj2CxSjs9ew5I87HLON4Se4KYp8bljHqXI8Tb2Hi/ldZvcqEOxvaQug%2Bmf0uvEhAt%2B21fy8KpPl2KC9S0YYR4UW5kiDojEmo2Au8mS6lAtFy6lIEurobkoFuflHmrWlA%2BcvYk7YOC6T6PndqhCba/PAUz0I47QkNDvLfSr6UZ8SiqmYIYQe2KI1Xj3BI3tK/pMiCgIsQvvUyVx0Q8fXSFI7GUh3sF0Va2JZA6F82F8kA0gVBaUapvUJp0LTs80zQU3h%2BvFUstuUG1H5BVqFJ30UvimsMzgzO/bGOIQ/s7jAP1XNpMD8h/Il4ILxBtBe%2BI6yxM14wggUEKpBI/A1ks28gqwv/AuBBI8p6GRDERacuV2gc%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfCUCDMDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Service Provider *
  • Field Name: hcsCustomer.serviceProvider
  • Type: String
  • Target: /api/data/HCSHcmfServiceProviderDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%2490D83JQCwbv2iKpw%24I7xOziL/MRtNYPOXSgtwqZXmjxI2v9ISM//zs1hJ1pMMfIfUJcwe2nTZqlZcdLfCjxaFchj/OAcGrneVMpbLTFGsKhHiPbVEh2y2SVEaBdtVSt66olB6b778cjKV49SSayF9DTCzATPlxmP9y3ASp2V99J7/VSwpKMv7aLa22Wd%2BuGUBjvTRAXnM3fLOwBurLxBsODlIQX6m7DadflIqZuLVOVnvdE7ibvLI0sSL9gLWcq4tqlrjObjRoRfyVrj3iOgwso2shUWTjMaBya2P63nuqDv0aVlhEZyyo5Gns0OjelMj7DK/UEbuiUn9mjoosQ/jxBH/vNmBljXUcruvL%2BTWwrl/fU8Jl9XiQRIa8D6hlgMud/Us/uDnEv7VPDdz%24%3D%3D
  • Target Model Type: data/HCSHcmfServiceProviderDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
CCDM
  • Field Name: hcsCustomer.cCDM
  • Type: String
  • Target: /api/data/HCSHcmfCCDMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Rdw7EDi2QA1ez0Nk%24cVvovN0S0py0S6MUDS0nDfveKEBwAIOw%2B1wIOHNiOQzvm0P3dfbaMmMxW3gADHRsk6Rcfoo3yBQLzlTKTCnFpKVmVTcmZvGVFHW9cJ93vXQ1nSYIjJoSzH0dywFwHI0WOQeo25Nozzk9/7YtQPu4WU2UTAMwt9wyewFz7WkcSEe8BSs9fyP2Xqa%2BAMEj9xYtR/UBowcIi7%2Bkl2NG3C4KbvGWL7XHibZI9Vbb654GURFZCofhhpDGAl%2BqELI7HmRM1dZxXZsSbpD2OIun4ALA/NzkBmoQIUbpfr/tlskMJf6FtFD7AC6cZMwmf4Xb4U4WiVDQVWbGmAOKjQUGd8G%2BCurq6Cu2WsyXjCsGsRF/%2BdkWpESyPA%3D%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfCCDMDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
CUCDM2
  • Field Name: hcsCustomer.cUCDM2
  • Type: String
  • Target: /api/data/HCSHcmfCUCDM2DAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24LQTgoiwTwDd3FkjQ%244IhEQcr9KWdlN6ZsqWfiNxMl4UghlVDAlgCiFmKK1tja6%2BrSKj3G4WJ12nyswKDAg3P%2BwWaPgReLxxDsXSoso1vAolvR757YlMqTGzf5uAQXa5W2/9x8kEoiPv%2BswHBJBAIae%2B5cF%2B/MSMtfLSiUiEFwgQXaSsyiZKt2vjdNHEgdQcS2vdDfD2lUk9J64B%2B1mg06bB8PNBUy5YPRgBhFeOkHEV7O2TqlA2LuNTcng5G%2BCEAAAEdyzL5sQesyxZ7LPReso3wR4hDS0KXUzcr9IiPMD6Jr62BhpiWDeF9YP1jQv5VB2MpLFx/8ajfPGtvRVQjCFF1%2BUvCVJPSoeTCBED6yQv%2Baq950upDMgDQaP/tF/qQY%2BkuK%24%3D%3D
  • Target Model Type: data/HCSHcmfCUCDM2DAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Directory Domain
  • Field Name: hcsCustomer.directoryDomain
  • Type: String
  • Target: /api/data/HCSHcmfDirectoryDomainDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24XI8clAI5Eje4PJmR%24qW9v5zbJZ2UMjP%2BiKV3FLdr%2BxlOwtlwD54M966vxFEiO7pSmzghmEKxRp0hlPvyIogows3krBgIle3y%2BTPpfapkf5sdbJX8SYV2Zmbeo1rBhY5o4z8GY9lJ54d0agPq63DwHZpIevFY/4owodIYBQJ02m%2BSxrtbEc3rMOCqDRnqPeLSU7DqKck5oInEo8t8vXUL9XYEsuJNMJuvA4c5ZmbRn7mPYra6ZFb63PHQ4q6zGH3a0dhrNAoNKI6jerjNiiKfTe6/ZnGzGDqypqp3iFhv%2BmUW4kDc9H8cUHx262w4MWI3XdThkf6omVVOGx4N8sVP2OQJ9lXW9j6eV%2BXSbsEtYYpjRiIXV3ZoQfOI5tGRZ2GH93Jn%2BehfYYQXH4Zin%24%3D%3D
  • Target Model Type: data/HCSHcmfDirectoryDomainDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Owns CTX
  • Field Name: hcsCustomer.ownsCTX
  • Type: String
  • Target: /api/data/HCSHcmfCTXDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24gwJGrr6NAQlf5Pad%24vQ7vsjUVzrYE%2Bax7j1OvrQNIu5Cu5a4TJJZ3C3YFQU/jC83gT3EVqW0SnTBpE3RYuvfzetej9b3/cYgiAWyVZiL59xs7teso4P%2BdetMu6hdUip6y0AoHYcw0mrP2zQLWzZ9WeTJOkacKzInF3ghH5bDPCamcwuYXXW5sH6gxnwVB2ARbaDoGPE2wkdS0U73N/bc6MVm1EoRMiRWOvdblc89hDfEK3i0CWpSB1YWAE6IT9EZua6xLaCqYnXVAelmTMqpU3MHUenAUuJs6g/VcxfPAeGepZnFYkk2ToC2StxZD2Nry2O2JHFGeGTfk8V%2BG80QYbzMdMpoch5nUDFvk5oUXvicUTCAZXN%2ByRpW2iECspeIu%24%3D%3D
  • Target Model Type: data/HCSHcmfCTXDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Monitors Prime Collab
  • Field Name: hcsCustomer.monitorsPrimeCollab
  • Type: String
  • Target: /api/data/HCSHcmfPrimeCollabDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24qEmjHX4xNkydzLpn%244RuZ8hKOaDNu3kxsGoJBdY618QM77fof2OQ8ZEhp%2Bjxxv1pTSFG3kFg8w%2BHE%2BsOCCLvGZNJeKENb8sroVXOlxnBbgFRJ/aAcJUAtjOHmNr9/Ixl0DIwTS5q2qXidoVWLBr5dQBmVEZu/5j7lb%2B8m6mgEm9buZ/bfNi2lrGEz2zgsRoaOb8be/0dl2ihTG0vtUec6Zcaw7oxXpCnqGmB/OXvL2%2BT46HYa5yXMu6TGwLKyGpaiPAzSTAgKalYRFoSDrKlU6%2BpsF/RYh7QxuGGMulRL%2BR%2BNaLlKg88YmbSGNlcsVJyyGtaH9qg8vChZcBFovjpXwMd0F0dwoTWl8%2BfODtexP8Z5fvXgfhYjTPVXdwuP%2B4ONNm8XcG74IZE%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfPrimeCollabDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Reseller
  • Field Name: hcsCustomer.reseller
  • Type: String
  • Target: /api/data/HCSHcmfResellerDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Uq8K4mxHBTqkcevH%24ivWWnRlQBFwChn3ZYjvQE7dwGpGPXDY5J3SWnonqdqsde9tYux9Zp0reAc6m1maLZoB2JGP3GIKUr%2Bp6189F0gxZDfXlWw933He1jU3IF8jPi8litttZPC80VGxJkiNIVWIVsFgp9SolXogvoFSn9PRhQC3CT%2B0lW%2BafPz5mNZkRM0n4yK9TxW3bfZ/OMwjJXHrUarlcqv6J0qq3sSee4dJuq54O1FyDn12dXU01M2s/OCgPFk4bJsnEg79VGdglYSk5FrzHQ9rZ03ELIA6N5cfnxpbV5z9xcfRbcaSbvckIgM%2Bj8n%2BnXD6vAJi9D9%2BDPhFUiYo1UdXTwILJwrDhHl34v4apuQ3MlzlUO5ck%2Bz0NIKc0AOfivN8%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfResellerDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Uses CTX
  • Field Name: hcsCustomer.usesCTX
  • Type: String
  • Target: /api/data/HCSHcmfCTXDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24gwJGrr6NAQlf5Pad%24vQ7vsjUVzrYE%2Bax7j1OvrQNIu5Cu5a4TJJZ3C3YFQU/jC83gT3EVqW0SnTBpE3RYuvfzetej9b3/cYgiAWyVZiL59xs7teso4P%2BdetMu6hdUip6y0AoHYcw0mrP2zQLWzZ9WeTJOkacKzInF3ghH5bDPCamcwuYXXW5sH6gxnwVB2ARbaDoGPE2wkdS0U73N/bc6MVm1EoRMiRWOvdblc89hDfEK3i0CWpSB1YWAE6IT9EZua6xLaCqYnXVAelmTMqpU3MHUenAUuJs6g/VcxfPAeGepZnFYkk2ToC2StxZD2Nry2O2JHFGeGTfk8V%2BG80QYbzMdMpoch5nUDFvk5oUXvicUTCAZXN%2ByRpW2iECspeIu%24%3D%3D
  • Target Model Type: data/HCSHcmfCTXDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Northbound Adjacencies
  • Field Name: northboundAdjacencies.[n]
  • Type: Array
Clusters
  • Field Name: clusters.[n]
  • Type: Array
Uses TM Ss
  • Field Name: usesTMSs.[n]
  • Type: Array
Uses TS Virtuals
  • Field Name: usesTS_Virtuals.[n]
  • Type: Array
Uses TS Hardwares
  • Field Name: usesTS_Hardwares.[n]
  • Type: Array
Uses MC Us
  • Field Name: usesMCUs.[n]
  • Type: Array
Uses CTM Ss
  • Field Name: usesCTMSs.[n]
  • Type: Array
Uses IV Rs
  • Field Name: usesIVRs.[n]
  • Type: Array
Uses TS Supervisors
  • Field Name: usesTS_Supervisors.[n]
  • Type: Array
Uses VPG Ws
  • Field Name: usesVPGWs.[n]
  • Type: Array
Hcs Role
  • Field Name: hcs_role
  • Type: Object
Name
  • Field Name: hcs_role.name
  • Type: String
Role * The role selector.
  • Field Name: hcs_role.clonedRole
  • Type: String
  • Choices: [" "]
Role * The role selector.
  • Field Name: hcs_role.role
  • Type: String
  • Choices: [" "]
Data User
  • Field Name: data_user
  • Type: Object
Name
  • Field Name: data_user.name
  • Type: String
Password
  • Field Name: data_user.password
  • Type: String
  • Is Password: True
Data User
  • Field Name: dataUser
  • Type: Object
User Name * User's Username.
  • Field Name: dataUser.username
  • Type: String
Email Address The User email address.
  • Field Name: dataUser.email
  • Type: String
First Name The User first name.
  • Field Name: dataUser.first_name
  • Type: String
Last Name The User last name.
  • Field Name: dataUser.last_name
  • Type: String
Password The User password.
  • Field Name: dataUser.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: dataUser.role
  • Type: String
  • Target: /api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%247B1rHfl2RFfPwKvc%24KK3RXs85m0qkUXAqpCEJbolxF%2BrHI8M3WvRT5ZrVFaOT6sPaHx3s5/U90pjnp5b16FxCruZeEd3r8Rs4fwDxkJGoOehlzr9AJuWFvUIUeG4EyVVvMxWIwCOL8UeQOuRoD2RBInIgCFTUkXpLPJ3t%2B8kX98Sd4Mdnco6SUfDi0bdzZWbSgYHQgQLSyNpQMmKLZd79XnN1oOp%2BXtrv/CzHCFM9tfJN1gMQVY78Ob7PAmrRh7z/RrCkWB69dp/A8DSKkqjnaph2GpN0dHodHnHeEm4qiC%2BSC%2B7eGvQfpGT3l/rUqN/UWdWqLubbcGPKY/KqCzDRi2CK8KmQGY22UdpnYTxD6wXipoNeqj/GYS6od0rxK5iu6to%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/Role
  • Format: uri
  • Choices: []
Language The preferred language for this user. Default: en-us
  • Field Name: dataUser.language
  • Type: String
  • Target: /api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24qKpwhGkb3xst12nK%24zqCTDRilO4njwRwL7WP8ieoFzyn3f5Y4mZyZMOQPUf84rgYXRUM7h8FN8SSfsR7ef/s5TDOgRhgNeEEqhm/gv5Iyi7kx6wOCIU/4Ur5gclpp229jaBf/hlaMu9EsfWUPU8HMkXVlNXLM9Tq8LEmaHWEk3/5S8p/fisiFd0Wj5NOeq7vsTa1Gr4YpQQofCndhjMNUp9vbw/GdkZ6xkv/zqFXshTqII%2BPc8jchfMIy3KU2wCio7uttgVk/csE0nAtfUYk9QuPekTZ8BNodzWLFAmynVXVUuTNiyYYVmKvN/dV04ejCbSULr0eOYAvJDCo3lSNZ0IJVR7fHrXHCrsgRBIsV8HtFJRhjpkef3xeICC49EVb3GfedAR8q%24%3D%3D
  • Target attr: lcid
  • Target Model Type: data/Language
  • Default: en-us
  • Format: uri
  • Choices: []
Set by Default Language Indicate if the user's language is set by language default in the hierarchy.
  • Field Name: dataUser.set_language
  • Type: Boolean
Account Information Additional account information for the given user.
  • Field Name: account_information
  • Type: Object
Change Password on Next Login Indicates if the user must be forced to change their password the next time that login.
  • Field Name: dataUser.account_information.change_password_on_login
  • Type: Boolean
Locked Indicates if the account has been locked to prevent the user from logging in.
  • Field Name: dataUser.account_information.locked
  • Type: Boolean
Disabled Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.
  • Field Name: dataUser.account_information.disabled
  • Type: Boolean
Reason for Disabled A description of why the account is disabled.
  • Field Name: dataUser.account_information.reason_for_disabled
  • Type: String
Credential Policy Specifies the policy with the rules used to govern this user's credentials.
  • Field Name: dataUser.account_information.credential_policy
  • Type: String
  • Target: /api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24vq9fa0BPlUixvD33%24gcpiC4FI6wzl6YrErDDZy9UoY3lQVYH9w7lTaIQU3YcIBsQ%2B/bxcgs0Bh4brDSZ1iQEdlXG4tpjjirCE3eNwtbjjCyL4agsUAM87Xuxyy6F6IQolmiJG2PpY3gW4uDt49wxdhGdrLr2dUJkvcd7yPqdfho8jdossMzG%2BVn8azyYgOnmCbuoDnwx0nYjM68Q2dh9ZMCeJdPTJCYn0A5g5EPv2t7OgUTwlE0ZIb0qDzxAz2IPVieg2A8STJOl19ZiKGDfWctaghFqzs1bcQAoOKRpxd%2BdTP2Vz3UguLnb7fDAqrYNpuvr%2Bo8rJosbpffQ9kweZ1J%2BOQmfYcpdMD3Wl5MKOYiflhcFDxt0w9XzDyaALs9Eh5znpOOr9k1njD6A6c8s%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/CredentialPolicy
  • Format: uri
  • Choices: []
Time Locked Due to Failed Login Attempts The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.
  • Field Name: dataUser.account_information.failed_login_lock_date
  • Type: String
  • Format: date-time
Time of Last Password Change The time when the password was last changed.
  • Field Name: dataUser.account_information.password_last_change_time
  • Type: String
  • Format: date-time
Time of Last Password Change By User The time when the password was last changed by the user.
  • Field Name: dataUser.account_information.password_last_change_time_by_user
  • Type: String
  • Format: date-time
Time of Last Successful Login The time the user last logged in successfully.
  • Field Name: dataUser.account_information.last_login_time
  • Type: String
  • Format: date-time
Number of Failed Login Attempts Since Last Successful Login The total number of failed login attempts since last successful login. Default: 0
  • Field Name: dataUser.account_information.num_of_failed_login_attempts
  • Type: Integer
  • Default: 0
Security Questions
  • Field Name: security_questions.[n]
  • Type: Array
Question *
  • Field Name: dataUser.account_information.security_questions.[n].question
  • Type: String
  • MaxLength: 128
Answer *
  • Field Name: dataUser.account_information.security_questions.[n].answer
  • Type: String
  • MaxLength: 128
Used Passwords List of passwords that have been used by user.
  • Field Name: used_passwords.[n]
  • Type: Array
Password Used password
  • Field Name: dataUser.account_information.used_passwords.[n].password
  • Type: String
Time Created Time when password was created.
  • Field Name: dataUser.account_information.used_passwords.[n].time_created
  • Type: String
Entitlement Profile
  • Field Name: dataUser.entitlement_profile
  • Type: String
  • Target: /api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fqnewD1fS1zpuE5k%24K4aMB8yjp2jm6O8BdNlBfiLIIYjKQhhXUglU/c9sc87HcVls0iEyJYTMfEGZYftkPeiiQSxCad76bm9xFfXlT%2BdDZfIN9KnQefSNGmnWYRftA5vMTZmxgBTJYHk8QYhOUVqOlKP0hwd/esVuFiHObCVbnaZV32WdPEh/NxaCmVMBQCtGmXVqdQAPDqvNso0lsc%2BrQ54AL/x2Xsl/UI70WcVdxtcLCpJIo9FQl6CV%2BcYZV3t31WiAl4gxhFNsMFPcwA9UYLnryT/E4f%2BpGwMYlzzRmAlxrG7Hjojfl4rF5ZcXMNZ%2BCkAF10ncOYCsjKlw6a7NOTmTUZH4wbza4wa7PYrtODNrIDfH9f6eHvAk/WRV/f3cx0vWNgHzqBcIcSk%3D%24%3D%3D
  • Target Model Type: data/HcsEntitlementProfileDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Sync Source Sync source of the user. Identifies where the user was synced from. This value will determine the master of the data. The data in the User model will be derived from the fields of the master application (E.G. CUCM, CUC, MS-LDAP). Default: LOCAL
  • Field Name: dataUser.sync_source
  • Type: String
  • Target: /api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24CVIGX2wj7qwp4LmX%24QatKN%2BNY25lHM63/p0hmCGp0ab/ExpyMhURoaP2uAAA/fvE9htX9i5DNfax0If54DOF4kx2HjInfo7eMBLuYbLgDtef7q8C90o/96UD9jSVsP4rCCpUsPXMc7gCO8XYzckRSH921gBe0DVYYlIKjLiKvnIUFsZpzm%2B5psMf4X6gp8bPgDyh/L/rgsmb0NJi1aLsTU6LBPLj4fVMWY1sTrSsRPILCKqnzV3m19ORAvOs/%2Bu6kwm/yRFKmf3np9BjtCrGdN3W/9xq0AiplaOxLC5APpNt1sM/yYtfSNcFML44AjZDGDGyjESYvTXFXvN1r4JunePzzGR09ZUfXJpRpzaRJfxxySGNiDFLdCglvGhnJ8iYxTnqSOXrHlA3VIK8k%24%3D%3D
  • Target attr: name
  • Target Model Type: data/UserSyncSource
  • Default: LOCAL
  • Format: uri
  • Choices: []
Sync Type Sync type of the user. Identifies the user type that was synced from device as indicated by Sync Source information, e.g. CUCM-Local, CUCM-LDAP, LOCAL. Default: LOCAL
  • Field Name: dataUser.sync_type
  • Type: String
  • Default: LOCAL
Building Name Building name or number.
  • Field Name: dataUser.building_name
  • Type: String
Country Country name.
  • Field Name: dataUser.country
  • Type: String
Department Department names and numbers.
  • Field Name: dataUser.department
  • Type: String
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: dataUser.directory_uri
  • Type: String
Display Name Display name of the user
  • Field Name: dataUser.display_name
  • Type: String
Employee Number Employee number of the user
  • Field Name: dataUser.employee_number
  • Type: String
Employee Type Employee type
  • Field Name: dataUser.employee_type
  • Type: String
Facsimile Telephone Number Contains strings that represent the user's facsimile telephone Number(s).
  • Field Name: facsimile_telephone_number.[n]
  • Type: Array
Home Phone Contains strings that represent the user's home phone number(s).
  • Field Name: home_phone.[n]
  • Type: Array
IP Phone Contains strings that represent the user's IP phone number(s).
  • Field Name: ip_phone.[n]
  • Type: Array
Jabber ID Jabber ID
  • Field Name: dataUser.jabber_id
  • Type: String
City Contains the name of a person's locality.
  • Field Name: dataUser.city
  • Type: String
Manager Manager.
  • Field Name: dataUser.manager
  • Type: String
Member Of The user can be a member of a variety of groups.
  • Field Name: member_of.[n]
  • Type: Array
Mobile Contains strings that represent the user's IP mobile number(s).
  • Field Name: mobile.[n]
  • Type: Array
Organization The name of the person's organization.
  • Field Name: dataUser.organization
  • Type: String
Object Class
  • Field Name: object_class.[n]
  • Type: Array
Other Mailbox
  • Field Name: other_mailbox.[n]
  • Type: Array
Organizational Unit The name of the person's organization unit.
  • Field Name: ou.[n]
  • Type: Array
Photo URL Photo URL.
  • Field Name: dataUser.photo_url
  • Type: String
Physical Delivery Office Name Physical Delivery Office Name.
  • Field Name: dataUser.physical_delivery_office_name
  • Type: String
Postal Code Contains code used by a Postal Service to identify postal service zones.
  • Field Name: dataUser.postal_code
  • Type: String
Preferred Language Preferred Language.
  • Field Name: dataUser.preferred_language
  • Type: String
State Contains full names of state or province.
  • Field Name: dataUser.state
  • Type: String
Street Contains site information from a postal address.
  • Field Name: dataUser.street
  • Type: String
Telephone Number Telephone Number.
  • Field Name: telephone_number.[n]
  • Type: Array
Timezone Timezone.
  • Field Name: dataUser.timezone
  • Type: String
Title Title.
  • Field Name: dataUser.title
  • Type: String
Unverified Mail Box Unverified Mail Box.
  • Field Name: dataUser.unverified_mailbox
  • Type: String
Custom String 1 Custom String
  • Field Name: dataUser.customString1
  • Type: String
Custom String 2 Custom String
  • Field Name: dataUser.customString2
  • Type: String
Custom String 3 Custom String
  • Field Name: dataUser.customString3
  • Type: String
Custom String 4 Custom String
  • Field Name: dataUser.customString4
  • Type: String
Custom String 5 Custom String
  • Field Name: dataUser.customString5
  • Type: String
Custom String 6 Custom String
  • Field Name: dataUser.customString6
  • Type: String
Custom String 7 Custom String
  • Field Name: dataUser.customString7
  • Type: String
Custom String 8 Custom String
  • Field Name: dataUser.customString8
  • Type: String
Custom String 9 Custom String
  • Field Name: dataUser.customString9
  • Type: String
Custom String 10 Custom String
  • Field Name: dataUser.customString10
  • Type: String
Custom List of Strings 1 Custom List of Strings
  • Field Name: customListOfStrings1.[n]
  • Type: Array
Custom List of Strings 2 Custom List of Strings
  • Field Name: customListOfStrings2.[n]
  • Type: Array
Custom List of Strings 3 Custom List of Strings
  • Field Name: customListOfStrings3.[n]
  • Type: Array
Custom List of Strings 4 Custom List of Strings
  • Field Name: customListOfStrings4.[n]
  • Type: Array
Custom List of Strings 5 Custom List of Strings
  • Field Name: customListOfStrings5.[n]
  • Type: Array
Custom List of Strings 6 Custom List of Strings
  • Field Name: customListOfStrings6.[n]
  • Type: Array
Custom List of Strings 7 Custom List of Strings
  • Field Name: customListOfStrings7.[n]
  • Type: Array
Custom List of Strings 8 Custom List of Strings
  • Field Name: customListOfStrings8.[n]
  • Type: Array
Custom List of Strings 9 Custom List of Strings
  • Field Name: customListOfStrings9.[n]
  • Type: Array
Custom List of Strings 10 Custom List of Strings
  • Field Name: customListOfStrings10.[n]
  • Type: Array
Custom Boolean 1 Custom Boolean
  • Field Name: dataUser.customBoolean1
  • Type: Boolean
Custom Boolean 2 Custom Boolean
  • Field Name: dataUser.customBoolean2
  • Type: Boolean
Custom Boolean 3 Custom Boolean
  • Field Name: dataUser.customBoolean3
  • Type: Boolean
Custom Boolean 4 Custom Boolean
  • Field Name: dataUser.customBoolean4
  • Type: Boolean
Custom Boolean 5 Custom Boolean
  • Field Name: dataUser.customBoolean5
  • Type: Boolean
Custom Boolean 6 Custom Boolean
  • Field Name: dataUser.customBoolean6
  • Type: Boolean
Custom Boolean 7 Custom Boolean
  • Field Name: dataUser.customBoolean7
  • Type: Boolean
Custom Boolean 8 Custom Boolean
  • Field Name: dataUser.customBoolean8
  • Type: Boolean
Custom Boolean 9 Custom Boolean
  • Field Name: dataUser.customBoolean9
  • Type: Boolean
Custom Boolean 10 Custom Boolean
  • Field Name: dataUser.customBoolean10
  • Type: Boolean
Auth Method The type of authentication that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user. Default: Local
  • Field Name: dataUser.auth_method
  • Type: String
  • Default: Local
  • Choices: ["Local", "Automatic", "LDAP", "SSO"]
LDAP Server A reference to the LDAP server which this user must authenticate against.
  • Field Name: dataUser.ldap_server
  • Type: String
  • Target: /api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%242k5y5CtK2rvnXbf0%24zdbhV9AALvjl2C1Fxrj7nP5f/8gtd2CssLMPlAN8KxcEI9%2BNucirk/hmBWe3UofQRE1o7HTV0MVRU4qdbzmOq%2BqDOFNBoPuEg/i%2BaoOT9tEThdPkYMFyeXFQO1DB8F960ei0hbz1T940Eh/9jTvdzMlAVH/9Mppfw9KRcqJHiIwcFiBtHJEgKNpn6gf0YV7XSgGIzBeY51O4XAGU7uSebRYBJPD9i6VZF4/SoKIyjYXkPlEQQALjdBR4vKPJeunqUN64c2L7VE0caFWwaukhwhWOfE/KwPWx%2BdLNbiUUgfC%2BNt%2BHEZj3jrtjtab5VzsQRPvYYUOdE50XoOeJudgCFuytJyqfF4Vvsr81%24%3D%3D
  • Target Model Type: data/Ldap
  • Format: uri
  • Choices: []
LDAP Username The login attribute of the associated LDAP device model instance
  • Field Name: dataUser.ldap_username
  • Type: String
SSO Identity Provider The entity id of the SSO Identity Provider.
  • Field Name: dataUser.sso_idp
  • Type: String
  • Target: /api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24V84uNQpfPlI8fGb6%24RK0daKrNO5nI2VKGCJDe0UKd1Jx3SmJNvH8heH067%2BGWBMPhB1iI39/sdtqH5YgVFAtbTxVdlEgKdB6aqy22/kCosl9umDlKlnI3pv7Q6yxVtB%2BwBRfXj5ep5MKmDX5U5NcUsFw8%2BZfc11B7P1VKtKxInher/Yird2%2B0S9X3z1Xspg2uRYpgFCg8wFSMui90bfF5ObFlnZCBaV/GNeMrFpOykTEq3iXgI%2B6KHn8oQjYIRIQgb9ImqDsctiIyCn6RoxIo4YC7JsXmvQR1tw7FBhZG7f8VhxK7LruYO9dvO5rmyGMOXKSVgStG7cqPkzcz2O7r5c/qon6VqMWm7F61HW0dn2cviSxfJy6Qcg5NjXKSujHqMgfvP2dp4ZUuocymvRawmUNvXp5Luw%3D%3D%24%3D%3D
  • Target attr: entity_id
  • Target Model Type: data/SsoIdentityProvider
  • Format: uri
  • Choices: []
SSO Username The name identifier that is used for an SSO authenticated user.
  • Field Name: dataUser.sso_username
  • Type: String
User Type Indicate the user's login type. Default: Admin
  • Field Name: dataUser.user_type
  • Type: String
  • Default: Admin
  • Choices: ["Admin", "End User", "End User + Admin"]
Exclude from Directory Exclude from Directory flag to control the Phone Services directory lookup. If set to true the User's phone number will not appear in the directory lookup.
  • Field Name: dataUser.exclude_from_directory
  • Type: Boolean
Hybrid Status
  • Field Name: dataUser.mvs_hybrid_status
  • Type: String
Primary Line
  • Field Name: dataUser.mvs_primary_line
  • Type: String
Primary Class of Service
  • Field Name: dataUser.mvs_primary_line_cos
  • Type: String
Extensions Extensions to select primary details from.
  • Field Name: mvs_extensions.[n]
  • Type: Array
Line
  • Field Name: dataUser.mvs_extensions.[n].line
  • Type: String
Line E164
  • Field Name: dataUser.mvs_extensions.[n].line_e164
  • Type: String
Class of Service
  • Field Name: dataUser.mvs_extensions.[n].line_cos
  • Type: String
Avaya System Manager User Name The username corresponding to the the Username in Avaya System Manager.
  • Field Name: dataUser.username_avaya_system_manager
  • Type: String
Broadworks User Name The username corresponding to the the Username in Broadworks.
  • Field Name: dataUser.username_broadworks
  • Type: String
Cisco Unity Connection User Name The username corresponding to the the Username in Cisco Unity Connection.
  • Field Name: dataUser.username_cuc
  • Type: String
Cisco Unified Communication Manager User Name The username corresponding to the the Username in Cisco Unified Communication Manager.
  • Field Name: dataUser.username_cucm
  • Type: String
HCMF User Name The username corresponding to the the Username in Cisco HCMF.
  • Field Name: dataUser.username_hcmf
  • Type: String
LDAP Directory User Name The username corresponding to the the Username in the LDAP Directory.
  • Field Name: dataUser.username_ldap
  • Type: String
Microsoft User Name The username corresponding to the the Microsoft Username.
  • Field Name: dataUser.username_microsoft
  • Type: String
Microsoft Office 365 User Name The username corresponding to the the Username in Microsoft Office 365.
  • Field Name: dataUser.username_ms_365
  • Type: String
Microsoft LDAP User Name The username corresponding to the the Username in Microsoft LDAP.
  • Field Name: dataUser.username_ms_ldap
  • Type: String
Microsoft Teams User Name The username corresponding to the the Username in Microsoft Teams.
  • Field Name: dataUser.username_ms_teams
  • Type: String
Open LDAP User Name The username corresponding to the the Username in Opoen LDAP.
  • Field Name: dataUser.username_open_ldap
  • Type: String
Cisco Unified Contact Centre Express User Name The username corresponding to the the Username in Cisco Unified Contact Centre Express.
  • Field Name: dataUser.username_uccx
  • Type: String
Webex App User Name The username corresponding to the the Username in Webex App.
  • Field Name: dataUser.username_webex_teams
  • Type: String
Zoom User Name The username corresponding to the the Username in Zoom.
  • Field Name: dataUser.username_zoom
  • Type: String
Authorized Admin Hierarchy A reference an Authorized Admin Hierarchy instance that defines this user's administrative capabilities. This enables administrative capabilities for end users.
  • Field Name: dataUser.authorized_admin_hierarchy
  • Type: String
  • Target: /api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%245X7BJqMObKc9XaSj%24nUTiF9Zx%2B0DR1yGhpaiIKAzX7O8UNOSgiMMFIgEPEu1u3x2o/FpEwKnXecWIB5S6lIud0L/gfc8KK0O8b9vbiccfILCJT2AbTiPYyEd0oEmBPjMdcY8KDhMckhvZZugC9QMLcTJVkw523Bc7Pomcjtb2hzYzwsKoSFy8x9BY/R31vZfvelI807LRezmcR96s2DyauyiyvgnGfAovX9np/1Dlv7Z0S4QP/dRIu46IiDp8t0fYO2W1FXnYGIbBeN/ilb/AIWT0I%2BDdrcvNfSOl4LGye/Wb18CTgvs2AFXCbnLlkBOF8Wu/LjYpF/jQBaWqMar5yELS0wps311950c08K/IuOZTo2fCpjwrgDzo0IQqLVd96qpiGd0zz1epQvjtcOTKbSuHkoufkw%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/AuthorizedAdminHierarchy
  • Format: uri
  • Choices: []
Base Customer Dom
  • Field Name: baseCustomerDOM
  • Type: Object
Customer Name *
  • Field Name: baseCustomerDOM.name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[\w\ -]+$
Internal ID Default: "Auto Generated"
  • Field Name: baseCustomerDOM.InternalCustomerID
  • Type: String
  • Default: "Auto Generated"
Description
  • Field Name: baseCustomerDOM.Description
  • Type: String
Address Line 1
  • Field Name: baseCustomerDOM.Address1
  • Type: String
Address Line 2
  • Field Name: baseCustomerDOM.Address2
  • Type: String
Address Line 3
  • Field Name: baseCustomerDOM.Address3
  • Type: String
Customer ID
  • Field Name: baseCustomerDOM.CustomerID
  • Type: String
Base Customer Dat
  • Field Name: baseCustomerDAT
  • Type: Object
Customer Name *
  • Field Name: baseCustomerDAT.CustomerName
  • Type: String
  • MaxLength: 64
  • Pattern: ^[\w\ -]+$
Internal ID Default: "Auto Generated"
  • Field Name: baseCustomerDAT.InternalCustomerID
  • Type: String
  • Default: "Auto Generated"
Customer ID
  • Field Name: baseCustomerDAT.CustomerID
  • Type: String
Address Line 1
  • Field Name: baseCustomerDAT.Address1
  • Type: String
Address Line 2
  • Field Name: baseCustomerDAT.Address2
  • Type: String
Address Line 3
  • Field Name: baseCustomerDAT.Address3
  • Type: String
Description
  • Field Name: baseCustomerDAT.Description
  • Type: String
Hierarchy
  • Field Name: baseCustomerDAT.Hierarchy
  • Type: String