[Index]

Model: relation/HcsSiteREL

Sites

Full HTML Help

Overview

Sites (locations) are a node on the hierarchy (organization) structure of Automate and are created under customers.

Related topics

Add a site

This procedure adds a site.

Note

The system no longer automatically creates cloned roles when you add a hierarchy node. Automate roles are now all managed via the data/Role model and can be assigned directly without being cloned across hierarchies. See also Role-based dashboards and menus

If you have custom bulk loaders and need to carry out this automatic cloning task, add a new boolean field to the bulk load sheets and set to TRUE:

"name": "clone_admin_role"
"title": "Clone Admin Role"

To add a site:

  1. Log in as either provider, reseller, or customer admin.

  2. Set the hierarchy to the customer where you're creating the site.

  3. Go to the Site page.

  4. Click the Plus icon (+) to add a new record, then fill out site details and contact information:

    Field Description
    Site Name

    Mandatory. The name of the site.

    Note:

    Any spaces in the site name are converted to underscores in the site local administrator name and email, if the Create Local Admin check box is selected.

    You can't migrate a customer location to a site if the customer for the site is different than the customer associated with the customer location.

    When migrating a customer location to a site, an NDL is not selected for the site. You can set the NDL for the site later.
    Description The site description.
    Extended Name

    Provider deployments.

    External clients can use the extended name of the site if needed. This field is not used by other components within Cisco HCS.
    Field Description
    Internal ID Read only. Internal ID of the site.
    External ID

    Provider deployments.

    External clients can use the External ID of the site if needed. This field is not used by other components within Cisco HCS.
    Site ID Unique identifier for the site.
    Country Mandatory. The selected country determines the dial plan to download to the site when the dial plan is configured on the site.
    Network Device List Choose the network device list (NDL) containing the UC applications and Webex to be used by the site. Once an NDL is set for the site, it can't be removed from the site, nor can the NDL be changed to another NDL.
    Auto Push Users to CUCM

    Disabled by default.

    When enabled, users are automatically pushed to the CUCM associated with the NDL at the site.

    You can also edit the site after it's been created:

    • To automatically push users at the site to the CUCM
    • To execute auto push to CUCM when an NDL (with a CUCM) is added to the site
    • To execute auto push to CUCM when a CUCM is associated with the NDL at the site

  1. Click Save to create the site hierarchy node and location.

    If Auto Push Users to CUCM is selected:

Add custom fields to site configuration forms

Automate allows you to add up to ten custom string fields and up to 10 custom boolean fields to the field display policy you apply to the site model (relation/HcsSiteREL). This provides flexibility to add additional details for a site, if required.

The summary attributes in the Sites list view always display three boolean fields and three string fields, regardless whether they've been included in the FDP. If you wish to change the title of these fields in the summary attributes you can add a field override entry in the FDP.

When configuring a site (add or update), you may specify field values or use named macros to populate values for these fields.

Macros for custom string fields for relation/HcsSiteREL:

Macros for custom boolean fields for relation/HcsSiteREL:

The macros can be applied in workflows and configuration templates to reference the custom field values. For example, executing macro.BaseSiteDAT_custom_string_9 will return the value in the field where the macro is used.

Expose custom fields for "relation/HcsSiteREL"

  1. Log in to Automate as provider admin or higher.

  2. Create or update the customers data model field display policy:

  3. Update the menu layout to apply the field display policy:

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

    This allows the access profile changes to refresh so that you can view the updated menu layouts and field display policies you applied, including new custom fields.

Model Details: relation/HcsSiteREL

Title Description Details
Site Name *
  • Field Name: name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[\w\ -]+$
Site ID
  • Field Name: SiteID
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: Description
  • Type: String
  • MaxLength: 1024
Network Device List Reference
  • Field Name: ndlr
  • Type: String
  • Target: /api/data/NetworkDeviceList/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24bA7BT0ix10tXBdG8%24XxWD89NynqZEtMD8pnjfFaoBNFMwRDj1ffANFyJKuN%2BsZnWrFaoNucY3mI995OrDLJWK%2BriEVf93uCiuaaVBOPCHy1zX%2BzOCFwUyPmfqkVlzAYeRrgk0TSqd3f3mepYn5zemwMDsHYVM9jg01LF9n3Fpff1pbCXsDt77Gk2qTAqTHxJuX8MTZPgXdZqajMSYl/wUR1scf9znWlMV%2Bs1yJnwaFhKTf%2BuFB3rridensd1fn/HP4aorHt/aXxasLX3C72J0F7hChNnnz4//oMUjvC8UrE39vozRnfXHdfC6NYm8bM8AJnTYpKeDgrYTL9cWNSFWmcD7U9vtXJ5jwnywikbD0fuWtDHpNiOWg4XaPiEvsJYtRD3MPp0zcSBHiEEoGTCQZqB%2BGOJ7qTCiWpeWmucwi46SCqHRvPbgs4c%2BO5Xf4IKdOK6GtGMR58SdPaa1cKwd6jC4G6PWLr/2FfBu%2B%2B7gerM4lEQ3rDpzJZuPiDbOkts%3D%24%3D%3D
  • Target Model Type: data/NetworkDeviceList
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Address 1
  • Field Name: Address1
  • Type: String
  • MaxLength: 1024
Address 2
  • Field Name: Address2
  • Type: String
  • MaxLength: 1024
Address 3
  • Field Name: Address3
  • Type: String
  • MaxLength: 1024
City
  • Field Name: City
  • Type: String
  • MaxLength: 1024
State
  • Field Name: State
  • Type: String
  • MaxLength: 1024
Postal Code
  • Field Name: PostalCode
  • Type: String
  • MaxLength: 1024
Extended Name
  • Field Name: ExtendedName
  • Type: String
  • MaxLength: 1024
External ID
  • Field Name: ExternalID
  • Type: String
  • MaxLength: 1024
Internal ID Default: "Auto-generated value"
  • Field Name: InternalSiteID
  • Type: String
  • Default: "Auto-generated value"
  • MaxLength: 1024
Country
  • Field Name: Country
  • Type: String
  • Target: /api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24JLR2NqgWerKP7PVw%24CqSPpTEpYlSQv%2B98Jw75PcgSKvllE2w0Pawbbc7RD6FjmhlTVY6h0XgOcELkme7zCUjSZvJ5Mz4l9ulIzeuepFkRr%2B2oXr%2B92MNa%2BGmm%2BK/0nlWjAS2V7dK1XPgQwRpPxTdROJAaB1u3vYi0FHmvIeHajRp07kNoJgtWvpMUVQH/C2pCIgcD0h6MYmyox98arNAId0I6w3xhOdqHawPV3La02LNwsEQ9ozcT1TEbqoThxBcI9ASjd%2BzPiGglx9ZbeSIeDLrcQDQ%2Brx2O14ehoDvEatSYQ3ynFFhvCOsx2eP80cG4IrjDgm0SPcH%2Bn4FVuTJNKlufLPexxjAj9W2XoHikcsaEHO6C%2B6y3FKvgsOu4LP5/bRFSoP9PCYRMoXqLD%2B5B/4QhdbNVggzWioJsfL1OqhJFBnSbO2rAHev6aLlmlRmOcuqioPUAmhnp5%2Bq8%2BIPN1ZByPuM5IkGpx%2BE6dxr12y4p5ZD762vXi9cNcrUwHe2dhq3oB3b6oh0ugg%3D%3D%24%3D%3D
  • Target attr: country_name
  • Target Model Type: data/Countries
  • MaxLength: 1024
  • Format: uri
  • Choices: []
CUCDM 8.x Location ID Location ID as used in CUCDM 8.x DialPlan
  • Field Name: CUCDM8xLocID
  • Type: String
  • MaxLength: 1024
CUCDM 8.x Routing Identifier(RID) Routing Identifier(RID) value as used in CUCDM 8.x DialPlan
  • Field Name: CUCDM8xRID
  • Type: String
  • MaxLength: 1024
custom_string_1
  • Field Name: custom_string_1
  • Type: String
  • MaxLength: 1024
custom_string_2
  • Field Name: custom_string_2
  • Type: String
  • MaxLength: 1024
custom_string_3
  • Field Name: custom_string_3
  • Type: String
  • MaxLength: 1024
custom_string_4
  • Field Name: custom_string_4
  • Type: String
  • MaxLength: 1024
custom_string_5
  • Field Name: custom_string_5
  • Type: String
  • MaxLength: 1024
custom_string_6
  • Field Name: custom_string_6
  • Type: String
  • MaxLength: 1024
custom_string_7
  • Field Name: custom_string_7
  • Type: String
  • MaxLength: 1024
custom_string_8
  • Field Name: custom_string_8
  • Type: String
  • MaxLength: 1024
custom_string_9
  • Field Name: custom_string_9
  • Type: String
  • MaxLength: 1024
custom_string_10
  • Field Name: custom_string_10
  • Type: String
  • MaxLength: 1024
custom_boolean_1
  • Field Name: custom_boolean_1
  • Type: Boolean
custom_boolean_2
  • Field Name: custom_boolean_2
  • Type: Boolean
custom_boolean_3
  • Field Name: custom_boolean_3
  • Type: Boolean
custom_boolean_4
  • Field Name: custom_boolean_4
  • Type: Boolean
custom_boolean_5
  • Field Name: custom_boolean_5
  • Type: Boolean
custom_boolean_6
  • Field Name: custom_boolean_6
  • Type: Boolean
custom_boolean_7
  • Field Name: custom_boolean_7
  • Type: Boolean
custom_boolean_8
  • Field Name: custom_boolean_8
  • Type: Boolean
custom_boolean_9
  • Field Name: custom_boolean_9
  • Type: Boolean
custom_boolean_10
  • Field Name: custom_boolean_10
  • Type: Boolean
Hcs Site
  • Field Name: hcsSite
  • Type: Object
id
  • Field Name: hcsSite.id
  • Type: String
  • MaxLength: 1024
Short Name *
  • Field Name: hcsSite.shortName
  • Type: String
  • MaxLength: 128
Description
  • Field Name: hcsSite.description
  • Type: String
  • MaxLength: 128
Is Default Location
  • Field Name: hcsSite.isDefaultLocation
  • Type: Boolean
Extended Name
  • Field Name: hcsSite.extendedName
  • Type: String
  • MaxLength: 128
External ID
  • Field Name: hcsSite.externalID
  • Type: String
  • MaxLength: 128
Site Location Code
  • Field Name: hcsSite.siteLocationCode
  • Type: String
  • MaxLength: 128
Street Address1
  • Field Name: hcsSite.streetAddress1
  • Type: String
  • MaxLength: 128
Street Address2
  • Field Name: hcsSite.streetAddress2
  • Type: String
  • MaxLength: 128
Street Address3
  • Field Name: hcsSite.streetAddress3
  • Type: String
  • MaxLength: 128
City
  • Field Name: hcsSite.city
  • Type: String
  • MaxLength: 128
State
  • Field Name: hcsSite.state
  • Type: String
  • MaxLength: 128
Country
  • Field Name: hcsSite.country
  • Type: String
  • MaxLength: 128
Postal Code
  • Field Name: hcsSite.postalCode
  • Type: String
  • MaxLength: 128
Customer *
  • Field Name: hcsSite.customer
  • Type: String
  • Target: /api/data/HCSHcmfCustomerDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24uSkMrC11pQKBHZuz%244uGaFkf3CajjwQpaoD/EL27LhE79zs2kenxZ19nnG6MyzldbtuFtSX7G2tS9NSPHnAn%2BIXxWOQf5hceQMeVSyplZNsw4TchYuuEw/JKpibMIAeo5Xr8V2/PaJaQlFaJgyZ6PjKC%2BERkzFr4b3BAjMTYaI2Ak0diAitNlAlC57EESWKKrtfnwXQxtw2OAS9aaGWuVpw0v84G6LxU9TUuSI/Xmlvg5K4igEJODCOio8PBfpEJepeIaSlhx7mPCsZ1oq0mK77UCvjPO280sXjYYOCMCEqmVnM0o7gLEyeYEiA/ZmVrL12XitZz%2B9n1P0vjGpQygHT7SFyCMzVfyHCi4gMqZz58xE9mkw0Focse2ZcwE5soz273q%2B4Q0eMZOrHeKGdJ1NGoQtQdPhwWd9KAC/jj83epxZ8e99Tk6QsR6q74JLoHyxuT6VM/Zaj4In0jZnoX4jKUrbAw1%2BgzWPNMykwmCN6q5Yk17BrHd5gx%2B%2BCMrBVIo%24%3D%3D
  • Target Model Type: data/HCSHcmfCustomerDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Bk Customer Short Name
  • Field Name: hcsSite.bkCustomer_shortName
  • Type: String
  • Target: /api/data/HCSHcmfCustomerDAT/choices/?field=shortName&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24PynmgvHW3flK2l6q%24C5AqFpZToTjKdpTb5bEHYpYIzWJiwgDK9Yjlay03OitGI1dRAd5FcnoDxj3olJ%2BS2ayTTrAM71Z1THltE6wEvCNjSk8w%2BIsAK8cJcQvr1YSnHEYFW4vRzfScf/vSm4zTnGI5/fIC5IMRqMDyVtUUrAkv7makYRTzcz1Jg96wlg%2BojBlQheA0zTNqvMsxeamZktlW6N8BWXi7e5x2NJgii9WAhJDvK34oGPObC5xAX16AingduPVBSbb/SepHVfdKlExMgXzw9UP5WgmLhZu5mwT/vLKNJLdcZ8tOz30M1ee/JPhGB35qGBLwsMzSOwGpp5qZYRVDOkxw/%2BiHyAEKvxMjdo2XCClVJ0UBy2MwEM6R1WZ8TsZcuPHrenJMFpr/0SEwEqxulHxI33rfB1NyAwmQXm1WvEJHW4Vw7XnQo9E0JfR1t473%2BIuWZNLXJmNpngtEVp4Sna//tKUFhUUmDDhxjiX/AO2iQ84%2BP7/OPPsseHeInqaJMzV3zMViDeujjspj0A%3D%3D%24%3D%3D
  • Target attr: shortName
  • Target Model Type: data/HCSHcmfCustomerDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Site Ndlr
  • Field Name: siteNdlr
  • Type: Object
Name *
  • Field Name: siteNdlr.name
  • Type: String
  • MaxLength: 1024
Reference
  • Field Name: siteNdlr.reference
  • Type: String
  • Target: /api/data/NetworkDeviceList/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24bA7BT0ix10tXBdG8%24XxWD89NynqZEtMD8pnjfFaoBNFMwRDj1ffANFyJKuN%2BsZnWrFaoNucY3mI995OrDLJWK%2BriEVf93uCiuaaVBOPCHy1zX%2BzOCFwUyPmfqkVlzAYeRrgk0TSqd3f3mepYn5zemwMDsHYVM9jg01LF9n3Fpff1pbCXsDt77Gk2qTAqTHxJuX8MTZPgXdZqajMSYl/wUR1scf9znWlMV%2Bs1yJnwaFhKTf%2BuFB3rridensd1fn/HP4aorHt/aXxasLX3C72J0F7hChNnnz4//oMUjvC8UrE39vozRnfXHdfC6NYm8bM8AJnTYpKeDgrYTL9cWNSFWmcD7U9vtXJ5jwnywikbD0fuWtDHpNiOWg4XaPiEvsJYtRD3MPp0zcSBHiEEoGTCQZqB%2BGOJ7qTCiWpeWmucwi46SCqHRvPbgs4c%2BO5Xf4IKdOK6GtGMR58SdPaa1cKwd6jC4G6PWLr/2FfBu%2B%2B7gerM4lEQ3rDpzJZuPiDbOkts%3D%24%3D%3D
  • Target Model Type: data/NetworkDeviceList
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Data User
  • Field Name: data_user
  • Type: Object
Name
  • Field Name: data_user.name
  • Type: String
  • MaxLength: 1024
Password
  • Field Name: data_user.password
  • Type: String
  • Is Password: True
  • MaxLength: 1024
Hcs Role
  • Field Name: hcs_role
  • Type: Object
Name
  • Field Name: hcs_role.name
  • Type: String
  • MaxLength: 1024
Role * The role selector.
  • Field Name: hcs_role.clonedRole
  • Type: String
  • MaxLength: 1024
  • Choices: [" "]
Role * The role selector.
  • Field Name: hcs_role.role
  • Type: String
  • MaxLength: 1024
  • Choices: [" "]
Data User
  • Field Name: dataUser
  • Type: Object
User Name * User's Username.
  • Field Name: dataUser.username
  • Type: String
  • MaxLength: 1024
Email Address The User email address.
  • Field Name: dataUser.email
  • Type: String
  • MaxLength: 1024
First Name The User first name.
  • Field Name: dataUser.first_name
  • Type: String
  • MaxLength: 1024
Last Name The User last name.
  • Field Name: dataUser.last_name
  • Type: String
  • MaxLength: 1024
Local Password The User password.
  • Field Name: dataUser.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 1024
  • 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%24KolgBArioBahb7UJ%24BXlHl4pOLkAp7mhpkz5BhifyqgqPy2AwPAemF/vNONfWb5TsKsE0PyfaOIYE39d4oOGOzF8c8kg1S76pgsHoIRS5nadWmrJJlWHblUUF3Z6jEb9AF7QeL55kxvFrIx07jtPr3SYYJ/bFShZQGEJfNZNa3rxJLc99RsZmcEXsfPiIwm7h8S0N7RjEAmNqCXcBMQ%2Bh4CvJa0hkAsxYVe/976Iawmu2PUKYCcozUMtX6k1cJxImjP5AK8McEkpcYSJ/N57I%2BD/EnGblNV%2Brj1gpI85a7Pd66nR6Orw7Sstpvr%2BswdctsRFp%2Bm5s8Na9kaUQfODN9DxHNO0hJ/nW/uTuFA1l9vQfvEaQm82Auay8IJTZKAZ5/F/v3rnIPHBaWli8PlQaPXgm0cOT2Vc2dehXRq29aS8dSPh5ca2TK3mhPhW7hfzwYHz/OPpga3r1HFVG3TxA7WN3bPJ6jbmMBpJ7WUAELqjU1xcPt0SL5ElsM/UW%24%3D%3D
  • Target attr: name
  • Target Model Type: data/Role
  • MaxLength: 1024
  • 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%24IkepDdDmFHzObK3Q%24JOxofN%2BWieBCGDaQUc4hNWFA0dHEhKjs%2BpIvY1KZ56Gdb8EtsP1pwGB%2Bd1LsRhGRE67KHZXpjUjWR2k/o7TBjt3XEpzl%2BQ3j25j9TtfiMr4TMV6AJ3D%2BHy1Z/RgoEP05MZTbtrmcmd4RII%2BEdzIE7AM2QeOHyKaUB1eFm8zsSRRpdVBprUoZQrwX0U0KPqKdB/eZunwJb8rb4gTOzACINXyOsZTBkQyuyoTEh4%2Bnz5iWrppSG2ZISofAzpderz7GYutFXjmSXiWmCAR2zVQa8nUz9Hnv6CP9r26U7mCC2s02MMDZLTJU6cIk9TCXXu52bXIo0y2SlzmMGxhYfBGg/teqBOcUeMD7RunxDpRcD9eutw0kr3nKE6hQ9lZ9AUqSh4WIdbu%2BD9JjMDfZcy78YlxfEaOH7k2Ft9Jb38AFu5ICa/c8PUifRwzKHpWg%2BX59kskJHXkJVS39ALeN4dFNKcymyO67G%2B%2BW0k35yjOqJCK%2BFFF2yg%3D%3D%24%3D%3D
  • Target attr: lcid
  • Target Model Type: data/Language
  • Default: en-us
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
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%24ceOFezew3WaUo6xR%243NrVE9OGGh2G4sS17eU%2Bx7iV/KiOQKgRg0cuulqCUXxaCAdfsesBhD6JwLRkwBFcnutgYeMkYm7geXPP52DgVOUybeVD9MIqL/1ST9xOik7ZqnCfRZkXhTqoiKLDNBjzyr5KM3UXV8I0ZnEZGtCM8Xd0KGBg5bzbKDbnBqbBbek6drXlF%2BYDXDXPb3FCd/JsNTxPbzpl6z9dDlIdB9J77OVxcO5gF2Zm1UF5CPZFhx7uM7M3anHgtVlrXEoUuEk3QdS5HNzlZ5qkUYJC8r61oabp40wMnOUmjzIm1XjP7Y6hGnBcQUp2N5aa2a4QTP5lt8tTFZyRLcdCX1XQyIynZhFXZe21baZe72FgLWlSyuBPiBzcgLzS%2Bd7LdpaK/u90nEpYNcD3dpc2aJPKua%2BPN7o/gBS%2B3qwLhS1jkEfldxwDXkOd8C/Y4pqFX9IxcSbN4zeG18s88C4Bc3zobTR3yfTxv3o1i5ct8hqbZFv9I37%2BFT/k6ixqWwEm7pJK%24%3D%3D
  • Target attr: name
  • Target Model Type: data/CredentialPolicy
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
  • Format: date-time
Account Last Enabled Indicates when last the account had been re-enabled after being disabled due to inactivity.
  • Field Name: dataUser.account_information.account_last_enabled
  • Type: String
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
Time Created Time when password was created.
  • Field Name: dataUser.account_information.used_passwords.[n].time_created
  • Type: String
  • MaxLength: 1024
Entitlement Profile
  • Field Name: dataUser.entitlement_profile
  • Type: String
  • Target: /api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24ViklE7mfD3EHxvCo%24bvw4DfcjKjp5B5zigXRLpdyq5hLh3q0dKtvGLwVNeF2LhgNjDF/MHq%2Bmiup33CV03o6PIv4Ua3WEkpluhldmTfdBYnplxMLc4O/tp6LVuozVTSODwQENOQS1I/JT%2BeMGUZAVE0/2JLphodUM/R/0h5UVKwrViXL1cVD64saS/s/sc5zAsLEDPZb0qL9Bp7eGsbiLYWq3/gUpFQvcuCZb8gE4M4IO4UAAhm3doM1QZIVSqtLkxZd/7MxqzuxQsAz6hvjNsHqT3l8gEKFvd4Z9m2WpmIU6xRQDrcTgJs12JRxGVo9P4drztNVfTGgjzzpifDS49ENhcrBtIM7mNwUJfp6rfXxL1pvIQLfTQ7d/iRJw6raiSzORUMpbVeUMJdW0ECgQdL/M%2B6TSPerrxi2/e/otQYT03veAYAJ8MOSNFUEGSMR8L8qpnszL7FFdu/jUi7HHPYMDF5gqFLGpUDyZyJbSPhmotlJqws8ueIJYGS2rWMlCS1fTJE32%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%24lL8LR0AycSzd87kn%24iPSieOqTqWz8AX7JMGBURzNQfFh0FfhMzSg7nxiNX34aLSNmQllJrGrIE1InipvTFaSFOf2hgUhLppCloo%2BmGi6nXMRuXzweSiVEoQLzGxGKkCfUEdOD1hDC1JNGvKrslclLStuyiIG15hT9OpBr89gFj5Mgfyut3nVb9/zX0MMsRxMfDB5Gn4%2B53eznrhcnVz1fAqGcLdM/5GtRGc2ND0kYQzpehLAc3up4zaK1T1JrhOMN7llHMZVs0ykXC2v45zn/kPCZ4XOh0Ay%2BiVhkoyoWJ5WTn6GVkaEds9dS5TvJh36AfeX8CYg0kNubC%2BbuJ81sWRvamupOEY266Oo1U4J0SBclXme5UTtRCTHslyC3e5Ljcyr0sCzS99OH1Xa0Qe/JISOzDb/2tmcGh2V%2Bg7yI5PDdmyFHB3oh2ZvVT4OHFSEjpsmxmpMr1EUHtGwwUa5vsGyCWBmp27iwr7Mgis250caCCigJz%2Bj5ubl5Jmn0aKFjqpcwku9lZQ%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/UserSyncSource
  • Default: LOCAL
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
Building Name Building name or number.
  • Field Name: dataUser.building_name
  • Type: String
  • MaxLength: 1024
Country Country name.
  • Field Name: dataUser.country
  • Type: String
  • MaxLength: 1024
Department Department names and numbers.
  • Field Name: dataUser.department
  • Type: String
  • MaxLength: 1024
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: dataUser.directory_uri
  • Type: String
  • MaxLength: 1024
Display Name Display name of the user
  • Field Name: dataUser.display_name
  • Type: String
  • MaxLength: 1024
Employee Number Employee number of the user
  • Field Name: dataUser.employee_number
  • Type: String
  • MaxLength: 1024
Employee Type Employee type
  • Field Name: dataUser.employee_type
  • Type: String
  • MaxLength: 1024
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
  • MaxLength: 1024
City Contains the name of a person's locality.
  • Field Name: dataUser.city
  • Type: String
  • MaxLength: 1024
Manager Manager.
  • Field Name: dataUser.manager
  • Type: String
  • MaxLength: 1024
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
  • MaxLength: 1024
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
  • MaxLength: 1024
Physical Delivery Office Name Physical Delivery Office Name.
  • Field Name: dataUser.physical_delivery_office_name
  • Type: String
  • MaxLength: 1024
Postal Code Contains code used by a Postal Service to identify postal service zones.
  • Field Name: dataUser.postal_code
  • Type: String
  • MaxLength: 1024
Preferred Language Preferred Language.
  • Field Name: dataUser.preferred_language
  • Type: String
  • MaxLength: 1024
State Contains full names of state or province.
  • Field Name: dataUser.state
  • Type: String
  • MaxLength: 1024
Street Contains site information from a postal address.
  • Field Name: dataUser.street
  • Type: String
  • MaxLength: 1024
Telephone Number Telephone Number.
  • Field Name: telephone_number.[n]
  • Type: Array
Timezone Timezone.
  • Field Name: dataUser.timezone
  • Type: String
  • MaxLength: 1024
Title Title.
  • Field Name: dataUser.title
  • Type: String
  • MaxLength: 1024
Unverified Mail Box Unverified Mail Box.
  • Field Name: dataUser.unverified_mailbox
  • Type: String
  • MaxLength: 1024
Custom String 1 Custom String
  • Field Name: dataUser.customString1
  • Type: String
  • MaxLength: 1024
Custom String 2 Custom String
  • Field Name: dataUser.customString2
  • Type: String
  • MaxLength: 1024
Custom String 3 Custom String
  • Field Name: dataUser.customString3
  • Type: String
  • MaxLength: 1024
Custom String 4 Custom String
  • Field Name: dataUser.customString4
  • Type: String
  • MaxLength: 1024
Custom String 5 Custom String
  • Field Name: dataUser.customString5
  • Type: String
  • MaxLength: 1024
Custom String 6 Custom String
  • Field Name: dataUser.customString6
  • Type: String
  • MaxLength: 1024
Custom String 7 Custom String
  • Field Name: dataUser.customString7
  • Type: String
  • MaxLength: 1024
Custom String 8 Custom String
  • Field Name: dataUser.customString8
  • Type: String
  • MaxLength: 1024
Custom String 9 Custom String
  • Field Name: dataUser.customString9
  • Type: String
  • MaxLength: 1024
Custom String 10 Custom String
  • Field Name: dataUser.customString10
  • Type: String
  • MaxLength: 1024
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
  • MaxLength: 1024
  • 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%24ex04uOrimmJmvIvT%24jFZWYrJ1i7wc0EeiJARP2DjtkYI/1JrrCMjkOvjno031PQ6tTIRwqI/I446q5qOBn1STcxxMwiHIVbgbo59aH2KEw3Cvf6cNS6/IZiHtj8il/T0k56fioafeB6FxvebbOpHyEn9FRWSP/gk1KklJD2h/lkt4igkVg8PvtXWSYzP3nAlyA6fOw/rYNwgqWq6e%2BqvXPV1lwUH2n5rCyeNBbB5pu0o59dLSCilpvcA5Kc/q%2BE%2Bk0z4TH77yPvEgYe7aqKQsHMhmHC9XvZ3esazZ0XIK3rdFpkyZM92ory%2BeOJDZV4ZmbpV8Kzl/9ldSutZx2EqpsBMlzBaJYxkqzEd6fWUizF5o9KVWXTv1bf/HG%2BhjxDhG4SXmukYhw1J19SHWPRyUP2lL1pDXHzBkxQ9k5EDRc93K/0pJbnYvsuFAOfUHhcwZ8yjQiS4D8YyumdprJUAL9bw/X8W7nuslDlGYFYzI2udsyQ%3D%3D%24%3D%3D
  • Target Model Type: data/Ldap
  • MaxLength: 1024
  • Format: uri
  • Choices: []
LDAP Username The login attribute of the associated LDAP device model instance
  • Field Name: dataUser.ldap_username
  • Type: String
  • MaxLength: 1024
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%24ZhC80E9p40OldIrs%24fSL%2Bc0K5EY3T31BphcGT0jKh7vJzKlnvO6g4fHUbIkgKtiKI7a0mZ4Yz7oTKf1pqdCPci8HqtaSXlAEUGrwPFhT9CjOvx1GEmUHXdroqDnF%2BfaOlIhDJup5fFoXB0gQIaZjSnUq6qZ%2BLUTRNkK78Lr0/k%2BXH87QRIdl41sEVpTzNIfUYgn2uW1hoaEpwBRccLSe2b2PySuS1u4CzdWpNFJgInFHDOP6EAPHXzEsj8MwLnNbKv9WVc30v19yTKtnTJKn2BanS4YLACNgNUouavg6QYITz4x0tjNmrc9grmw1V7hMAqIwH/wIXsP1wbhq51MKHLMS7uMvOTWKD8r5P4yxnaafNSc4ikHFS6D/nUmrTfibEiIfA2eOQ/1j6oQgHiUgYzFq1RPvt3ltUq3YxIdqxUEANaQjPh46FG5TMRKoC9GsnXQZhRJNFfRVD021IFUOn0zjknPp5PfopraHnDJb6gFACHOIrNIydGo0Dbmgo17dvs4HY1CT%2BprQEp5hlFyU97KE%3D%24%3D%3D
  • Target attr: entity_id
  • Target Model Type: data/SsoIdentityProvider
  • MaxLength: 1024
  • Format: uri
  • Choices: []
SSO Username The name identifier that is used for an SSO authenticated user.
  • Field Name: dataUser.sso_username
  • Type: String
  • MaxLength: 1024
User Type Indicate the user's login type. Default: Admin
  • Field Name: dataUser.user_type
  • Type: String
  • Default: Admin
  • MaxLength: 1024
  • 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
  • MaxLength: 1024
Primary Line
  • Field Name: dataUser.mvs_primary_line
  • Type: String
  • MaxLength: 1024
Primary Class of Service
  • Field Name: dataUser.mvs_primary_line_cos
  • Type: String
  • MaxLength: 1024
Extensions Extensions to select primary details from.
  • Field Name: mvs_extensions.[n]
  • Type: Array
Line
  • Field Name: dataUser.mvs_extensions.[n].line
  • Type: String
  • MaxLength: 1024
Line E164
  • Field Name: dataUser.mvs_extensions.[n].line_e164
  • Type: String
  • MaxLength: 1024
Class of Service
  • Field Name: dataUser.mvs_extensions.[n].line_cos
  • Type: String
  • MaxLength: 1024
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
  • MaxLength: 1024
Broadworks User Name The username corresponding to the the Username in Broadworks.
  • Field Name: dataUser.username_broadworks
  • Type: String
  • MaxLength: 1024
Cisco Unity Connection User Name The username corresponding to the the Username in Cisco Unity Connection.
  • Field Name: dataUser.username_cuc
  • Type: String
  • MaxLength: 1024
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
  • MaxLength: 1024
HCMF User Name The username corresponding to the the Username in Cisco HCMF.
  • Field Name: dataUser.username_hcmf
  • Type: String
  • MaxLength: 1024
LDAP Directory User Name The username corresponding to the the Username in the LDAP Directory.
  • Field Name: dataUser.username_ldap
  • Type: String
  • MaxLength: 1024
Microsoft User Name The username corresponding to the the Microsoft Username.
  • Field Name: dataUser.username_microsoft
  • Type: String
  • MaxLength: 1024
Microsoft Office 365 User Name The username corresponding to the the Username in Microsoft Office 365.
  • Field Name: dataUser.username_ms_365
  • Type: String
  • MaxLength: 1024
Microsoft LDAP User Name The username corresponding to the the Username in Microsoft LDAP.
  • Field Name: dataUser.username_ms_ldap
  • Type: String
  • MaxLength: 1024
Microsoft Teams User Name The username corresponding to the the Username in Microsoft Teams.
  • Field Name: dataUser.username_ms_teams
  • Type: String
  • MaxLength: 1024
Open LDAP User Name The username corresponding to the the Username in Opoen LDAP.
  • Field Name: dataUser.username_open_ldap
  • Type: String
  • MaxLength: 1024
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
  • MaxLength: 1024
Webex App User Name The username corresponding to the the Username in Webex App.
  • Field Name: dataUser.username_webex_teams
  • Type: String
  • MaxLength: 1024
Zoom User Name The username corresponding to the the Username in Zoom.
  • Field Name: dataUser.username_zoom
  • Type: String
  • MaxLength: 1024
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%24F9OlKhCiXU94SE94%24GDs8s70n8XySJon%2B6zmDnvVvqaf/KfkWxyrXUZT619zR%2Bm2h6lsjZXJ2p2fTf/%2BqvrGh/5rYVCBsvPavrjGEvKh4DVzminIZnk6LoNin%2B5/RtK6K3DDyoBpAGmRRRWFPBRIbuf092dCUQcZ2UqMWg0irkexUdnPhX%2BBbzGqa0q290b/3BGjQH9dSCxmvM%2BGke37bFC6/CX1zXY%2BGBo8rcSIZ97EB5BEyXmsQzW2jlq96YKecfali7w30VKdJh9jWZRbrIwuMUaRw3/9cW1kqXt6ngufMj4i0/rgi%2BgBu9IhW0cCFIOCjGcaTyOcTjPP8EqqKzM%2BJDbjgKatRvjj%2B21gpCblwSXpqSBRz51AM/9B7ro4001qvjbqoR/JIlrMyvgvraI6JRhxA1HcpZH5JLTb3sz9keiTjGQSZA2We8m/wPnveHTJ2igRVu9KLsnABcHsiOv3wTajbDhpV8QU%2Bgkok3H2SxVx7%2BpAKEC/jjjsUXv6vyFPamleTRbiSeLstZr5HFTY%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/AuthorizedAdminHierarchy
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Portal Preferences User-specific portal UI preferences such as theme display mode.
  • Field Name: portal_preferences
  • Type: Object
Theme Mode Preferred theme display mode for the portal (for example light, dark, or system).
  • Field Name: dataUser.portal_preferences.theme_mode
  • Type: String
  • MaxLength: 1024
License Audit Details License Audit Information.
  • Field Name: license_audit_details
  • Type: Object
Last Checked The last time the License Audit Details were updated.
  • Field Name: dataUser.license_audit_details.last_checked
  • Type: String
  • MaxLength: 1024
  • Format: date-time
License Audit Status The License Audit status of the user. Default: Unknown
  • Field Name: dataUser.license_audit_details.status
  • Type: String
  • Default: Unknown
  • MaxLength: 1024
  • Choices: ["Licensed", "Unlicensed", "Unknown"]
Hcs Site Dat
  • Field Name: hcsSiteDAT
  • Type: Object
Name * Site's name
  • Field Name: hcsSiteDAT.name
  • Type: String
  • MaxLength: 1024
  • Pattern: ^[A-Za-z0-9_\- ]+$
Create Local Admin Indicates whether or not an Admin User should be created Default: false
  • Field Name: hcsSiteDAT.create_admin
  • Type: Boolean
  • Default: false
Clone Admin Role Indicates whether or not the Admin User Role should be cloned Default: false
  • Field Name: hcsSiteDAT.clone_admin_role
  • Type: Boolean
  • Default: false
Push Users to CUCM Indicates whether or not all of Users at Site level are pushed to CUCM Default: false
  • Field Name: hcsSiteDAT.push_cucm
  • Type: Boolean
  • Default: false
Hierarchy Path Site's entity's hierarchy
  • Field Name: hcsSiteDAT.HierarchyPath
  • Type: String
  • MaxLength: 1024
Migrate from HCM-F to CUCDM Migrate HCM-F Models to CUCDM Models Default: false
  • Field Name: hcsSiteDAT.migrate
  • Type: Boolean
  • Default: false
Misc Data Miscellaneous data used at run-time
  • Field Name: hcsSiteDAT.misc_data
  • Type: String
  • MaxLength: 1024