[Index]

Model: relation/HcsProviderREL

Providers

Full HTML Help

This procedure creates a provider hierarchy node in VOSS Automate and, optionally, a default provider administrator.

  1. Log in to VOSS Automate:
  2. Go to (default menus) Provider Management > Providers.
  3. On the Providers page, click Add.
  4. On the Service Provider Details tab, complete the following fields:
Field Description
Name

The service provider name.

Note:

  • Once you've saved the provider you can't change their name.
  • Any spaces in the provider name are converted to underscores in the provider local administrator name and email, if the Create Local Admin check box is selected.
Description A description of the provider.
Domain Name Mandatory. The service provider's directory domain, for example, "provider.com". Used when creating the default local administrator so the administrator can log in with an email ID such as ProviderAdmin@provider.com.
Create Local Admin Defines whether a default local administrator is created.
Cloned Admin Role

For Provider deployments, the HCS default Provider role used to create a new role prefixed with the provider name.

For Enterprise deployments, the ENT default Provider role used to create a new role prefixed with the provider name.

The Provider role, shown in Default Admin Role field, is assigned to the default local administrator. This field appears only if the Create Local Admin check box is selected.
Default Admin Role The created provider 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 mandatory field appears only if thr Create Local Admin check box is selected.
Repeat Default Admin Password Confirm the default local administrator password. This mandatory field appears only if the Create Local Admin check box is selected.
  1. On the Contact Information tab, enter address, email, and phone information, as appropriate.
  2. Click Save.

Providers

Note

References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.

In VOSS-4-UC, the provider name is set to the current service provider name in HCM-F.

Procedure

  1. Log in to VOSS-4-UC as hcsadmin at sys.hcs.

  2. Choose Provider Management > Providers.

  3. Click Add.

  4. On the Service Provider Details tab, complete the following fields:

    Field Description
    Name

    The name of the provider. The name is automatically set to the current service provider name in HCM-F. You can keep the existing name or overwrite with a more meaningful name. This field is mandatory.

    Note:

    Once you have saved the provider, you cannot change the provider name.

    Note:

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

    Select to set a provider name in VOSS-4-UC that is different from the service provider name in HCM-F. Service provider names that were synchronized from VOSS-4-UC 8.1(x) or are set to "All Service Providers" can remain unchanged in HCM-F.

    If you leave clear, the provider name you enter in the Name field is synchronized into HCM-F as the service provider name.
    SDR Name The service provider name to store in the SDR on HCM-F. This field appears only if Decouple SDR Name is selected.
    Description A description of the provider.
    Domain Name The domain of the provider. For example, provider.com. Used when creating the default local administrator so the administrator can log in with an email ID such as ProviderAdmin@provider.com. This field is mandatory.
    Create Local Admin Controls whether a default local administrator is created.
    Cloned Admin Role The HCS default provider role used to create a new role prefixed with the provider name. The created provider role, shown in the Default Admin Role field, is assigned to the default local administrator. This field appears only if the Create Local Admin check box is selected.
    Default Admin Role The created provider 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 mandatory field appears only if the Create Local Admin check box is selected.
    Repeat Default Admin Password Confirm the default local administrator password. This mandatory field appears 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.

The provider hierarchy node in VOSS-4-UC, and optionally a default provider administrator are created.

Model Details: relation/HcsProviderREL

Title Description Details
Name * Provider's name
  • Field Name: name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[A-Za-z0-9_\- ]+$
Description Provider's Description
  • Field Name: description
  • 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 Provider entity's hierarchy
  • Field Name: HierarchyPath
  • Type: String
  • MaxLength: 1024
SDR Name SDR Provider Name
  • Field Name: sdrName
  • Type: String
  • MaxLength: 1024
Decouple SDR Name Decouple Provider's SDR Name From Provider's Hierarchy Name Default: false
  • Field Name: decoupleSdrName
  • Type: Boolean
  • Default: false
Domain Name * Provider Domain Name
  • Field Name: directoryDomain
  • Type: String
  • MaxLength: 1024
Misc Data Miscellaneous data used at run-time
  • Field Name: misc_data
  • Type: String
  • MaxLength: 1024
Data Prov
  • Field Name: data_prov
  • Type: Object
id
  • Field Name: data_prov.id
  • Type: String
  • MaxLength: 1024
Name *
  • Field Name: data_prov.name
  • Type: String
  • MaxLength: 64
Description
  • Field Name: data_prov.description
  • Type: String
  • MaxLength: 128
Account ID
  • Field Name: data_prov.accountID
  • Type: String
  • MaxLength: 64
Contact Name
  • Field Name: data_prov.contactName
  • Type: String
  • MaxLength: 128
Contact Address1
  • Field Name: data_prov.contactAddress1
  • Type: String
  • MaxLength: 128
Contact Address2
  • Field Name: data_prov.contactAddress2
  • Type: String
  • MaxLength: 128
Contact City
  • Field Name: data_prov.contactCity
  • Type: String
  • MaxLength: 64
Contact State
  • Field Name: data_prov.contactState
  • Type: String
  • MaxLength: 64
Contact Post Zip
  • Field Name: data_prov.contactPostZip
  • Type: String
  • MaxLength: 32
Contact Country
  • Field Name: data_prov.contactCountry
  • Type: String
  • MaxLength: 32
Contact Phone Number
  • Field Name: data_prov.contactPhoneNumber
  • Type: String
  • MaxLength: 64
Contact Email
  • Field Name: data_prov.contactEmail
  • Type: String
  • MaxLength: 128
Management Network
  • Field Name: data_prov.managementNetwork
  • Type: String
  • Target: /api/data/HCSHcmfManagementNetworkDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24sysOg4LXXU04RRd0%24adR%2BHMFy4Otk4gIkAW1xiB6Oa9dloWUztWPkQ1owBbE8NcMiQcRrrrdWz80DkDIxw4Rl%2B5MbjeWyzy1tF%2BRB6ApMamkfQ8PTEI7TNW9loiH2%2B6Aa5V7bx/ybkEdC1Eh2nQqCYzGHTzC2/kjIM70dXnbpUFgQvK6xACPjmuU3TpVNImP9R0Kex60cKxSr5EgxAisJB5jDHSCgdn8dlHulTy1/OPQ4JfLtZk3MWD3g6cgK8T6VtbhqLDhIATkv6qzib2BneH3m9DQNua84XhPSBMso4kbtFT3oKuT8iO3Ko7WYt7NbkiVReVlc%2BbKtjPlZxYDvbqzllijqSbCFO8ooYAyH3yH0KCTVnDC/GbiYPXJ9UI3mLP8CaPxBBeYnyEVL%2BMA%2BPGRirQH/xuGnAKim1lk6MHakQVScYd4YpgMWFA7UlfmHerWctJDrrRla2sndhBNQZISQZaa5ofVXjXtIb33a/50fv11qrBYWj%2Bn7XUriWtdGF4za3zlhz%2BOpRIFZIw%3D%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfManagementNetworkDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
CCDM
  • Field Name: data_prov.cCDM
  • Type: String
  • Target: /api/data/HCSHcmfCCDMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fef1P11CiuG5RmV5%24CwSMA/jVoJwTuY%2BQHs%2BP49iZH6lZssQ9%2BAMYa6erAk//l2k1aEUvI0Ulj%2BmygFZGRAgim2yslVJYo0b1z75E0sQrD75l8KKb5qNUvILnNTSGQkMVo/5EMBgsWpNOZfa4gONrFz1wrELPd6xfQfW31GIaTTMWJZcWHxP7tXAWSapz5aF20q7WCSnK6gkUMTf0D/GQ%2BZs/IBiuq1GiVAKg7ZMlnz7lbDyqzeQb%2BKkjaAtInHMiaRKKqVeVb2ad7NzgXGtvtiU3wQAwrWoqRGnNpbywbd4BVCcZ5ncPcTuEWOtqIxtPBzAibobfib0keEHSiAWqIUQoL6xUhBuVNl8XT%2BxzmGFgr/ko6EYk0QEZ/BZz3uRxjY5GIfqJ7kxekSLmT8Wxv1IvbqHuvOcVuEiCFYeJseMMP8ObpyLb1ucJeZ/45GmuzgD6swaCKq5rjV0/Mf50JV61fpi4BG2HwxMA3gkganDwMeAOZBMu3Ni/uXT6c0qu%24%3D%3D
  • Target Model Type: data/HCSHcmfCCDMDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
CUCDM2
  • Field Name: data_prov.cUCDM2
  • Type: String
  • Target: /api/data/HCSHcmfCUCDM2DAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24qmJHya3ItNPunXtS%24tPKyONrvqt9qV8cXUiZ20STcgCePTuRMJtlttauEhzJCzJLghCCzImAe9IdHwL3j%2B2W1Ax/XjF/QXz%2B9ebBdxSeTuZWGuM4loOogAlghp%2B9q3n5/ggiPWQUAinQtGq4jPiKmd5UqvAX6XsY8DUqfgnUyKBRlr9xkdP96470JU0ff0HObzrjmtVD/WWyh8oZNlg65oo1FBaMC8UtCb/qeQiALSSAmMX3YI6i5v131KO9n/mAP8N/QAGFP2yo6K/ULvUnhvNprQejsqjKmzdTx2gyfYPX3YOHTpJyEpqvkNreb6huxudPJ0yzDMWaRKIdAIa5xP/6Y83UjekNiLiRvfriym7tXOSH3yoSjEed0LD3HznlMA2GbdYGym8L2rmpS6yeCK10eL7dXCOPz7vzGVXQ4Ilrne3KvPk9jD0eOomQHth9Ucbb1U7lZvFU0zyWxvMYJJPczyAkyuIDGkNo5CXfdTfsDDaCIezIrSG/bIlxP6oC2fsI%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfCUCDM2DAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Directory Domain
  • Field Name: data_prov.directoryDomain
  • Type: String
  • Target: /api/data/HCSHcmfDirectoryDomainDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24DhWGKhNIrTUutbTS%24YhPungUV2Pb9SiniCarx5IQk0pdhWThZlmBpARjHbObXjx8J9Io3F33xYoviFZt85K%2BAEhTxNr6p9CtM8SADJrdPbOrMEA1GsdWavfhuIRINPwjETPlvdpCIPfoKDU/iKotW9usuWg6cCrNiWVRaPCXm1sbNj7SWC/8fafromeortKYgOSom9du8n5xsMhsaRyls/fFBOIng8KPa5yrxljCCzQOGMOoC6O/mI7zqMvUUfiur62JGXVVWzRbWKcL9oRnbl6N3HkeWj%2BCYFf9zMiVBQ0B/Lwz0Mgcrcogz3Q4vZnb23MKO3EMXItRBAHPGF/CAsAYMwV1TP9cqWy/BytpfAkNW969hl73g0yxkfXYsyTWbHNeMZjTliV6NvphQ2%2BQxldOy4Je8ZtSDBnAcSSELgqx6ohazi7kWuAljkjTtpXbttVFx0lNLY7P6/bQpNcNYJ3NFCaX0u4gfR7xSr9VxNQBzXumYuv1lpNZ9Ba1JT1jLvJoWQGy42sFk8ig%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfDirectoryDomainDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Owns CTX
  • Field Name: data_prov.ownsCTX
  • Type: String
  • Target: /api/data/HCSHcmfCTXDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%243faTiiglungtjFq8%24efm12Xm8pfznDNJgPzszfhVYdvcGtQby0JJxEJCklDQVR9pc/Oj8zIXpD6HS1U2QJ9Len9Gs5lr7Cdxq2kFm2Ix8BFuwUChjTRJxO2cwDY%2Bn0bTGWR4zmoliqCWjDdkYUu5%2BcymirfGPNwykCaRMQXd3W4cpf4dJ0I2lLTy%2BncLRCqHYk8E4orC2kdetOY1KK49Jlwj1Itbthfmq2a6HxDWJwh80AQ0tpkclhkvBsje3laKsnr5dBdTVAI9NUL6%2BpNdUZitAj3YY4v60dw0j%2BoKwzUDjukl3E8xsnpSt1fGCtpz06v2Cy0k6RYnYeUF81RavHqGFAcECeg0YryLrwlP/KSgvNTdy/0vL%2Bymn3cLBFtEgRgKRFA4nac9OdizUaeS7axIP4fg2LQJpH7CDIIB7oV0OVg2Wt%2BvkPsECpYISj42Pm8rFS1nanS1%2BqcFqe%2B2E5roIshqY0v5EL6xyGrI/iAwXISoQPJCu2ST2DCbzgqs%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfCTXDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Monitors Prime Collab
  • Field Name: data_prov.monitorsPrimeCollab
  • Type: String
  • Target: /api/data/HCSHcmfPrimeCollabDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24pLGdgqUW0R0BsnWo%24vKeQ7eHrBGwK4OIIKl3o4a7PsIXqzSwKLd/cJHcPkA/QxUJqRYNHJFbqt2YyUyCkPkmh/XZgB8NW5Q4IwvAiQqSHl7I8OmRyjM4pkDEc97GX%2Byp8hdWjkLneBDBV56PB1BAePxWL6xck/zS43py%2ByaN4CELU3wV2qEtZXaD4GRqMUMoDV3YPTEo0cfTkHv75YopnJEOEsM8oByf85v9nkzOGx9Vgk5EYN9FBgLZntgGw1v4D508ZObsvyBmZTLrZZE2qSpUCMYZXjD944YGkSJ%2BZf/WXvxiGAHPH5fpV2Is8qPB4GN4bjaM44Ijrs5lID7lOKL%2B79SfxsHL1xguLn930n07vZWaMJHbJQJXDPZzygmSD8v6WBB/xBEVUvmhu%2BkrZZXOPjuJaYC4pnPhElHLnQ92fs43EMYt5TLkwKF5/Xmj/Wj9b6qeAMTHczt3221eCkltIew9wTQkjVyZq9b20ueQhU0d7Mu3xPfqsds%2BtG31HsaKgEp7MHg%3D%3D%24%3D%3D
  • Target Model Type: data/HCSHcmfPrimeCollabDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
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 Dd
  • Field Name: data_dd
  • Type: Object
id
  • Field Name: data_dd.id
  • Type: String
  • MaxLength: 1024
Name *
  • Field Name: data_dd.name
  • Type: String
  • MaxLength: 128
Description
  • Field Name: data_dd.description
  • Type: String
  • MaxLength: 128
Active Directory Domain
  • Field Name: data_dd.activeDirectoryDomain
  • Type: String
  • MaxLength: 128
Cloud Connector URL
  • Field Name: data_dd.cloudConnectorURL
  • Type: String
  • MaxLength: 256
Cloud Connector User ID
  • Field Name: data_dd.cloudConnectorUserID
  • Type: String
  • MaxLength: 128
Cloud Connector Initial Password
  • Field Name: data_dd.cloudConnectorInitialPassword
  • Type: String
  • MaxLength: 64
Cloud Connector Admin Email ID
  • Field Name: data_dd.cloudConnectorAdminEmailID
  • Type: String
  • MaxLength: 128
Organization ID
  • Field Name: data_dd.organizationID
  • Type: String
  • MaxLength: 128
Local Admin User ID
  • Field Name: data_dd.localAdminUserID
  • Type: String
  • MaxLength: 128
Local Admin Password
  • Field Name: data_dd.localAdminPassword
  • Type: String
  • Is Password: True
  • MaxLength: 128
Service Account User ID
  • Field Name: data_dd.serviceAccountUserID
  • Type: String
  • MaxLength: 128
Service Account Password
  • Field Name: data_dd.serviceAccountPassword
  • Type: String
  • Is Password: True
  • MaxLength: 128
Admin Account Reset Password URL
  • Field Name: data_dd.adminAccountResetPasswordURL
  • Type: String
  • MaxLength: 128
Type Current LDAP Integration Default: DISABLED
  • Field Name: data_dd.typeCurrentLDAPIntegration
  • Type: String
  • Default: DISABLED
  • MaxLength: 1024
  • Choices: ["DISABLED", "IN_PROGRESS", "ENABLED"]
LDAP Sync Enabled
  • Field Name: data_dd.lDAPSyncEnabled
  • Type: Boolean
Search Base DN
  • Field Name: data_dd.searchBaseDN
  • Type: String
  • MaxLength: 512
Type UID * Default: MAIL
  • Field Name: data_dd.typeUID
  • Type: String
  • Default: MAIL
  • MaxLength: 1024
  • Choices: ["MAIL", "SAMACCOUNT_NAME", "EMPLOYEE_NUMBER", "TELEPHONE_NUMBER", "USER_PRINCIPAL_NAME"]
Org Unit
  • Field Name: data_dd.orgUnit
  • Type: String
  • Target: /api/data/HCSHcmfOrgUnitDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24IFMKGA5pWLmmKBpE%24JD6XoYYGvQUgk7agxEHXXEWHjN0FLzheixpQiJUY/a%2ByFdIfSs2K1z2rmWs855WFAHX2Aca5LuXJIAxKYl/z3vrBLOGYR%2BQo7w2Lc2SJSAt20u4O8tLaD83trJZoOdIL23Im8kiKeGx1g4EYYCzkB3oLCvXPTA4s3CNZ%2B4sCWS%2BPb5qUaGsNqYci2vrq%2BXbSyD/1PQdhoAFl6D2oEkCltzE2gGTYSU/u7obtSOnutx2DtOn9XhzOFg12zCpArzn/4lHK7MlG0/msRrw8PBtB5mNX4Hq%2BH71%2BpwmCbKnJr/ncUwhosi2CilELukrW9jUsYiSrV8U3OdIAK%2BJaENbUZ60YAqkNZfOEU5WwQRjzroTJCJ5ihrAw1cVf2qWpm4dd6ihlDR9ea7r5vZzGbFgGz3Y9/1h38dDt5RT5LG3Y/38J4%2ByZYTmJxN9QnCBJ6hGWMO3CdC/EE43E9X8gvfo%2BJOVH8YLpUiMc%2B8/1SD0Jk28PBJf0/T3c%24%3D%3D
  • Target Model Type: data/HCSHcmfOrgUnitDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Credentials
  • Field Name: credentials.[n]
  • Type: Array
Description
  • Field Name: data_dd.credentials.[n].description
  • Type: String
  • MaxLength: 128
Type Credential *
  • Field Name: data_dd.credentials.[n].typeCredential
  • Type: String
  • MaxLength: 1024
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
User ID
  • Field Name: data_dd.credentials.[n].userID
  • Type: String
  • MaxLength: 256
Password Community String
  • Field Name: data_dd.credentials.[n].password_CommunityString
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 512
Type SNMP Access Default: RO
  • Field Name: data_dd.credentials.[n].typeSNMPAccess
  • Type: String
  • Default: RO
  • MaxLength: 1024
  • Choices: ["RO", "RW"]
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%24NWky3csBqRssV4WX%24HHaJudbKDifA5Mf7MK91cCKXdunVXilQOkeMwCv%2BOFOujecPvJQW2Xqz%2BzPoZUfjl6L5vL/FoeH%2B7M%2BN4aslu4xTEDRe%2Bt7p8pfCGcI%2B/Y9qHRQEiGxlN%2BrYK2xnjF%2BAAlqrR3o%2BCk5Xf649/aF%2BkgWtcIExEkYuKXc5jysQVtOCEyrEaMrvve43sFNsD%2B1DeXis5fXdjlw6wuNyjiY8EeCVt1fQPU06zLwAEoNNdysBzKs6kDlpjX3lUd3SqIR2J6Irn2rzxLSTJOMXteCJnnWACOUf%2BkKSNbOaYJmIst1z9%2BEzPDt5/dg6xGAxqPlZyZ1gOxmvLGDuzyUhGJN3Q1on0EUwx7JK7aX6Juk9aSY6T084cQxkjMiejThqTw/o7xDEpK9qYtLUZK1oqynG9/Ih5N8U3E0qekzpssb686514%2BLJ5upz9nkDU3DxdSftpRlIC0kyPQJaOmEh5Ij3kE19%2BYG69lRvZouTu9JXAY7Q0RR3Gg%3D%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%24cBmMeP32oxulf4kl%24rXDIHUkttbQWPcRRa1lDt7YtD8cPFscv4vLmmD3dLrpkKsgEY2cZvjG8xSuJpwOJ1FY/nRFjtTsPuZisZxWxhCf2sjF%2BzXKKsepi3Uq8PLFYINXVM16M5q6PLCZ%2BJdjYzJEXZwL7ZaTWFfi4V/kHGT1cC1//07bOvx37hBvJnOYzNy0bKV7pjG0CYVI3ywzg032O/WBGXTc8eDXBAOh/zUVGEaohn65yswHHvayp%2Bonq0hxa2Ouc7ATp%2BSLuI35RTMqWXiSY2G4ccL266YBATS1n%2BSP6dGSpJ2wczWUKuJUO7zFWyrRr9WZFmNGVHwKrVweCsxWKceLHsR%2BUoZnufGbSmil%2BA4uoKnLlqYxa95UPYyD25J2Fu5NXH2Z1z8r//KToHTVtd%2BaGLSKri2U89TPcMwDxglkdtx3najezKWMHke5aBgtOKp68%2BEimEx9Y1akJbu05El9FbUJA5RevejlDVI3H2LqqkTEN168m2K5HJ3DzbXr8OFM%3D%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%24RuCSafyyItn0rklB%24p93JsIo8lElr9lsRQBb9PSoO91%2BWgasy7esa5JOmQNoA4wxuDg5rKDNrO0mRB7S8%2BS4PyYa9W/5akhninO/B7KCZkehIQfTBT%2B8wb%2BmRBIexYju2heM0WG5jrxYg9DBAKMi2pBuwj6l3qiUdHAbGe2cquQ4YvYbHCFzwH9hqA3r9suZqEHNZraaJ1lxcQ/efr8CbRrVz46VpWKch9XZNKBI1dCyvndLztpBRyIG8Gwfo3usnFbU7ucaYI1JqJmR1EsjBqbQHEpyXlBnK9O6yLXwsYhOAJwt2ICe/W7T2dYLDPtijlNlp96jw4QRwyCUlvnR9p/lKk4U1ZR2YPmCm7K14qBjjzwpoAZ7MYE7oMG4nc6%2BGmwhZfKjhtgQ4d3tN1Q5DX5noWra3zPXN9NoM8tn0bqb/C9cU8EIXWK9jEiaJA8IscWgo9kk/3mc46dIP72nsxX%2B5mMQ2HxlmZGfsutEjub6FR0f6srCIvOdVEKL07laL4sWpy7iaoRdKbhnKJA%3D%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%24HhoS7Dw7ko45inK3%247YILjlvyDDS6J7XGINhVX1OY%2BmOlhjwyV9UdeV0GqSfQibhRy1y9LvKi4HuZmF7zmFdNn6TYxyrzaSxC0%2BrAggZwQMdgQzOGqxr%2BuGZCia4S48GB%2Bzf075SERnuQRO9eTk/iLoo6PlZ/Cay4w8pwmuBJdap6nqarq8L/Zg1K6K1jukWNOLUYNs3TwmMkKwbkWVXJut7z%2BgR8CcsKGKCrWl4b9TyVMKWGyn02RNZO9mwO6PFzGBVB88E5XdV6CZJzoIQUvaqhYcu503KB2q1FL9hx5oQuasC%2BETNY%2BTsq0bntP%2Bd1f0Bg8MtgW1IJa0bGxPTQbeNccyaTlHkFHerxAjuuLx8AhTLRGCf1AixKYOL23dbg6qmKv4eI0SUAZ5/ehcuWyLGgH89292X7f3SKoeS%2BtfDleVeut7YWDN6jaKNBDbhwXFlvJDxb%2BTRlKjmpWiwQNjTLGa8KaiZ2C4QWXJLi3NtvuLTg87PP9YVcPg9nyM5B1wvUTy3YtyE%2Bjg%3D%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%24x9mcl9KApFkqFYfe%241tvpQmYVbl52IRumsmNRRSakYhjYMyLDi0TwUmPwdTWSRvbGEXBKRpqusFPMcWWAxuapgDnXhf5X8pk6K0IzEBqAyv14s7XXRnI9RxKNlbb54Qc2jOcB%2B9K6jyj/kdLXhX54dOuOu88MjggCWaY0Ju3yBe/9ZDr%2BB4WibvaISVRnPrelCWDnN/yqiSvP84Z%2By1f1qMNxGwifQEJD84HYCMkaOhhuKFDn0SCLUJXuZf2yjrrlEXT97V/CE%2BlHyf56Fky0jU2qtt3X9/wV97%2B2XJpSIuc0pahRH%2BeKzAzFiumDD/8txbX/K%2BUq4wg/LADMqq81zwiS1sWBjPaSRirv52LywfBlbMVdEbJOjxfLeTw/WoMTZyW34nvqm/sn2q2%2BjmHJlbqcsdK405WRIht5rOEexX51DHylFRz5hjgCSFtqdOQDn2bN6R8lrcFNSpOrHndfKSKrPw0qrAhvGC12CMsk4%2B15ZtepXYvnzd4UVj76jAQP5l9YnaBz6XTT6Cw%3D%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%24i5iZD3ZVC8VezFAO%248EXSMOBFXOUfJIVLrtHC6foVlXt3E122AsVA5d7pekBtC0lcw2WrNdGjLL4z9XxLMYG7TW4UpFSBMurGC4/P%2BE7fi2LBjPW9vdllLgTWciZ1B33SwVd8F675OOoqDR3HbunmPo9jwFBz34kbHitq1gMOIbYAWN3JKTNCN7o2MuPgFpRxBs5dK5fSZOmUXhsZv8JWSgeMvaRGw1nr13qg/u0UisN32UOUH1qkGcALIGOJ%2BaGO66pMMtGmj4uWSC7yOc4kIWnr61PvGVEbwr8D/SL9W%2BcJytIoZwp3FlAXcJENVG3iIZiXRCAYYcWTKEfQlHj1DwO3z49e/r%2BOA9/wUrK7XwxXXpgb1zkYJbtg89L%2BITzKprbrnMDtoCaDiJl7gQ3Out08LzvGn4Rc2t9%2B651U3ETgu94dHotQZ88ZwXUmvl7hBBk9RsTIX5hx46iHVI/Kb2M%2BXIDFcW4ESxGGQLmMIEH%2B54Q3Khk%3D%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%24b3GjUp9biT6x5jBS%24nLmEOzAWYNlKrZELmzGSGzv7PsqTZD7pOqn4F762Bm%2BjwvNZCLLs8AJb/%2BbHwlB0gmIVWRj1OXmXuu4GXMhxYRpNbLXUF2KXlD0dyRBthTd0OpUPR90EC8ceP0dqWaGzyZjdC7XuACHTyMWc/BM8CTGLFt9SHvrwVXpwOlBwoN%2BYkVEPwUQ0%2BdrpXaPXB5g3mj1ymi48neFn3UKfUsFtvHauka0aX2RXZ0P5AAd57nTm1Szkd3rlHP%2B6lOFR%2BVTELhVfdR5AhUyxxKPGSe/zUoNDMYGIDRg8CUwYoasfYgtOlTbVw1ZZG/ebfwsTrrANcIMCaAZnkgHLeOwRmdq1sGhnnG6A%2Ba/rxpNolEavqrAreFWBTXRU2yh3YopauU92aBBZnJMMa3%2BEyV32HyREl32QIFAaffPDyExn2TnJPUDbDcTdljTDG7nyAYSqMQ0hE4EIKyZ6ZfCVjgLEZt36vf%2BTzRETHgOI6wL5VDWho/czZm5RnNCpQniDFd0f8PTm1Xl74d6WNQrw%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%24PS0YL69Tnt8Co2RF%247Cp1871Jsw1EtTxGbHa0Q9WDkL2noqSCIqctXseo4wtsQMWy0NiA2ZaPrtLupaVpFEzHMmhPvFs6Xt2o0u8ESiXi611zhDhF%2BvaDgUJU3fxhcZmhoJGCQxe0eNE%2B1svXGtd%2BnOB7vAwLMYwZfyChBf4D6CxgMiwxN6O9D5%2BiTWKYt5nVdvkeVC5Bx%2BwggNCRnfcX3sNchfLw2/JHPXpxiIW4GpFxfSBPnpyozyAWf5Vd/RY/JXvtolTdra/4uUPiTu4azAW76Gvsxg3dldc3Wyfv9nGe0yvh7NBUxvLG2BzAe7aFPfxe49t%2BSUv6rAWjGUOTTkIiDmArsVVVYU9HDnRAn6FSKwJF4jCqTqQsIzArrcffZssA5YrFhWE72%2B0bVIHT9tFHuvcmX7IdTesJoZJzpQ3A9%2B6XqnBkLpxwtXwmYXBSgTMFwOgFQyaxD9v%2BBDvXiE78XGyfFL08sAtltdJpFaO3n5Sf5NBr2n%2BAj9971KWBXKdFks9pH0XWl4V2UFk%2BRXh0aAEB%24%3D%3D
  • Target attr: name
  • Target Model Type: data/AuthorizedAdminHierarchy
  • Format: uri
  • Choices: []
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
  • 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
  • Choices: ["Licensed", "Unlicensed", "Unknown"]