[Index]

Model: relation/HcsResellerREL

Resellers

After VOSS-4-UC installation, the entadmin Administrator must configure the HCM-F device (if applicable) and create the Provider. Creating a reseller is optional.

  1. Log in as provider administrator.

    Log in with the Provider administrator's email address, which is case-sensitive. The hcsadmin Administrator can find the Provider administrator's email address by choosing User Management > Local Admins and then clicking the Provider.

  2. Choose Reseller Management > Resellers from the menu.

  3. Click Add.

  4. On the Reseller Details tab, complete these fields:

    Option Description
    Name

    The name of the reseller. This field is mandatory.

    Note:

    Once you save the reseller, you cannot change the reseller name.

    Note:

    Any spaces in the reseller name are converted to underscores in the reseller local administrator name and email, if the Create Local Admin check box is selected.
    Description Reseller description
    Directory Domain Reseller domain. This field is used to create an email address for the reseller default local administrator, for example Reseller1Admin@reseller1.com. If omitted, the domain of the provider is used.
    Create Local Admin Controls whether a default local administrator is created for the reseller.
    Cloned Admin Role The Provider role used to create a new role prefixed with the reseller name. The created reseller 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 check box is selected.
    Default Admin Role The created reseller role that is assigned to the default local administrator. This field is read-only and appears only if the Create Local Admin check box 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 is selected.
    Repeat Default Admin Password Confirm the default local administrator password. This field appears and is mandatory only if the Create Local Admin check box is selected.

  5. On the Contact Information tab, enter address, email, and phone information as appropriate.

  6. Click Save.

Model Details

Title Description Details
Name * Reseller's name
  • Field Name: name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[A-Za-z0-9_\- ]+$
Description Reseller's description
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Directory Domain Reseller's directory domain name
  • Field Name: directoryDomain
  • Type: String
  • MaxLength: 1024
Create Local Admin Indicates whether or not an Admin User should be created Default: true
  • Field Name: create_admin
  • Type: Boolean
  • Default: true
Hierarchy Path Reseller 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
Misc Data Miscellaneous data used at run-time
  • Field Name: misc_data
  • Type: String
  • MaxLength: 1024
Data Rsell
  • Field Name: data_rsell
  • Type: Object
id
  • Field Name: data_rsell.id
  • Type: String
  • MaxLength: 1024
Name *
  • Field Name: data_rsell.name
  • Type: String
  • MaxLength: 64
Description
  • Field Name: data_rsell.description
  • Type: String
  • MaxLength: 128
Account ID
  • Field Name: data_rsell.accountID
  • Type: String
  • MaxLength: 64
Contact Name
  • Field Name: data_rsell.contactName
  • Type: String
  • MaxLength: 128
Contact Address1
  • Field Name: data_rsell.contactAddress1
  • Type: String
  • MaxLength: 128
Contact Address2
  • Field Name: data_rsell.contactAddress2
  • Type: String
  • MaxLength: 128
Contact City
  • Field Name: data_rsell.contactCity
  • Type: String
  • MaxLength: 64
Contact State
  • Field Name: data_rsell.contactState
  • Type: String
  • MaxLength: 64
Contact Post Zip
  • Field Name: data_rsell.contactPostZip
  • Type: String
  • MaxLength: 32
Contact Country
  • Field Name: data_rsell.contactCountry
  • Type: String
  • MaxLength: 32
Contact Phone Number
  • Field Name: data_rsell.contactPhoneNumber
  • Type: String
  • MaxLength: 64
Contact Email
  • Field Name: data_rsell.contactEmail
  • Type: String
  • MaxLength: 128
CCDM
  • Field Name: data_rsell.cCDM
  • Type: String
  • Target: data/HCSHcmfCCDMDAT
  • MaxLength: 1024
  • Format: uri
CUCDM2
  • Field Name: data_rsell.cUCDM2
  • Type: String
  • Target: data/HCSHcmfCUCDM2DAT
  • MaxLength: 1024
  • Format: uri
Directory Domain
  • Field Name: data_rsell.directoryDomain
  • Type: String
  • Target: data/HCSHcmfDirectoryDomainDAT
  • MaxLength: 1024
  • Format: uri
Owns CTX
  • Field Name: data_rsell.ownsCTX
  • Type: String
  • Target: data/HCSHcmfCTXDAT
  • MaxLength: 1024
  • Format: uri
Monitors Prime Collab
  • Field Name: data_rsell.monitorsPrimeCollab
  • Type: String
  • Target: data/HCSHcmfPrimeCollabDAT
  • MaxLength: 1024
  • Format: uri
Service Provider
  • Field Name: data_rsell.serviceProvider
  • Type: String
  • Target: data/HCSHcmfServiceProviderDAT
  • MaxLength: 1024
  • Format: uri
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 * The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.username
  • Type: String
Email Address The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.email
  • Type: String
First Name The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.first_name
  • Type: String
Last Name The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: dataUser.last_name
  • Type: String
Password The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.
  • 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: data/Role
  • Target attr: name
  • Format: uri
Language The preferred language for this user. Default: en-us
  • Field Name: dataUser.language
  • Type: String
  • Target: data/Language
  • Target attr: lcid
  • Default: en-us
  • Format: uri
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: data/CredentialPolicy
  • Target attr: name
  • Format: uri
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
API reference for relation/HcsResellerREL