[Index]

Model: relation/HcsUserREL

Users

Use this procedure to manually create a user.

Procedure

  1. Log in as the administrator at the hierarchy node where you want to create the user.
  2. Choose User Management > Users.
  3. Click Add.
  4. At a minimum, complete the following fields:
Fields Description
Username Sign-in username. This field is mandatory.
Entitlement Profile Choose the entitlement profile that specifies which devices and services the user is entitled to.
Role Choose the user's role. This field is mandatory.
Language

Choose the user's language.

Note:

If no language is selected, the language is inherited from the nearest hierarchy node (at or above the user) that has a default language configured. If no default language is configured anywhere in the hierarchy at or above the user, the user's language is English.

Note:

If a language is manually set for a user, that language remains unchanged even if the user is moved to a new place in the hierarchy. However, if the language is inherited, then the user's language changes when the user is moved to a hierarchy node that has a different default language.
Surname User's family name. This field is mandatory.
Email Address User email address.
  1. Click Save. The user is created.

Note

Updating

If the user password is updated, user passwords on Unified CM, Unity and WebEx are also updated if these have been provisioned for the user.

Note

Since different UC apps can have different password strictness rules, the update transaction will only succeed if the strictness rules of all the UC apps have been met. Otherwise, the update transaction will roll back.

Administrators should therefore choose a password that meets the requirements of all the UC apps.

Model Details: relation/HcsUserREL

Title Description Details
Username * Login in username.
  • Field Name: username
  • Type: String
  • MaxLength: 1024
Building Building name or number.
  • Field Name: buildingName.[n]
  • Type: Array
User Type
  • Field Name: userType
  • Type: String
  • Choices: ["CUCM Local", "VOSS Only", "CUCM-LDAP Synced", "VOSS-LDAP Synced", "Unknown"]
Country Country name.
  • Field Name: c
  • Type: String
  • MaxLength: 1024
Department Department names and numbers.
  • Field Name: departmentNumber.[n]
  • Type: Array
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: directoryUri
  • Type: String
Display Name
  • Field Name: displayName
  • Type: String
  • MaxLength: 1024
Employee Number
  • Field Name: employeeNumber
  • Type: String
  • MaxLength: 1024
Employee Type
  • Field Name: employeeType.[n]
  • Type: Array
Facsimile Telephone Number
  • Field Name: facsimileTelephoneNumber.[n]
  • Type: Array
Given Name Contains strings that are part of the person's name excluding surnames.
  • Field Name: givenName.[n]
  • Type: Array
Home Phone Contains strings that represent the user's home phone number(s).
  • Field Name: homePhone.[n]
  • Type: Array
IP Phone Contains strings that represent the user's IP phone number(s).
  • Field Name: ipPhone.[n]
  • Type: Array
Jabber ID
  • Field Name: jabberID
  • Type: String
  • MaxLength: 1024
City Contains the name of a person's locality.
  • Field Name: l
  • Type: String
  • MaxLength: 1024
Email Address
  • Field Name: mail.[n]
  • Type: Array
Manager
  • Field Name: manager.[n]
  • Type: Array
Member Of The user can be a member of a variety of groups.
  • Field Name: memberOf.[n]
  • Type: Array
Mobile
  • Field Name: mobile.[n]
  • Type: Array
Organization The name of the person's organization.
  • Field Name: o
  • Type: String
  • MaxLength: 1024
Object Class
  • Field Name: objectClass.[n]
  • Type: Array
Other Mailbox
  • Field Name: otherMailbox.[n]
  • Type: Array
Organizational Unit The name of the person's organization unit.
  • Field Name: ou.[n]
  • Type: Array
Photo URL
  • Field Name: photoURL
  • Type: String
  • MaxLength: 1024
Physical Delivery Office Name
  • Field Name: physicalDeliveryOfficeName.[n]
  • Type: Array
Postal Code Contains codes used by a Postal Service to identify postal service zones.
  • Field Name: postalCode.[n]
  • Type: Array
Preferred Language
  • Field Name: preferredLanguage
  • Type: String
  • MaxLength: 1024
Surname Contains strings for the family names of a person.
  • Field Name: sn.[n]
  • Type: Array
State Contains full names of states or provinces.
  • Field Name: st.[n]
  • Type: Array
Street Contains site information from a postal address.
  • Field Name: street.[n]
  • Type: Array
Telephone Number
  • Field Name: telephoneNumber.[n]
  • Type: Array
Timezone
  • Field Name: timezone
  • Type: String
  • MaxLength: 1024
Title
  • Field Name: title.[n]
  • Type: Array
Userid Contains computer login names for the user.
  • Field Name: uid.[n]
  • Type: Array
Unverified Mail Box
  • Field Name: unverifiedMailBox.[n]
  • Type: Array
Custom String 1 Custom String
  • Field Name: customString1
  • Type: String
Custom String 2 Custom String
  • Field Name: customString2
  • Type: String
Custom String 3 Custom String
  • Field Name: customString3
  • Type: String
Custom String 4 Custom String
  • Field Name: customString4
  • Type: String
Custom String 5 Custom String
  • Field Name: customString5
  • 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
Rbac
  • Field Name: rbac
  • Type: Object
User Name * User's Username.
  • Field Name: rbac.username
  • Type: String
Email Address The User email address.
  • Field Name: rbac.email
  • Type: String
First Name The User first name.
  • Field Name: rbac.first_name
  • Type: String
Last Name The User last name.
  • Field Name: rbac.last_name
  • Type: String
Password The User password.
  • Field Name: rbac.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: rbac.role
  • Type: String
  • Target: /api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24G2SWcmZsTB7ISxjZ%24BD2r4SuHoiz0oYLIuPxJVVgLJJybdWRpIuqtGZAKw2GCJbK%2BPJJBPMyny7HHx652f2QO6e58PewLseMTFnZWs7mJjD%2BGGnHIe1qCkLHqdgIlxeg0UFw805%2BA3P9FjQIY72w4LMnGfDT2SFVhwmFx0fC8JFLS2RTCN5vndNiZ3SAhUDDgB6UeurfHQgD9pVp13Ujow5exDvgTP30IbP1%2BiJXOlUF1POHvGD2lW4QFDfd6TMvXnHhKwpbFzjrCXO8g3pK1i/7p/t5JHMiJd3t17ISggm4ICmHpAlhwRFbU/jNtYxij/cesLHa616V7ZWY86j5RyBkSD/Mg4kWKK0Xr2LeYU9N79ZmmXK933p7svvuFEw%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: rbac.language
  • Type: String
  • Target: /api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%242g8pGLXgH9wQEJyh%24/LM4R834JpdQs2Nq7N8lPyav/iQOkqcCr1vBi7EMk9j0mZq3mpTM/BxctrSEz198Lz56qfUbo3Cy4Yshof/UfuHWmY47vW9NvS7Qao4%2BEwsJ23xGm895bIcSR24ZPyPJXwyxPzE41ZLz8n7Z48XDJ7StL1Sc7%2BDUIYuoqDqpsGSpZOowo5dqiskiQahAFN2YIvSgQXbH6CqgfsHpU6etMb/cURLbgP%2B2MgC%2BjfMPS2wt8p84lqXxGgr3A1NkJQYKsbsGO86cE6vnZATRmIblN24RJJc98TnB5lfaQGMoClmMKZGKE65EModYLh38F6QiDWX9YqD7cSnl1vUxqiByyZ9ufMYo00tQwTmL7zVoV2lYXsDVKYE%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: rbac.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: rbac.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: rbac.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: rbac.account_information.disabled
  • Type: Boolean
Reason for Disabled A description of why the account is disabled.
  • Field Name: rbac.account_information.reason_for_disabled
  • Type: String
Credential Policy Specifies the policy with the rules used to govern this user's credentials.
  • Field Name: rbac.account_information.credential_policy
  • Type: String
  • Target: /api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24PmnoXuoTH56kuASH%24D8bGpygx4YrodsUl%2BLeEYBN2bwMyJTeZMuuJFLYObT1J2im7Dbp/hc3Xl9aeOKx9z4bbAhUQ6iFyIzgpB8NuxaUsb2Pj2rPEWKOMZI/gbKBx9MR3htlZUqtUXfOhG10Vk51VTpXvErKzXwMQCFB0HZ4rGcnGWHOOUaDpLbF5KQmO78GW8FvPYhAQbpmsth8LQcHVeHh/kkEcRWpHyw%2B9VBZrs4SJ7SoYTpygKwFRKbYZRyE%2BqDfSYGUFd2VxCKrhD/NVC%2B%2B2uEMZo2fH%2BSS0QTukCOFdp3ZAoM3u4Q6Xw83m6G3lLBtLlsyg2OiobMRx1bsh4ObmbNqC2ola9NQtLEn7l%2BbxW3MtSrVw8d8i9%2BQGbJ9rkHyYucqWxhkioQ%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: rbac.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: rbac.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: rbac.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: rbac.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: rbac.account_information.num_of_failed_login_attempts
  • Type: Integer
  • Default: 0
Security Questions
  • Field Name: security_questions.[n]
  • Type: Array
Question *
  • Field Name: rbac.account_information.security_questions.[n].question
  • Type: String
  • MaxLength: 128
Answer *
  • Field Name: rbac.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: rbac.account_information.used_passwords.[n].password
  • Type: String
Time Created Time when password was created.
  • Field Name: rbac.account_information.used_passwords.[n].time_created
  • Type: String
Entitlement Profile
  • Field Name: rbac.entitlement_profile
  • Type: String
  • Target: /api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%249Vp3VoFPV3X1LeRQ%24SglMHgFuoj6XR3sPkypSnz7Kwhi%2BAJ6WQiGC3i5lMqQfPZuSZSaTSPhoab/XgMqk4SBRyHVY9v6ggJ3GNRurG4Bb9MrpRmsJwigUe6MorvzxgA6bxk1nKfihP86LzQLB0re9iX7q2w5y3hM2gPjr46eYSrAMkHTLrOPSG/TAZwnYxPekjpldQyJHgNC1YdHlbTopMyjXlmKxr0l2CGTIUvhcrdvi80vWOrOdYvahFQeCjk1E5T6XfbuSHUWKMZ/xyP1ZTgYkc7WUhIBcoomq2B6R8rWtqhRs4eoCXYppZSKkptLIXXf06qAWemy1qd0PW9GNNsJJXEfTdXzeH0dtiHJovzuYNAx%2B/Z4RQZ3oYYgcm62Ka0cwBIsDRg%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: rbac.sync_source
  • Type: String
  • Target: /api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%245xvedehbwAeznNlF%24TQ5U%2BS1I3Lft2FXMrBnB0ilq1TP4jd46DBZI5Qx2a7sn/kTBoQuFhTQgn%2BGl7o0oOztKK1NKpBVcj5ZUF0t9q7SnfGHVvpi0AXNGi31F2f0PRba46lf2BJNaYZyZDbZt6CTj8DMWMGJaO1ufvqU6SNBKBsr6fnvZEJxuo7NeFrG%2BNYsUP0hgI%2BJy9wBRlbJLTsq5l4OQmXQUFaJSZYr/3TSkKJCBGAwxQuUxlNl%2Bf%2BZ8eDi6nDFNqjWojwhua0eUtAxlrhbLu1Mek/4hW3A%2BihlT2XaZjsO7WxDcMyfSEZ56%2B%2BhOz2YHl6HP1wSINee66lfl9utZ7dd%2BKs0GwPwd6AcNgdIvsAgxRw8siw8l2FH0MLP%2BRkHeUOfurk8%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: rbac.sync_type
  • Type: String
  • Default: LOCAL
Building Name Building name or number.
  • Field Name: rbac.building_name
  • Type: String
Country Country name.
  • Field Name: rbac.country
  • Type: String
Department Department names and numbers.
  • Field Name: rbac.department
  • Type: String
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: rbac.directory_uri
  • Type: String
Display Name Display name of the user
  • Field Name: rbac.display_name
  • Type: String
Employee Number Employee number of the user
  • Field Name: rbac.employee_number
  • Type: String
Employee Type Employee type
  • Field Name: rbac.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: rbac.jabber_id
  • Type: String
City Contains the name of a person's locality.
  • Field Name: rbac.city
  • Type: String
Manager Manager.
  • Field Name: rbac.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: rbac.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: rbac.photo_url
  • Type: String
Physical Delivery Office Name Physical Delivery Office Name.
  • Field Name: rbac.physical_delivery_office_name
  • Type: String
Postal Code Contains code used by a Postal Service to identify postal service zones.
  • Field Name: rbac.postal_code
  • Type: String
Preferred Language Preferred Language.
  • Field Name: rbac.preferred_language
  • Type: String
State Contains full names of state or province.
  • Field Name: rbac.state
  • Type: String
Street Contains site information from a postal address.
  • Field Name: rbac.street
  • Type: String
Telephone Number Telephone Number.
  • Field Name: telephone_number.[n]
  • Type: Array
Timezone Timezone.
  • Field Name: rbac.timezone
  • Type: String
Title Title.
  • Field Name: rbac.title
  • Type: String
Unverified Mail Box Unverified Mail Box.
  • Field Name: rbac.unverified_mailbox
  • Type: String
Custom String 1 Custom String
  • Field Name: rbac.customString1
  • Type: String
Custom String 2 Custom String
  • Field Name: rbac.customString2
  • Type: String
Custom String 3 Custom String
  • Field Name: rbac.customString3
  • Type: String
Custom String 4 Custom String
  • Field Name: rbac.customString4
  • Type: String
Custom String 5 Custom String
  • Field Name: rbac.customString5
  • Type: String
Custom String 6 Custom String
  • Field Name: rbac.customString6
  • Type: String
Custom String 7 Custom String
  • Field Name: rbac.customString7
  • Type: String
Custom String 8 Custom String
  • Field Name: rbac.customString8
  • Type: String
Custom String 9 Custom String
  • Field Name: rbac.customString9
  • Type: String
Custom String 10 Custom String
  • Field Name: rbac.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: rbac.customBoolean1
  • Type: Boolean
Custom Boolean 2 Custom Boolean
  • Field Name: rbac.customBoolean2
  • Type: Boolean
Custom Boolean 3 Custom Boolean
  • Field Name: rbac.customBoolean3
  • Type: Boolean
Custom Boolean 4 Custom Boolean
  • Field Name: rbac.customBoolean4
  • Type: Boolean
Custom Boolean 5 Custom Boolean
  • Field Name: rbac.customBoolean5
  • Type: Boolean
Custom Boolean 6 Custom Boolean
  • Field Name: rbac.customBoolean6
  • Type: Boolean
Custom Boolean 7 Custom Boolean
  • Field Name: rbac.customBoolean7
  • Type: Boolean
Custom Boolean 8 Custom Boolean
  • Field Name: rbac.customBoolean8
  • Type: Boolean
Custom Boolean 9 Custom Boolean
  • Field Name: rbac.customBoolean9
  • Type: Boolean
Custom Boolean 10 Custom Boolean
  • Field Name: rbac.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: rbac.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: rbac.ldap_server
  • Type: String
  • Target: /api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24GZlzwYNDyUHMc6tC%24dMmBXcBs/or1RZW6zYWL5y9eBklYrTuIvKblVz7blz0szN7x8z2/rA9Mk69azbTUaqQg3vFiAAcgnk2O8JtdOWoMo7siqrPOi1NyLiTlcyXdByRiR4b0hre4EZFsvlmDPx1VN1bEpv76ubzDUClWzecMEjYfGRH1G7E8z7aEAweVtaN2hsjL4hfBKLjfXgk%2BXMjQne97GYXsVcqwYlVsxfyDlSC2lJbOXxbdo1jvfCMo/X6QyV4IySiAgoZ3EmGKGPafxu%2BJyYvxFTx5aU/pho4%2B49chOK8ao9AFIvcV01s7R6snGG%2BKcVgqhJYLILIWE/L1NGuTcjYz0GsGoHB0nMP3KZPi1/U%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: rbac.ldap_username
  • Type: String
SSO Identity Provider The entity id of the SSO Identity Provider.
  • Field Name: rbac.sso_idp
  • Type: String
  • Target: /api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24VpwS2gOsyPleXLP3%24VxEXg9JnRCR50pXBBN8uyRLwVI63visXL0%2B4/j7Az9vS9ciT9Q4dXBBfrcJO7SKl5zN2cg9XM7CiDXhhekBoTyllz4KtjTp%2BrH7UeAQqW5JXHXAP23BhgUYg4NgqoRY8Ejwm7kmBD9uEc5gQqGxJ0usqYxu988nem/6KUxV0QC/Yy8Uw6YzucTJlOHMNEGRPRDp40vEUwbQa5e1bWASv86AYTaJYHsdUcAsgHIMsGCS5oxjLfZ9s1g54fZLVdnUN6ldi81HuF2VAQcYwI21CTjfIvzBeURljz25x8ag8pvUSpl/mBZDJJoyBoltbmxIdkpa8uvk33CneC6CdBtXWWTpV2mjxViw3hy3DKZynRpoUtjaxrHQyTt8do9r6FDzh0hIPDvkw%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: rbac.sso_username
  • Type: String
User Type Indicate the user's login type. Default: Admin
  • Field Name: rbac.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: rbac.exclude_from_directory
  • Type: Boolean
Hybrid Status
  • Field Name: rbac.mvs_hybrid_status
  • Type: String
Primary Line
  • Field Name: rbac.mvs_primary_line
  • Type: String
Primary Class of Service
  • Field Name: rbac.mvs_primary_line_cos
  • Type: String
Extensions Extensions to select primary details from.
  • Field Name: mvs_extensions.[n]
  • Type: Array
Line
  • Field Name: rbac.mvs_extensions.[n].line
  • Type: String
Line E164
  • Field Name: rbac.mvs_extensions.[n].line_e164
  • Type: String
Class of Service
  • Field Name: rbac.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: rbac.username_avaya_system_manager
  • Type: String
Broadworks User Name The username corresponding to the the Username in Broadworks.
  • Field Name: rbac.username_broadworks
  • Type: String
Cisco Unity Connection User Name The username corresponding to the the Username in Cisco Unity Connection.
  • Field Name: rbac.username_cuc
  • Type: String
Cisco Unified Communication Manager User Name The username corresponding to the the Username in Cisco Unified Communication Manager.
  • Field Name: rbac.username_cucm
  • Type: String
HCMF User Name The username corresponding to the the Username in Cisco HCMF.
  • Field Name: rbac.username_hcmf
  • Type: String
LDAP Directory User Name The username corresponding to the the Username in the LDAP Directory.
  • Field Name: rbac.username_ldap
  • Type: String
Microsoft User Name The username corresponding to the the Microsoft Username.
  • Field Name: rbac.username_microsoft
  • Type: String
Microsoft Office 365 User Name The username corresponding to the the Username in Microsoft Office 365.
  • Field Name: rbac.username_ms_365
  • Type: String
Microsoft LDAP User Name The username corresponding to the the Username in Microsoft LDAP.
  • Field Name: rbac.username_ms_ldap
  • Type: String
Microsoft Teams User Name The username corresponding to the the Username in Microsoft Teams.
  • Field Name: rbac.username_ms_teams
  • Type: String
Open LDAP User Name The username corresponding to the the Username in Opoen LDAP.
  • Field Name: rbac.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: rbac.username_uccx
  • Type: String
Webex App User Name The username corresponding to the the Username in Webex App.
  • Field Name: rbac.username_webex_teams
  • Type: String
Zoom User Name The username corresponding to the the Username in Zoom.
  • Field Name: rbac.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: rbac.authorized_admin_hierarchy
  • Type: String
  • Target: /api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%249Fg2DnrF1yuWd8Vr%242CvzSCS/0Ss9LvNSC%2B73H/0HkgprMJ3Sorht4yULcfPI8fNKLMWnO/u1aC6mhfeFKqSBE7AmeYBNzrqpxQwvVf4nl%2Bv2vBxqRntfNuxNbgTzEq3rcYTz87dmlKVQKKlbjQXOVUYwmeUcXQko4nUUbuhOZg1QZVRlNhp1O4/Of6703hvMMVqLIFkRFggJGgvELrTmT0NzNyDAFczgdPDUw%2B%2Bpu7qiMf1vRdWLlbf3JYsQJcRJnh20LXZuKuHcBPiOKPG1Cj%2BXxeMexzDV2mU2wZQzT1XPQB/Yddqt7KuN0b38UgC23mDzUZ3G3w0E3h0%2BIKRjqH2M9IK3QHuibpzcmuRyBXU2NPYvSWImqvBKwWK4BZ7sc63TFBZykhTpbcv8APn5DBnG%24%3D%3D
  • Target attr: name
  • Target Model Type: data/AuthorizedAdminHierarchy
  • Format: uri
  • Choices: []
Hf View
  • Field Name: hf_view
  • Type: Object
Password
  • Field Name: hf_view.password
  • Type: String
  • Is Password: True
Ps
  • Field Name: ps
  • Type: Object
Username *
  • Field Name: ps.username
  • Type: String
  • MaxLength: 1024
LDAP Server
  • Field Name: ps.ldap_server
  • Type: String
  • Target: /api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24GZlzwYNDyUHMc6tC%24dMmBXcBs/or1RZW6zYWL5y9eBklYrTuIvKblVz7blz0szN7x8z2/rA9Mk69azbTUaqQg3vFiAAcgnk2O8JtdOWoMo7siqrPOi1NyLiTlcyXdByRiR4b0hre4EZFsvlmDPx1VN1bEpv76ubzDUClWzecMEjYfGRH1G7E8z7aEAweVtaN2hsjL4hfBKLjfXgk%2BXMjQne97GYXsVcqwYlVsxfyDlSC2lJbOXxbdo1jvfCMo/X6QyV4IySiAgoZ3EmGKGPafxu%2BJyYvxFTx5aU/pho4%2B49chOK8ao9AFIvcV01s7R6snGG%2BKcVgqhJYLILIWE/L1NGuTcjYz0GsGoHB0nMP3KZPi1/U%3D%24%3D%3D
  • Target Model Type: data/Ldap
  • MaxLength: 1024
  • Format: uri
  • Choices: []
LDAP Device User PKID
  • Field Name: ps.ldap_device_user_pkid
  • Type: String
  • MaxLength: 1024
CUCM Server
  • Field Name: ps.cucm_server
  • Type: String
  • Target: /api/data/CallManager/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24VO8MfBVTOo0n36hG%24edwq6sR6qW/oTPT5JLWLRXOOGyIXJTBIL3vcMphHtLY5UTUae/57ZRPhLuSdatvy0LXVsVwo4LvL4Iwr3XMuqVCFg2XtxJQKsv3kxnxsXBLnafDiSkJUKyHbxwO64kbYr5soqtUb505/C/TijXSw3EjvN4m%2BB4UMVYOKoEtWOVUOFnVD2PcpyTPY3GHOaJr9hPXxfr9wgzKM/SPdt7exrBVFKXeMfJIGtCgHoZORP8krWiHL130pr5cnyBIvQlhW9g%2BXzGQBHmgs2pQsI1U7I5fGk8404iWnhWPx%2BKutRFdkP64v5U44/5wylTLZ6h86/HsikQHR6bwZT8KepE%2B6DqGwAxvAA6BfJOGjX20i%24%3D%3D
  • Target Model Type: data/CallManager
  • MaxLength: 1024
  • Format: uri
  • Choices: []
CUCM Device User PKID
  • Field Name: ps.cucm_device_user_pkid
  • Type: String
  • MaxLength: 1024
Synced To
  • Field Name: ps.sync_to_hn
  • Type: String
  • Target: /api/data/HierarchyNode/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%241iQB9sePDKcBV8fd%24UspN1zRWwzxbK8EV9qmZh2BPt8kIcVs4pj1m%2BG/6Nwd8DImX1ZQ9z7tq%2BjdR9i/4SLljdIxRL850sOlkKJgcQXfnnsIAzjMFrzsTd2kEf8D2Yy1Vl5euGJMDUaVGNQh3PsDFXxmnadxLAovEBkulUDoczDI%2Be3ZevotX5IUUBq00gmoxgJ6jonvBsAvF7peL0VxhM0k4E5Sb5LFRDC/lBKGynnFioHe4FYHUrKALdrIbREwR6chAv4yIZ9T9Ui4rF579DqQRTFAGcn9C6uHLIrlvvg7GmlytYjI83nHoI0jJJqYl7M7YgtokeyK83QuFjRBOFoyxq0ivHy2pNQnwtR/bLM96fmx6v4IzAixJebA%3D%24%3D%3D
  • Target Model Type: data/HierarchyNode
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Entitlement Profile
  • Field Name: ps.entitlement_profile
  • Type: String
  • Target: /api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%249Vp3VoFPV3X1LeRQ%24SglMHgFuoj6XR3sPkypSnz7Kwhi%2BAJ6WQiGC3i5lMqQfPZuSZSaTSPhoab/XgMqk4SBRyHVY9v6ggJ3GNRurG4Bb9MrpRmsJwigUe6MorvzxgA6bxk1nKfihP86LzQLB0re9iX7q2w5y3hM2gPjr46eYSrAMkHTLrOPSG/TAZwnYxPekjpldQyJHgNC1YdHlbTopMyjXlmKxr0l2CGTIUvhcrdvi80vWOrOdYvahFQeCjk1E5T6XfbuSHUWKMZ/xyP1ZTgYkc7WUhIBcoomq2B6R8rWtqhRs4eoCXYppZSKkptLIXXf06qAWemy1qd0PW9GNNsJJXEfTdXzeH0dtiHJovzuYNAx%2B/Z4RQZ3oYYgcm62Ka0cwBIsDRg%3D%3D%24%3D%3D
  • Target Model Type: data/HcsEntitlementProfileDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Ldap
  • Field Name: ldap
  • Type: Object
LDAP Username * The login attribute of the associated LDAP device model instance
  • Field Name: ldap.ldap_username
  • Type: String
Data Username The data username that is mapped to the associated LDAP device model instance.
  • Field Name: ldap.data_username
  • Type: String
  • Target: /api/data/User/choices/?field=username&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24wz2DPvPFuiMBSWxE%24JwHFnGdY0qy7mrB/hFS1fWuyksMmvkT%2BsD%2BixORJBwSa1WgQcmx9jS6CGP3N43nEg3ltqkqpnsQmfm9pw15LdY80bf9f2h7F7MD6sL67EbrGakjGwK0xonX0wj9ECbNtQa1r5NBUqr9KIxoMPdlqRhDk3hnOMIXOyz4/LLQgOib7GNvuipIug1H9i4VvdmltSekH564Blayi/mYJsawLBuWUBhAiSfOzLiJfD2drawNXHxqqBWALD6OzlDPydI58Q3U5sSzGl/kqkea%2B4eaoz0z1KcM%2BZTbhZC7a/hUNKW6MDMzUQqb05QvpSqXuqWdaRgCBo7y046Wjh7CQDXhIke5ftzcFbs2AACx29ESp5%2BIuWEnyYPs%3D%24%3D%3D
  • Target attr: username
  • Target Model Type: data/User
  • Format: uri
  • Choices: []
LDAP Server A reference to the LDAP server which this user must authenticate against.
  • Field Name: ldap.ldap_server
  • Type: String
  • Target: /api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24GZlzwYNDyUHMc6tC%24dMmBXcBs/or1RZW6zYWL5y9eBklYrTuIvKblVz7blz0szN7x8z2/rA9Mk69azbTUaqQg3vFiAAcgnk2O8JtdOWoMo7siqrPOi1NyLiTlcyXdByRiR4b0hre4EZFsvlmDPx1VN1bEpv76ubzDUClWzecMEjYfGRH1G7E8z7aEAweVtaN2hsjL4hfBKLjfXgk%2BXMjQne97GYXsVcqwYlVsxfyDlSC2lJbOXxbdo1jvfCMo/X6QyV4IySiAgoZ3EmGKGPafxu%2BJyYvxFTx5aU/pho4%2B49chOK8ao9AFIvcV01s7R6snGG%2BKcVgqhJYLILIWE/L1NGuTcjYz0GsGoHB0nMP3KZPi1/U%3D%24%3D%3D
  • Target Model Type: data/Ldap
  • Format: uri
  • Choices: []
Sso User
  • Field Name: ssoUser.[n]
  • Type: Array
  • Cardinality: [0..1]
SSO Identity Provider * The entity id of the SSO Identity Provider.
  • Field Name: ssoUser.[n].sso_idp
  • Type: String
  • Target: /api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24VpwS2gOsyPleXLP3%24VxEXg9JnRCR50pXBBN8uyRLwVI63visXL0%2B4/j7Az9vS9ciT9Q4dXBBfrcJO7SKl5zN2cg9XM7CiDXhhekBoTyllz4KtjTp%2BrH7UeAQqW5JXHXAP23BhgUYg4NgqoRY8Ejwm7kmBD9uEc5gQqGxJ0usqYxu988nem/6KUxV0QC/Yy8Uw6YzucTJlOHMNEGRPRDp40vEUwbQa5e1bWASv86AYTaJYHsdUcAsgHIMsGCS5oxjLfZ9s1g54fZLVdnUN6ldi81HuF2VAQcYwI21CTjfIvzBeURljz25x8ag8pvUSpl/mBZDJJoyBoltbmxIdkpa8uvk33CneC6CdBtXWWTpV2mjxViw3hy3DKZynRpoUtjaxrHQyTt8do9r6FDzh0hIPDvkw%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: ssoUser.[n].sso_username
  • Type: String
Data Username The data username that is mapped to the associated SSO authenticated user.
  • Field Name: ssoUser.[n].data_username
  • Type: String
  • Target: /api/data/User/choices/?field=username&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24wz2DPvPFuiMBSWxE%24JwHFnGdY0qy7mrB/hFS1fWuyksMmvkT%2BsD%2BixORJBwSa1WgQcmx9jS6CGP3N43nEg3ltqkqpnsQmfm9pw15LdY80bf9f2h7F7MD6sL67EbrGakjGwK0xonX0wj9ECbNtQa1r5NBUqr9KIxoMPdlqRhDk3hnOMIXOyz4/LLQgOib7GNvuipIug1H9i4VvdmltSekH564Blayi/mYJsawLBuWUBhAiSfOzLiJfD2drawNXHxqqBWALD6OzlDPydI58Q3U5sSzGl/kqkea%2B4eaoz0z1KcM%2BZTbhZC7a/hUNKW6MDMzUQqb05QvpSqXuqWdaRgCBo7y046Wjh7CQDXhIke5ftzcFbs2AACx29ESp5%2BIuWEnyYPs%3D%24%3D%3D
  • Target attr: username
  • Target Model Type: data/User
  • Format: uri
  • Choices: []
Sdr User
  • Field Name: sdrUser.[n]
  • Type: Array
  • Cardinality: [0..1]
identityStoreUUID
  • Field Name: sdrUser.[n].identityStoreUUID
  • Type: ["String", "Null"]
directoryDomain *
  • Field Name: sdrUser.[n].directoryDomain
  • Type: String
  • Target: /api/device/hcmf/DirectoryDomain/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24i2cp6fhXvzv5LoDD%244zl2TLjHBX7ltlQTAdcKCgwWmQoxUUW7s8t1QjMDfx5hWyJvDZoVGQmxP14TmqEibBOFzLoWSTaUetA04%2B0c2hUWeEuFthD7IPhT8OVjEycCu9kN2Y/VplCNqllaRq586YHptieFMEyvN0QiJSwrDtvrdwrv1G1i6nxSc8AH1V7LDkeH94M5IncNHetDUQ7gvka21hvnb3/I2I6Kl%2BSUY/2tacoeMuMq9VubRXwwcIsCqrrOLJPIJX9nD/55S816B/tFXkOaVnDn2%2BzyQ0V5n7rx28dBwlAHhlL5lNrX6amtPxkwkq8hdQAScoHtnhR8%2BPmOFAt96LNHzFYcoXujAc%2BwdUZYRA17uhvyY5UBoT2hCd4Qc/SmW3c%3D%24%3D%3D
  • Target Model Type: device/hcmf/DirectoryDomain
  • Format: uri
  • Choices: []
description
  • Field Name: sdrUser.[n].description
  • Type: ["String", "Null"]
bkDirectoryDomain_name
  • Field Name: sdrUser.[n].bkDirectoryDomain_name
  • Type: ["String", "Null"]
userName *
  • Field Name: sdrUser.[n].userName
  • Type: String
street
  • Field Name: sdrUser.[n].street
  • Type: ["String", "Null"]
emailAddress
  • Field Name: sdrUser.[n].emailAddress
  • Type: ["String", "Null"]
cdmUpdateTimestamp
  • Field Name: sdrUser.[n].cdmUpdateTimestamp
  • Type: ["String", "Null"]
building
  • Field Name: sdrUser.[n].building
  • Type: ["String", "Null"]
id
  • Field Name: sdrUser.[n].id
  • Type: ["String", "Null"]
isDeletable
  • Field Name: sdrUser.[n].isDeletable
  • Type: ["Boolean", "Null"]
telephoneNumber
  • Field Name: sdrUser.[n].telephoneNumber
  • Type: ["String", "Null"]
city
  • Field Name: sdrUser.[n].city
  • Type: ["String", "Null"]
displayName
  • Field Name: sdrUser.[n].displayName
  • Type: ["String", "Null"]
customerLocation
  • Field Name: sdrUser.[n].customerLocation
  • Type: ["String", "Null"]
  • Target: /api/device/hcmf/CustomerLocation/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24gZZT19Ykr4wNjLle%24CEpTxV2Xmd2qylMZFryC2VrUqjIYvMmI31hM27NBZIRHlzYwxqiGUSQDqtfa8zb7/UEs371J8uwrI2bdcLmwJ%2BVwbeQQs/VPW8GRSsUpbzHLu%2BVejXNcQ3rkm/ZLPQb0T2awZRoxyDNVZpCau96OrrEuoVSI5xMtMgZ6J2XyJms/IaRZb%2BjrvJBoGcm6%2BsZhHrkxiPoSP/KAJiqWpq6ULVZ7Guf6k%2B8tk7aVuPuDe//kvAxqMQBboiZtl1aI5/xamkVGNUOTY/vzThESUzpqvef2mfJknDQkorKtPubKPclDlQHd2V/xaHWg1aNXj9Jn69Ri8VIecVOCoHGRBxEnRg4NIo1/Ix/mkMrsxtGkLRbHQdhWwp%2Bxb/KW%24%3D%3D
  • Target Model Type: device/hcmf/CustomerLocation
  • Format: uri
  • Choices: []
firstName
  • Field Name: sdrUser.[n].firstName
  • Type: ["String", "Null"]
scopeOrgUnit
  • Field Name: sdrUser.[n].scopeOrgUnit
  • Type: ["String", "Null"]
  • Target: /api/device/hcmf/OrgUnit/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24tQSmGc9MCI5WD123%24ODR6g3h9WyX4/YfR1rupVDzohpg3uBv6/PcEkPYd3jMeJeVfE70HISZb4IlNFlFC6zOP9p7RWBpPZtTnjCo3RxB039OEXT2OOhonkMM%2BsFkKwRr6YZc%2BBdWMp8FJoGoG/gSdG1%2B66r7XQLt4hHqRL0PyWcJULhApUWLmjdZ%2BXJicQqq%2BqMHgcVsazs3DBBFL29g3%2BLCS3rU6nK3g6T26eThN0h6MBM1REm%2BqFnfo17m5Osxlfbz1imyhTBWhD9c5tLsOq0Hr19WSKX0RwD2lxlRiwKsJTxmjSCWPIJmmNu0GYaJFbqtNYb7YCkbVlslpqswGI5vUxTImfy1%2BvaVYwNKpPs8kOobqVhqWSkVdiA6o%24%3D%3D
  • Target Model Type: device/hcmf/OrgUnit
  • Format: uri
  • Choices: []
typeDMARoles
  • Field Name: sdrUser.[n].typeDMARoles
  • Type: ["String", "Null"]
  • Choices: ["PROVIDER_ADMIN", "PROVIDER_OPERATOR", "RESELLER_ADMIN", "RESELLER_OPERATOR", "CUSTOMER_ADMIN", "CUSTOMER_OPERATOR", "PROVIDER_ADMIN_SA", "PROVIDER_OPERATOR_SA", "PROVIDER_ADMIN_FF", "PROVIDER_OPERATOR_FF", "RESELLER_ADMIN_SA", "RESELLER_OPERATOR_SA", "RESELLER_ADMIN_FF", "RESELLER_OPERATOR_FF", "CUSTOMER_ADMIN_SA", "CUSTOMER_OPERATOR_SA", "CUSTOMER_ADMIN_FF", "CUSTOMER_OPERATOR_FF"]
state
  • Field Name: sdrUser.[n].state
  • Type: ["String", "Null"]
isModifiable
  • Field Name: sdrUser.[n].isModifiable
  • Type: ["Boolean", "Null"]
lastName
  • Field Name: sdrUser.[n].lastName
  • Type: ["String", "Null"]
postalCode
  • Field Name: sdrUser.[n].postalCode
  • Type: ["String", "Null"]
country
  • Field Name: sdrUser.[n].country
  • Type: ["String", "Null"]
type * Default: User
  • Field Name: sdrUser.[n].type
  • Type: String
  • Default: User
syncTimestamp
  • Field Name: sdrUser.[n].syncTimestamp
  • Type: ["String", "Null"]