[Index]
WebEx User add/mod/del relation.
Model ref.: relation/WebExClient
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"description": "User's Username.",
"title": "User Name"
},
"email": {
"required": false,
"type": "string",
"description": "The User email address.",
"title": "Email Address"
},
"first_name": {
"type": "string",
"description": "The User first name.",
"title": "First Name"
},
"last_name": {
"type": "string",
"description": "The User last name.",
"title": "Last Name"
},
"password": {
"is_password": true,
"description": "The User password.",
"title": "Password",
"pattern": ".{8,}",
"type": "string",
"store_encrypted": true
},
"role": {
"description": "The role to which the user belongs. See: Role.",
"format": "uri",
"required": true,
"target_attr": "name",
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Role",
"type": "string",
"target_model_type": "data/Role",
"choices": []
},
"language": {
"description": "The preferred language for this user.",
"format": "uri",
"default": "en-us",
"required": false,
"target_attr": "lcid",
"target": "/api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Language",
"type": "string",
"target_model_type": "data/Language",
"choices": []
},
"set_language": {
"description": "Indicate if the user's language is set by language default in the hierarchy.",
"title": "Set by Default Language",
"default": false,
"required": false,
"type": "boolean"
},
"account_information": {
"description": "Additional account information for the given user.",
"title": "Account Information",
"required": false,
"type": "object",
"properties": {
"change_password_on_login": {
"required": false,
"type": "boolean",
"description": "Indicates if the user must be forced to change their password the next time that login.",
"title": "Change Password on Next Login"
},
"locked": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been locked to prevent the user from logging in.",
"title": "Locked"
},
"disabled": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.",
"title": "Disabled"
},
"reason_for_disabled": {
"required": false,
"type": "string",
"description": "A description of why the account is disabled.",
"title": "Reason for Disabled"
},
"credential_policy": {
"description": "Specifies the policy with the rules used to govern this user's credentials.",
"format": "uri",
"required": false,
"target_attr": "name",
"target": "/api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Credential Policy",
"type": "string",
"target_model_type": "data/CredentialPolicy",
"choices": []
},
"failed_login_lock_date": {
"description": "The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.",
"format": "date-time",
"required": false,
"title": "Time Locked Due to Failed Login Attempts",
"type": "string"
},
"password_last_change_time": {
"description": "The time when the password was last changed.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Password Change",
"type": "string"
},
"password_last_change_time_by_user": {
"description": "The time when the password was last changed by the user.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Password Change By User",
"type": "string"
},
"last_login_time": {
"description": "The time the user last logged in successfully.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Time of Last Successful Login",
"type": "string"
},
"num_of_failed_login_attempts": {
"description": "The total number of failed login attempts since last successful login.",
"title": "Number of Failed Login Attempts Since Last Successful Login",
"default": "0",
"required": false,
"type": "integer"
},
"security_questions": {
"items": {
"type": "object",
"properties": {
"question": {
"title": "Question",
"required": true,
"displayable": true,
"maxLength": 128,
"type": "string"
},
"answer": {
"maxLength": 128,
"required": true,
"type": "string",
"title": "Answer"
}
}
},
"type": "array",
"title": "Security Questions"
},
"used_passwords": {
"items": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "Used password",
"title": "Password"
},
"time_created": {
"type": "string",
"description": "Time when password was created.",
"title": "Time Created"
}
}
},
"type": "array",
"description": "List of passwords that have been used by user.",
"title": "Used Passwords"
}
}
},
"entitlement_profile": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"title": "Entitlement Profile",
"type": "string",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HcsEntitlementProfileDAT",
"choices": []
},
"sync_source": {
"target": "/api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"default": "LOCAL",
"title": "Sync Source",
"target_attr": "name",
"type": "string",
"description": "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).",
"target_model_type": "data/UserSyncSource",
"choices": []
},
"sync_type": {
"default": "LOCAL",
"type": "string",
"description": "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.",
"title": "Sync Type"
},
"building_name": {
"type": "string",
"description": "Building name or number.",
"title": "Building Name"
},
"country": {
"type": "string",
"description": "Country name.",
"title": "Country"
},
"department": {
"type": "string",
"description": "Department names and numbers.",
"title": "Department"
},
"directory_uri": {
"type": "string",
"description": "Alphanumeric Directory URI (e.g. SIP URI)",
"title": "Directory URI"
},
"display_name": {
"type": "string",
"description": "Display name of the user",
"title": "Display Name"
},
"employee_number": {
"type": "string",
"description": "Employee number of the user",
"title": "Employee Number"
},
"employee_type": {
"type": "string",
"description": "Employee type",
"title": "Employee Type"
},
"facsimile_telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's facsimile telephone Number(s).",
"title": "Facsimile Telephone Number"
},
"home_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's home phone number(s).",
"title": "Home Phone"
},
"ip_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP phone number(s).",
"title": "IP Phone"
},
"jabber_id": {
"type": "string",
"description": "Jabber ID",
"title": "Jabber ID"
},
"city": {
"type": "string",
"description": "Contains the name of a person's locality.",
"title": "City"
},
"manager": {
"type": "string",
"description": "Manager.",
"title": "Manager"
},
"member_of": {
"items": {
"type": "string"
},
"type": "array",
"description": "The user can be a member of a variety of groups.",
"title": "Member Of"
},
"mobile": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP mobile number(s).",
"title": "Mobile"
},
"organization": {
"type": "string",
"description": "The name of the person's organization.",
"title": "Organization"
},
"object_class": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Object Class"
},
"other_mailbox": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Other Mailbox"
},
"ou": {
"description": "The name of the person's organization unit.",
"title": "Organizational Unit",
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array"
},
"photo_url": {
"type": "string",
"description": "Photo URL.",
"title": "Photo URL"
},
"physical_delivery_office_name": {
"type": "string",
"description": "Physical Delivery Office Name.",
"title": "Physical Delivery Office Name"
},
"postal_code": {
"type": "string",
"description": "Contains code used by a Postal Service to identify postal service zones.",
"title": "Postal Code"
},
"preferred_language": {
"type": "string",
"description": "Preferred Language.",
"title": "Preferred Language"
},
"state": {
"type": "string",
"description": "Contains full names of state or province.",
"title": "State"
},
"street": {
"type": "string",
"description": "Contains site information from a postal address.",
"title": "Street"
},
"telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Telephone Number.",
"title": "Telephone Number"
},
"timezone": {
"type": "string",
"description": "Timezone.",
"title": "Timezone"
},
"title": {
"type": "string",
"description": "Title.",
"title": "Title"
},
"unverified_mailbox": {
"type": "string",
"description": "Unverified Mail Box.",
"title": "Unverified Mail Box"
},
"customString1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"customString2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"customString3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"customString4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"customString5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"customString6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"customString7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"customString8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"customString9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"customString10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"customListOfStrings1": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 1"
},
"customListOfStrings2": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 2"
},
"customListOfStrings3": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 3"
},
"customListOfStrings4": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 4"
},
"customListOfStrings5": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 5"
},
"customListOfStrings6": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 6"
},
"customListOfStrings7": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 7"
},
"customListOfStrings8": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 8"
},
"customListOfStrings9": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 9"
},
"customListOfStrings10": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 10"
},
"customBoolean1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"customBoolean2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"customBoolean3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"customBoolean4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"customBoolean5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"customBoolean6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"customBoolean7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"customBoolean8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"customBoolean9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"customBoolean10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"auth_method": {
"description": "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.",
"title": "Auth Method",
"default": "Local",
"choices": [
{
"value": "Local",
"title": "Local"
},
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "LDAP",
"title": "LDAP"
},
{
"value": "SSO",
"title": "SSO"
}
],
"type": "string"
},
"ldap_server": {
"description": "A reference to the LDAP server which this user must authenticate against.",
"format": "uri",
"required": false,
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "LDAP Server",
"type": "string",
"target_model_type": "data/Ldap",
"choices": []
},
"ldap_username": {
"type": "string",
"description": "The login attribute of the associated LDAP device model instance",
"title": "LDAP Username"
},
"sso_idp": {
"description": "The entity id of the SSO Identity Provider.",
"format": "uri",
"required": false,
"target_attr": "entity_id",
"target": "/api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "SSO Identity Provider",
"type": "string",
"target_model_type": "data/SsoIdentityProvider",
"choices": []
},
"sso_username": {
"required": false,
"type": "string",
"description": "The name identifier that is used for an SSO authenticated user.",
"title": "SSO Username"
},
"user_type": {
"description": "Indicate the user's login type.",
"title": "User Type",
"default": "Admin",
"required": false,
"choices": [
{
"value": "Admin",
"title": "Admin"
},
{
"value": "End User",
"title": "End User"
},
{
"value": "End User + Admin",
"title": "End User + Admin"
}
],
"type": "string"
},
"exclude_from_directory": {
"type": "boolean",
"description": "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.",
"title": "Exclude from Directory"
},
"mvs_hybrid_status": {
"required": false,
"type": "string",
"title": "Hybrid Status"
},
"mvs_primary_line": {
"type": "string",
"title": "Primary Line"
},
"mvs_primary_line_cos": {
"type": "string",
"title": "Primary Class of Service"
},
"mvs_extensions": {
"description": "Extensions to select primary details from.",
"title": "Extensions",
"items": {
"type": "object",
"properties": {
"line": {
"type": "string",
"title": "Line"
},
"line_e164": {
"type": "string",
"title": "Line E164"
},
"line_cos": {
"type": "string",
"title": "Class of Service"
}
}
},
"required": false,
"type": "array"
},
"username_avaya_system_manager": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Avaya System Manager.",
"title": "Avaya System Manager User Name"
},
"username_broadworks": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Broadworks.",
"title": "Broadworks User Name"
},
"username_cuc": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unity Connection.",
"title": "Cisco Unity Connection User Name"
},
"username_cucm": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Communication Manager.",
"title": "Cisco Unified Communication Manager User Name"
},
"username_hcmf": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco HCMF.",
"title": "HCMF User Name"
},
"username_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in the LDAP Directory.",
"title": "LDAP Directory User Name"
},
"username_microsoft": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Microsoft Username.",
"title": "Microsoft User Name"
},
"username_ms_365": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft Office 365.",
"title": "Microsoft Office 365 User Name"
},
"username_ms_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft LDAP.",
"title": "Microsoft LDAP User Name"
},
"username_ms_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft Teams.",
"title": "Microsoft Teams User Name"
},
"username_open_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Opoen LDAP.",
"title": "Open LDAP User Name"
},
"username_uccx": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Contact Centre Express.",
"title": "Cisco Unified Contact Centre Express User Name"
},
"username_webex_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Webex App.",
"title": "Webex App User Name"
},
"username_zoom": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Zoom.",
"title": "Zoom User Name"
},
"authorized_admin_hierarchy": {
"description": "A reference an Authorized Admin Hierarchy instance that defines this user's administrative capabilities. This enables administrative capabilities for end users.",
"format": "uri",
"required": false,
"target_attr": "name",
"target": "/api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Authorized Admin Hierarchy",
"type": "string",
"target_model_type": "data/AuthorizedAdminHierarchy",
"choices": []
},
"license_audit_details": {
"description": "License Audit Information.",
"title": "License Audit Details",
"required": false,
"type": "object",
"properties": {
"last_checked": {
"description": "The last time the License Audit Details were updated.",
"format": "date-time",
"required": false,
"readonly": true,
"title": "Last Checked",
"type": "string"
},
"status": {
"description": "The License Audit status of the user.",
"title": "License Audit Status",
"default": "Unknown",
"required": false,
"choices": [
{
"value": "Licensed",
"title": "Licensed"
},
{
"value": "Unlicensed",
"title": "Unlicensed"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"readonly": true,
"type": "string"
}
}
},
"WebExUser": {
"title": "Web Ex User",
"type": "array",
"items": {
"type": "object",
"properties": {
"timeZoneWithDST": {
"title": "Time Zone With DST",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"remoteSupport": {
"title": "Remote Support",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"recording": {
"name": "recording",
"title": "Recording",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"type": {
"name": "type",
"title": "Type",
"minItems": 0,
"required": false,
"choices": [
[
"NBR",
"NBR"
],
[
"LOCAL",
"LOCAL"
]
],
"maxItems": 1,
"type": "string"
},
"enforce": {
"name": "enforce",
"title": "Enforce",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "boolean"
},
"location": {
"name": "location",
"title": "Location",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"autoRequest": {
"name": "autoRequest",
"title": "Auto Request",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"enable": {
"name": "enable",
"title": "Enable",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "boolean"
},
"request": {
"name": "request",
"title": "Request",
"minItems": 0,
"required": false,
"choices": [
[
"DESK_VIEW",
"DESK_VIEW"
],
[
"DESK_CTRL",
"DESK_CTRL"
],
[
"APP_VIEW",
"APP_VIEW"
],
[
"APP_CTRL",
"APP_CTRL"
]
],
"maxItems": 1,
"type": "string"
}
}
},
"sharingView": {
"name": "sharingView",
"title": "Sharing View",
"minItems": 0,
"required": false,
"choices": [
[
"FS_SCALE",
"FS_SCALE"
],
[
"FS",
"FS"
],
[
"WIN_SCALE",
"WIN_SCALE"
],
[
"WIN",
"WIN"
]
],
"maxItems": 1,
"type": "string"
},
"sharingColor": {
"name": "sharingColor",
"title": "Sharing Color",
"minItems": 0,
"required": false,
"choices": [
[
"256",
"256"
],
[
"16BIT",
"16BIT"
]
],
"maxItems": 1,
"type": "string"
},
"defaultClient": {
"name": "defaultClient",
"title": "Default Client",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"type": {
"name": "type",
"title": "Type",
"minItems": 1,
"required": true,
"choices": [
[
"MULTI_SESS",
"MULTI_SESS"
],
[
"SINGLE_SESS",
"SINGLE_SESS"
]
],
"maxItems": 1,
"type": "string"
},
"singleSessClient": {
"name": "singleSessClient",
"title": "Single Sess Client",
"minItems": 0,
"required": false,
"choices": [
[
"NEW_CONSL",
"NEW_CONSL"
],
[
"OLD_CONSL",
"OLD_CONSL"
]
],
"maxItems": 1,
"type": "string"
}
}
}
}
},
"languageID": {
"title": "Language ID",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"locale": {
"title": "Locale",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"phones": {
"title": "Phones",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"phone2": {
"name": "phone2",
"title": "Phone2",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"pager": {
"name": "pager",
"title": "Pager",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"mobilePhone2": {
"name": "mobilePhone2",
"title": "Mobile Phone2",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"PIN": {
"name": "PIN",
"title": "PIN",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"userId": {
"title": "User Id",
"minItems": 0,
"required": false,
"default": -1,
"maxItems": 1,
"type": "integer"
},
"webExId": {
"title": "Web Ex Id",
"minItems": 1,
"required": true,
"readonly": true,
"maxItems": 1,
"type": "string"
},
"personalTeleconf": {
"title": "Personal Teleconf",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"joinBeforeHost": {
"name": "joinBeforeHost",
"title": "Join Before Host",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"account": {
"name": "account",
"title": "Account",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"accountIndex": {
"name": "accountIndex",
"title": "Account Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"subscriberAccessCode": {
"name": "subscriberAccessCode",
"title": "Subscriber Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"autoGenerate": {
"name": "autoGenerate",
"title": "Auto Generate",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"participantLimitedAccessCode": {
"name": "participantLimitedAccessCode",
"title": "Participant Limited Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"participantFullAccessCode": {
"name": "participantFullAccessCode",
"title": "Participant Full Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"joinBeforeHost": {
"name": "joinBeforeHost",
"title": "Join Before Host",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"defaultFlag": {
"name": "defaultFlag",
"title": "Default Flag",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"delete": {
"name": "delete",
"title": "Delete",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"required": false,
"maxItems": 3,
"type": "array"
}
}
},
"expirationDate": {
"title": "Expiration Date",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"email2": {
"title": "Email2",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"personalUrl": {
"title": "Personal Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"commOptions": {
"title": "Comm Options",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"electronicInfo": {
"name": "electronicInfo",
"title": "Electronic Info",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"fax": {
"name": "fax",
"title": "Fax",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"phone": {
"name": "phone",
"title": "Phone",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"promos": {
"name": "promos",
"title": "Promos",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"trainingInfo": {
"name": "trainingInfo",
"title": "Training Info",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"press": {
"name": "press",
"title": "Press",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"mail": {
"name": "mail",
"title": "Mail",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"prodAnnounce": {
"name": "prodAnnounce",
"title": "Prod Announce",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"email": {
"name": "email",
"title": "Email",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"meetingTypes": {
"title": "Meeting Types",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"meetingType": {
"name": "meetingType",
"title": "Meeting Type",
"minItems": 0,
"items": {
"type": "integer"
},
"required": false,
"type": "array"
}
}
},
"title": {
"title": "Title",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"sessionOptions": {
"title": "Session Options",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"autoDeleteAfterMeetingEnd": {
"name": "autoDeleteAfterMeetingEnd",
"title": "Auto Delete After Meeting End",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"displayQuickStartHost": {
"name": "displayQuickStartHost",
"title": "Display Quick Start Host",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"displayQuickStartAttendees": {
"name": "displayQuickStartAttendees",
"title": "Display Quick Start Attendees",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"defaultServiceType": {
"name": "defaultServiceType",
"title": "Default Service Type",
"minItems": 0,
"required": false,
"choices": [
[
"MeetingCenter",
"MeetingCenter"
],
[
"EventCenter",
"EventCenter"
],
[
"TrainingCenter",
"TrainingCenter"
],
[
"SupportCenter",
"SupportCenter"
],
[
"SalesCenter",
"SalesCenter"
]
],
"maxItems": 1,
"type": "string"
},
"defaultSessionType": {
"name": "defaultSessionType",
"title": "Default Session Type",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
}
}
},
"supportedServices": {
"title": "Supported Services",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"eventCenter": {
"name": "eventCenter",
"title": "Event Center",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"salesCenter": {
"name": "salesCenter",
"title": "Sales Center",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"supportCenter": {
"name": "supportCenter",
"title": "Support Center",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"meetingCenter": {
"name": "meetingCenter",
"title": "Meeting Center",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"trainingCenter": {
"name": "trainingCenter",
"title": "Training Center",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"privilege": {
"title": "Privilege",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"isEnableCET": {
"name": "isEnableCET",
"title": "Is Enable CET",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"isEnablePMR": {
"name": "isEnablePMR",
"title": "Is Enable PMR",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"attendeeOnly": {
"name": "attendeeOnly",
"title": "Attendee Only",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"teleConfCallOut": {
"name": "teleConfCallOut",
"title": "Tele Conf Call Out",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"roSiteAdmin": {
"name": "roSiteAdmin",
"title": "Ro Site Admin",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"voiceOverIp": {
"name": "voiceOverIp",
"title": "Voice Over Ip",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"allowExtAttendees": {
"name": "allowExtAttendees",
"title": "Allow Ext Attendees",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"teleConfCallOutInternational": {
"name": "teleConfCallOutInternational",
"title": "Tele Conf Call Out International",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"meetingAssist": {
"name": "meetingAssist",
"title": "Meeting Assist",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"teleConfTollFreeCallIn": {
"name": "teleConfTollFreeCallIn",
"title": "Tele Conf Toll Free Call In",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"HDvideo": {
"name": "HDvideo",
"title": "H Dvideo",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"host": {
"name": "host",
"title": "Host",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"recordingEditor": {
"name": "recordingEditor",
"title": "Recording Editor",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"siteAdmin": {
"name": "siteAdmin",
"title": "Site Admin",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"teleConfCallIn": {
"name": "teleConfCallIn",
"title": "Tele Conf Call In",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"teleConfCallInInternational": {
"name": "teleConfCallInInternational",
"title": "Tele Conf Call In International",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"otherTelephony": {
"name": "otherTelephony",
"title": "Other Telephony",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"labAdmin": {
"name": "labAdmin",
"title": "Lab Admin",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"HQvideo": {
"name": "HQvideo",
"title": "H Qvideo",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"email": {
"title": "Email",
"minItems": 0,
"required": true,
"maxItems": 1,
"type": "string"
},
"webACDPrefs": {
"title": "Web ACD Prefs",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"managerMonitorAllRSQueues": {
"name": "managerMonitorAllRSQueues",
"title": "Manager Monitor All RS Queues",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"monitorAllRSAgents": {
"name": "monitorAllRSAgents",
"title": "Monitor All RS Agents",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"agentMonitorAllRSQueues": {
"name": "agentMonitorAllRSQueues",
"title": "Agent Monitor All RS Queues",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"numAgentSessions": {
"name": "numAgentSessions",
"title": "Num Agent Sessions",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"isAgent": {
"name": "isAgent",
"title": "Is Agent",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"isMgr": {
"name": "isMgr",
"title": "Is Mgr",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"timeZoneID": {
"title": "Time Zone ID",
"minItems": 0,
"required": false,
"default": -1,
"maxItems": 1,
"type": "integer"
},
"description": {
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"personalMeetingRoom": {
"title": "Personal Meeting Room",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"photoURL": {
"name": "photoURL",
"title": "Photo URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"sipURL": {
"name": "sipURL",
"title": "Sip URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"welcomeMessage": {
"name": "welcomeMessage",
"title": "Welcome Message",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"pilotNumber": {
"name": "pilotNumber",
"title": "Pilot Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"personalMeetingRoomURL": {
"name": "personalMeetingRoomURL",
"title": "Personal Meeting Room URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"hostPIN": {
"name": "hostPIN",
"title": "Host PIN",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"headerImageBranding": {
"name": "headerImageBranding",
"title": "Header Image Branding",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"applyPMRForInstantMeeting": {
"name": "applyPMRForInstantMeeting",
"title": "Apply PMR For Instant Meeting",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"accessCode": {
"name": "accessCode",
"title": "Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"headerImageURL": {
"name": "headerImageURL",
"title": "Header Image URL",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"company": {
"title": "Company",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"officeGreeting": {
"title": "Office Greeting",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"tspAccount": {
"title": "Tsp Account",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"tspAccount": {
"name": "tspAccount",
"title": "Tsp Account",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"tollFreeCallInNumber": {
"name": "tollFreeCallInNumber",
"title": "Toll Free Call In Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"participantAccessCode": {
"name": "participantAccessCode",
"title": "Participant Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"nbrDialOut": {
"name": "nbrDialOut",
"title": "Nbr Dial Out",
"minItems": 0,
"required": false,
"choices": [
[
"TOLL_FREE",
"TOLL_FREE"
],
[
"TOLL",
"TOLL"
]
],
"maxItems": 1,
"type": "string"
},
"createOnBridge": {
"name": "createOnBridge",
"title": "Create On Bridge",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"subscriberAccessCode": {
"name": "subscriberAccessCode",
"title": "Subscriber Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"tollCallInData": {
"name": "tollCallInData",
"title": "Toll Call In Data",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"custom1": {
"name": "custom1",
"title": "Custom1",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"custom2": {
"name": "custom2",
"title": "Custom2",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"custom3": {
"name": "custom3",
"title": "Custom3",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"tollCallInNumber": {
"name": "tollCallInNumber",
"title": "Toll Call In Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"tollFreeCallInData": {
"name": "tollFreeCallInData",
"title": "Toll Free Call In Data",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"accountIndex": {
"name": "accountIndex",
"title": "Account Index",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"defaultFlag": {
"name": "defaultFlag",
"title": "Default Flag",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"delete": {
"name": "delete",
"title": "Delete",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"required": false,
"maxItems": 3,
"type": "array"
}
}
},
"language": {
"title": "Language",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"visitCount": {
"title": "Visit Count",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"address": {
"title": "Address",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"city": {
"name": "city",
"title": "City",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"addressType": {
"name": "addressType",
"title": "Address Type",
"minItems": 0,
"required": false,
"choices": [
[
"PERSONAL",
"PERSONAL"
],
[
"GLOBAL",
"GLOBAL"
]
],
"default": "PERSONAL",
"maxItems": 1,
"type": "string"
},
"address1": {
"name": "address1",
"title": "Address1",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"address2": {
"name": "address2",
"title": "Address2",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"zipCode": {
"name": "zipCode",
"title": "Zip Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"state": {
"name": "state",
"title": "State",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"country": {
"name": "country",
"title": "Country",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"active": {
"title": "Active",
"minItems": 0,
"required": true,
"choices": [
[
"ACTIVATED",
"ACTIVATED"
],
[
"REQUEST_TO_ACTIVATE",
"REQUEST_TO_ACTIVATE"
],
[
"DEACTIVATED",
"DEACTIVATED"
]
],
"maxItems": 1,
"type": "string"
},
"password": {
"is_password": true,
"title": "Password",
"minItems": 0,
"required": true,
"maxItems": 1,
"maxLength": 60,
"type": "string"
},
"remoteAccess": {
"title": "Remote Access",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"recording": {
"name": "recording",
"title": "Recording",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"type": {
"name": "type",
"title": "Type",
"minItems": 0,
"required": false,
"choices": [
[
"NBR",
"NBR"
],
[
"LOCAL",
"LOCAL"
]
],
"maxItems": 1,
"type": "string"
},
"enforce": {
"name": "enforce",
"title": "Enforce",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "boolean"
},
"location": {
"name": "location",
"title": "Location",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"sharingView": {
"name": "sharingView",
"title": "Sharing View",
"minItems": 0,
"required": false,
"choices": [
[
"FS_SCALE",
"FS_SCALE"
],
[
"FS",
"FS"
],
[
"WIN_SCALE",
"WIN_SCALE"
],
[
"WIN",
"WIN"
]
],
"maxItems": 1,
"type": "string"
},
"sharingColor": {
"name": "sharingColor",
"title": "Sharing Color",
"minItems": 0,
"required": false,
"choices": [
[
"256",
"256"
],
[
"16BIT",
"16BIT"
]
],
"maxItems": 1,
"type": "string"
}
}
},
"officeurl": {
"title": "Officeurl",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"tracking": {
"title": "Tracking",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"trackingCode5": {
"name": "trackingCode5",
"title": "Tracking Code5",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode4": {
"name": "trackingCode4",
"title": "Tracking Code4",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode7": {
"name": "trackingCode7",
"title": "Tracking Code7",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode6": {
"name": "trackingCode6",
"title": "Tracking Code6",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode1": {
"name": "trackingCode1",
"title": "Tracking Code1",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode10": {
"name": "trackingCode10",
"title": "Tracking Code10",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode3": {
"name": "trackingCode3",
"title": "Tracking Code3",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode2": {
"name": "trackingCode2",
"title": "Tracking Code2",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode9": {
"name": "trackingCode9",
"title": "Tracking Code9",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"trackingCode8": {
"name": "trackingCode8",
"title": "Tracking Code8",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
}
}
},
"myWebEx": {
"title": "My Web Ex",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"isMyWebExPro": {
"name": "isMyWebExPro",
"title": "Is My Web Ex Pro",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"totalStorageSize": {
"name": "totalStorageSize",
"title": "Total Storage Size",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"myProfile": {
"name": "myProfile",
"title": "My Profile",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"myMeetings": {
"name": "myMeetings",
"title": "My Meetings",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"myComputer": {
"name": "myComputer",
"title": "My Computer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"myFolders": {
"name": "myFolders",
"title": "My Folders",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"personalMeetingRoom": {
"name": "personalMeetingRoom",
"title": "Personal Meeting Room",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"myContact": {
"name": "myContact",
"title": "My Contact",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"myWorkspaces": {
"name": "myWorkspaces",
"title": "My Workspaces",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"additionalRecordingStorage": {
"name": "additionalRecordingStorage",
"title": "Additional Recording Storage",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"myPartnerLinks": {
"name": "myPartnerLinks",
"title": "My Partner Links",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"recordedEvents": {
"name": "recordedEvents",
"title": "Recorded Events",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"myReports": {
"name": "myReports",
"title": "My Reports",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"trainingRecordings": {
"name": "trainingRecordings",
"title": "Training Recordings",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"service": {
"title": "Service",
"minItems": 0,
"required": false,
"choices": [
[
"FREE_OFFICE",
"FREE_OFFICE"
],
[
"STANDARD_OFFICE",
"STANDARD_OFFICE"
],
[
"PRO_OFFICE",
"PRO_OFFICE"
]
],
"maxItems": 1,
"type": "string"
},
"firstName": {
"title": "First Name",
"minItems": 0,
"required": true,
"maxItems": 1,
"type": "string"
},
"schedulingPermission": {
"title": "Scheduling Permission",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"passwordHintAnswer": {
"title": "Password Hint Answer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"lastName": {
"title": "Last Name",
"minItems": 0,
"required": true,
"maxItems": 1,
"type": "string"
},
"categoryId": {
"title": "Category Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"supportCenter": {
"title": "Support Center",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"serviceDesk": {
"name": "serviceDesk",
"title": "Service Desk",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"enable": {
"name": "enable",
"title": "Enable",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"orderTabs": {
"name": "orderTabs",
"title": "Order Tabs",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"tab": {
"name": "tab",
"title": "Tab",
"minItems": 4,
"items": {
"type": "string",
"choices": [
[
"Tools",
"Tools"
],
[
"Desktop",
"Desktop"
],
[
"Application",
"Application"
],
[
"Session",
"Session"
]
]
},
"required": true,
"maxItems": 4,
"type": "array"
}
}
}
}
},
"thirdPartyTeleconf": {
"title": "Third Party Teleconf",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"account": {
"name": "account",
"title": "Account",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"moderatorCode": {
"name": "moderatorCode",
"title": "Moderator Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": "string"
},
"confBridgeNum": {
"name": "confBridgeNum",
"title": "Conf Bridge Num",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": "string"
},
"pause": {
"name": "pause",
"title": "Pause",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "integer"
},
"name": {
"name": "name",
"title": "Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": "string"
},
"accountIndex": {
"name": "accountIndex",
"title": "Account Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"phoneName1": {
"name": "phoneName1",
"title": "Phone Name1",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": "string"
},
"accessCode": {
"name": "accessCode",
"title": "Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": "string"
},
"phoneName2": {
"name": "phoneName2",
"title": "Phone Name2",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": "string"
},
"tollFreeNum": {
"name": "tollFreeNum",
"title": "Toll Free Num",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": "string"
},
"defaultFlag": {
"name": "defaultFlag",
"title": "Default Flag",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"required": false,
"maxItems": 3,
"type": "array"
}
}
},
"mpProfileNumber": {
"title": "Mp Profile Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 64,
"type": "string"
},
"passwordHint": {
"title": "Password Hint",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"timeZone": {
"title": "Time Zone",
"minItems": 0,
"required": false,
"choices": [
[
"GMT-12:00, Dateline (Eniwetok)",
"GMT-12:00, Dateline (Eniwetok)"
],
[
"GMT-11:00, Samoa (Samoa)",
"GMT-11:00, Samoa (Samoa)"
],
[
"GMT-10:00, Hawaii (Honolulu)",
"GMT-10:00, Hawaii (Honolulu)"
],
[
"GMT-09:00, Alaska (Ancorage)",
"GMT-09:00, Alaska (Ancorage)"
],
[
"GMT-08:00, Pacific (San Jose)",
"GMT-08:00, Pacific (San Jose)"
],
[
"GMT-07:00, Mountain (Arizona)",
"GMT-07:00, Mountain (Arizona)"
],
[
"GMT-07:00, Mountain (Denver)",
"GMT-07:00, Mountain (Denver)"
],
[
"GMT-06:00, Central (Chicago)",
"GMT-06:00, Central (Chicago)"
],
[
"GMT-06:00, Mexico (Mexico City,Tegucigalpa)",
"GMT-06:00, Mexico (Mexico City,Tegucigalpa)"
],
[
"GMT-06:00, Central (Regina)",
"GMT-06:00, Central (Regina)"
],
[
"GMT-05:00, S. America Pacific (Bogota)",
"GMT-05:00, S. America Pacific (Bogota)"
],
[
"GMT-05:00, Eastern (New York)",
"GMT-05:00, Eastern (New York)"
],
[
"GMT-05:00, Eastern (Indiana)",
"GMT-05:00, Eastern (Indiana)"
],
[
"GMT-04:00, Atlantic (Halifax)",
"GMT-04:00, Atlantic (Halifax)"
],
[
"GMT-04:00, S. America Western (Caracas)",
"GMT-04:00, S. America Western (Caracas)"
],
[
"GMT-03:30, Newfoundland (Newfoundland)",
"GMT-03:30, Newfoundland (Newfoundland)"
],
[
"GMT-03:00, S. America Eastern (Brasilia)",
"GMT-03:00, S. America Eastern (Brasilia)"
],
[
"GMT-03:00, S. America Eastern (Buenos Aires)",
"GMT-03:00, S. America Eastern (Buenos Aires)"
],
[
"GMT-02:00, Mid-Atlantic (Mid-Atlantic)",
"GMT-02:00, Mid-Atlantic (Mid-Atlantic)"
],
[
"GMT-01:00, Azores (Azores)",
"GMT-01:00, Azores (Azores)"
],
[
"GMT+00:00, Greenwich (Casablanca)",
"GMT+00:00, Greenwich (Casablanca)"
],
[
"GMT+00:00, GMT (London)",
"GMT+00:00, GMT (London)"
],
[
"GMT+01:00, Europe (Amsterdam)",
"GMT+01:00, Europe (Amsterdam)"
],
[
"GMT+01:00, Europe (Paris)",
"GMT+01:00, Europe (Paris)"
],
[
"GMT+01:00, Europe (Prague)",
"GMT+01:00, Europe (Prague)"
],
[
"GMT+01:00, Europe (Berlin)",
"GMT+01:00, Europe (Berlin)"
],
[
"GMT+02:00, Greece (Athens)",
"GMT+02:00, Greece (Athens)"
],
[
"GMT+02:00, Eastern Europe (Bucharest)",
"GMT+02:00, Eastern Europe (Bucharest)"
],
[
"GMT+02:00, Egypt (Cairo)",
"GMT+02:00, Egypt (Cairo)"
],
[
"GMT+02:00, South Africa (Pretoria)",
"GMT+02:00, South Africa (Pretoria)"
],
[
"GMT+02:00, Northern Europe (Helsinki)",
"GMT+02:00, Northern Europe (Helsinki)"
],
[
"GMT+02:00, Israel (Tel Aviv)",
"GMT+02:00, Israel (Tel Aviv)"
],
[
"GMT+03:00, Saudi Arabia (Baghdad)",
"GMT+03:00, Saudi Arabia (Baghdad)"
],
[
"GMT+03:00, Russian (Moscow)",
"GMT+03:00, Russian (Moscow)"
],
[
"GMT+03:00, Nairobi (Nairobi)",
"GMT+03:00, Nairobi (Nairobi)"
],
[
"GMT+03:00, Iran (Tehran)",
"GMT+03:00, Iran (Tehran)"
],
[
"GMT+04:00, Arabian (Abu Dhabi, Muscat)",
"GMT+04:00, Arabian (Abu Dhabi, Muscat)"
],
[
"GMT+04:00, Baku (Baku)",
"GMT+04:00, Baku (Baku)"
],
[
"GMT+04:00, Afghanistan (Kabul)",
"GMT+04:00, Afghanistan (Kabul)"
],
[
"GMT+05:00, West Asia (Ekaterinburg)",
"GMT+05:00, West Asia (Ekaterinburg)"
],
[
"GMT+05:00, West Asia (Islamabad)",
"GMT+05:00, West Asia (Islamabad)"
],
[
"GMT+05:30, India (Bombay)",
"GMT+05:30, India (Bombay)"
],
[
"GMT+06:00, Columbo (Columbo)",
"GMT+06:00, Columbo (Columbo)"
],
[
"GMT+06:00, Central Asia (Almaty)",
"GMT+06:00, Central Asia (Almaty)"
],
[
"GMT+07:00, Bangkok (Bangkok)",
"GMT+07:00, Bangkok (Bangkok)"
],
[
"GMT+08:00, China (Beijing)",
"GMT+08:00, China (Beijing)"
],
[
"GMT+08:00, Australia Western (Perth)",
"GMT+08:00, Australia Western (Perth)"
],
[
"GMT+08:00, Singapore (Singapore)",
"GMT+08:00, Singapore (Singapore)"
],
[
"GMT+08:00, Taipei (Hong Kong)",
"GMT+08:00, Taipei (Hong Kong)"
],
[
"GMT+09:00, Tokyo (Tokyo)",
"GMT+09:00, Tokyo (Tokyo)"
],
[
"GMT+09:00, Korea (Seoul)",
"GMT+09:00, Korea (Seoul)"
],
[
"GMT+09:30, Yakutsk (Yakutsk)",
"GMT+09:30, Yakutsk (Yakutsk)"
],
[
"GMT+09:30, Australia Central (Adelaide)",
"GMT+09:30, Australia Central (Adelaide)"
],
[
"GMT+09:30, Australia Central (Darwin)",
"GMT+09:30, Australia Central (Darwin)"
],
[
"GMT+10:00, Australia Eastern (Brisbane)",
"GMT+10:00, Australia Eastern (Brisbane)"
],
[
"GMT+10:00, Australia Eastern (Sydney)",
"GMT+10:00, Australia Eastern (Sydney)"
],
[
"GMT+10:00, West Pacific (Guam)",
"GMT+10:00, West Pacific (Guam)"
],
[
"GMT+10:00, Tasmania (Hobart)",
"GMT+10:00, Tasmania (Hobart)"
],
[
"GMT+10:00, Vladivostok (Vladivostok)",
"GMT+10:00, Vladivostok (Vladivostok)"
],
[
"GMT+11:00, Central Pacific (Solomon Is)",
"GMT+11:00, Central Pacific (Solomon Is)"
],
[
"GMT+12:00, New Zealand (Wellington)",
"GMT+12:00, New Zealand (Wellington)"
],
[
"GMT+12:00, Fiji (Fiji)",
"GMT+12:00, Fiji (Fiji)"
],
[
"GMT-09:00, Alaska (Anchorage)",
"GMT-09:00, Alaska (Anchorage)"
]
],
"maxItems": 1,
"type": "string"
},
"security": {
"title": "Security",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"forceChangePassword": {
"name": "forceChangePassword",
"title": "Force Change Password",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"lockAccount": {
"name": "lockAccount",
"title": "Lock Account",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"resetPassword": {
"name": "resetPassword",
"title": "Reset Password",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"registrationDate": {
"title": "Registration Date",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"options": {
"title": "Options",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"notifyOnNewMessage": {
"name": "notifyOnNewMessage",
"title": "Notify On New Message",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"folderRead": {
"name": "folderRead",
"title": "Folder Read",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"subscriptionOffice": {
"name": "subscriptionOffice",
"title": "Subscription Office",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"listInCategory": {
"name": "listInCategory",
"title": "List In Category",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"pictureVisible": {
"name": "pictureVisible",
"title": "Picture Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"notifyOnLinkRequest": {
"name": "notifyOnLinkRequest",
"title": "Notify On Link Request",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportMeetingRecord": {
"name": "supportMeetingRecord",
"title": "Support Meeting Record",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"titleVisible": {
"name": "titleVisible",
"title": "Title Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"cellPhoneVisible": {
"name": "cellPhoneVisible",
"title": "Cell Phone Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"officeUrlVisible": {
"name": "officeUrlVisible",
"title": "Office Url Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportDesktopShare": {
"name": "supportDesktopShare",
"title": "Support Desktop Share",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"faxVisible": {
"name": "faxVisible",
"title": "Fax Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"folderWrite": {
"name": "folderWrite",
"title": "Folder Write",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportDesktopShareRemote": {
"name": "supportDesktopShareRemote",
"title": "Support Desktop Share Remote",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"holdOnLinkRequest": {
"name": "holdOnLinkRequest",
"title": "Hold On Link Request",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"notifyOnMeeting": {
"name": "notifyOnMeeting",
"title": "Notify On Meeting",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"emailVisible": {
"name": "emailVisible",
"title": "Email Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"isEnableCET": {
"name": "isEnableCET",
"title": "Is Enable CET",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"messageVisible": {
"name": "messageVisible",
"title": "Message Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"iconSelect2": {
"name": "iconSelect2",
"title": "Icon Select2",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"iconSelect1": {
"name": "iconSelect1",
"title": "Icon Select1",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"workPhoneVisible": {
"name": "workPhoneVisible",
"title": "Work Phone Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportApp": {
"name": "supportApp",
"title": "Support App",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportAppshareRemote": {
"name": "supportAppshareRemote",
"title": "Support Appshare Remote",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"acceptLinkRequest": {
"name": "acceptLinkRequest",
"title": "Accept Link Request",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"firstNameVisible": {
"name": "firstNameVisible",
"title": "First Name Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportFileShare": {
"name": "supportFileShare",
"title": "Support File Share",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportWebTourRemote": {
"name": "supportWebTourRemote",
"title": "Support Web Tour Remote",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"followMeEnable": {
"name": "followMeEnable",
"title": "Follow Me Enable",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"addressVisible": {
"name": "addressVisible",
"title": "Address Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"lastNameVisible": {
"name": "lastNameVisible",
"title": "Last Name Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"supportVideo": {
"name": "supportVideo",
"title": "Support Video",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"pagerVisible": {
"name": "pagerVisible",
"title": "Pager Visible",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
}
}
}
}
},
"maxItems": 1
},
"CUCMUser": {
"title": "Cucm User",
"type": "array",
"items": {
"type": "object",
"properties": {
"mlppPassword": {
"is_password": true,
"description": " Confirm the MLPP password. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To confirm that you entered the MLPP Password correctly, re-enter the password in this field. \n \n \n ",
"title": "Confirm MLPP Password",
"minItems": 0,
"pattern": "^[0-9]{4,20}$",
"required": false,
"maxItems": 1,
"minLength": 4,
"maxLength": 20,
"type": "string"
},
"associatedPc": {
"description": " This required field applies for \n Cisco IP Softphone users. ",
"title": "Associated Pc",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"patternPrecedence": {
"description": " Set the MLPP Precedence Authorization Level. The following precedence levels indicate the priority level that is associated with a call: \n \n \n 0: Flash Override (highest) \n \n 1: Flash \n \n 2: Immediate \n \n 3: Priority \n \n 4: Routine (lowest) \n You can set the Precedence Authorization Level to any standard precedence level from Routine to Executive Override. Calls of equal or lower precedence are authorized to be originated by the user. ",
"title": "MLPP Precedence Authorization Level",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Flash Override",
"title": "Flash Override"
},
{
"value": "Flash",
"title": "Flash"
},
{
"value": "Immediate",
"title": "Immediate"
},
{
"value": "Priority",
"title": "Priority"
},
{
"value": "Routine",
"title": "Routine"
},
{
"value": "Default",
"title": "Default"
},
{
"value": "Executive Override",
"title": "Executive Override"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"directoryUri": {
"description": " Enter the directory URI that you want to associate to this end user. A directory URI looks like an email address and follows the user@host format. For information about valid formats for directory URIs, see Directory URI formats in the \"Intercluster Directory URI\" chapter of the Cisco Unified Communications Manager Administrative Guide. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you enter a directory URI and also enter a directory number in the Primary Extension field, this directory URI automatically becomes the primary directory URI that is associated to that directory number. \n \n \n ",
"title": "Directory Uri",
"minItems": 0,
"pattern": "^[^@]{1,47}@[^@]+$",
"required": false,
"maxItems": 1,
"maxLength": 254,
"type": [
"string",
"null"
]
},
"pin": {
"is_password": true,
"description": " Enter the PIN again. ",
"title": "Confirm PIN",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"imAndPresenceEnable": {
"description": " Check this check box to enable the end user (on the home cluster) for IM and Presence. Configure IM and Presence in the associated service profile. \n \n \n \n Note\u00a0\u00a0\u00a0 \n IM and Presence does not function properly if an end user is assigned to more than one home cluster. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n You must install a Unified Communications Manager IM and Presence node along with this Unified Communications Manager cluster. Use the User Management > User Settings > UC Services menu to configure the IM and Presence service. \n \n \n ",
"title": "Enable User for Unified CM IM and Presence (Configure IM and Presence in the associated UC Service Profile)",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"calendarPresence": {
"title": "Calendar Presence",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"associatedDevices": {
"description": "Also known as controlled devices.",
"title": "Associated Devices",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"device": {
"description": "Name of device.",
"title": "Device",
"minItems": 0,
"items": {
"target_attr": "name",
"format": "uri",
"type": "string",
"target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxLength": 50,
"target_model_type": "device/cucm/Phone",
"choices": []
},
"required": false,
"type": "array",
"name": "device"
}
}
},
"manager": {
"description": " Enter the user ID of the end user manager ID. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n The manager user ID that you enter does not have to exist in the same cluster as the end user; therefore, \n Unified CM does not require that you enter a user ID that already exists in the database. \n \n \n ",
"title": "Manager",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"convertUserAccount": {
"description": " This check box appears for LDAP synchronized end users. Check this check box then save changes to convert an LDAP synchronized user to a local user. ",
"title": "Convert LDAP Synchronized User to Local User",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"ipccExtension": {
"description": " From the drop-down list box, choose an IPCC extension for this end user. \n \n \n \n Note\u00a0\u00a0\u00a0 \n This field appears only if the IPCC Express Installed enterprise parameter is set to True. \n \n \n ",
"title": "IPCC Extension",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"homeCluster": {
"description": " Check this check box if the end user is homed to this cluster. The end user should only be homed to one cluster within the enterprise. \n \n \n \n Note\u00a0\u00a0\u00a0 \n After an upgrade to Unified Communications Manager Release 10.0(1), when new users are synced from LDAP, the home cluster is not enabled. You must modify your existing LDAP synchronization agreement and add a Feature Group Template which has the home cluster enabled. \n \n \n ",
"title": "Home Cluster",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"maxDeskPickupWaitTime": {
"description": " Enter the maximum time in milliseconds that is permitted to pass before the user must pick up a call that is transferred from the mobile phone to desktop phone. ",
"title": "Maximum Wait Time for Desk Pickup",
"minItems": 0,
"required": false,
"default": 10000,
"maxItems": 1,
"type": "integer"
},
"primaryExtension": {
"description": "Only DNs associated with the associatedDevices of the User can be used as primary extension.",
"title": "Primary Extension",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"pattern": {
"description": "DN or Pattern",
"title": "Pattern",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "pattern",
"target": "/api/device/cucm/Line/choices/?field=pattern&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxItems": 1,
"maxLength": 255,
"type": "string",
"name": "pattern",
"target_model_type": "device/cucm/Line",
"choices": []
},
"routePartitionName": {
"description": "Route Partition to which the DN is associated.",
"title": "Route Partition Name",
"minItems": 0,
"format": "uri",
"required": true,
"target_attr": "name",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
],
"name": "routePartitionName",
"target_model_type": "device/cucm/RoutePartition",
"choices": []
}
}
},
"customerName": {
"description": "This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.",
"title": "Customer Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"title": {
"title": "Title",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"middleName": {
"description": " Enter the end user middle name. ",
"title": "Middle Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"pinCredentials": {
"description": "Not Applicable for add. These groups get automatically added once an user is added. ",
"title": "Pin Credentials",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"pinResetHackCount": {
"description": "The tag will be ignored in add, while update you can reset the hack count.",
"title": "Pin Reset Hack Count",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean",
"name": "pinResetHackCount"
},
"pinCredLockedByAdministrator": {
"name": "pinCredLockedByAdministrator",
"title": "Pin Cred Locked By Administrator",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"pinCredTimeAdminLockout": {
"name": "pinCredTimeAdminLockout",
"title": "Pin Cred Time Admin Lockout",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"pinCredDoesNotExpire": {
"name": "pinCredDoesNotExpire",
"title": "Pin Cred Does Not Expire",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"pinCredPolicyName": {
"name": "pinCredPolicyName",
"title": "Pin Cred Policy Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"pinCredUserCantChange": {
"name": "pinCredUserCantChange",
"title": "Pin Cred User Cant Change",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"pinCredTimeChanged": {
"name": "pinCredTimeChanged",
"title": "Pin Cred Time Changed",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"pinCredUserMustChange": {
"name": "pinCredUserMustChange",
"title": "Pin Cred User Must Change",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"associatedHeadsets": {
"description": "Contains headset that are associated to user.",
"title": "Associated Headsets",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"headset": {
"description": "Name of headset.",
"title": "Headset",
"minItems": 0,
"items": {
"type": "string",
"maxLength": 50
},
"required": false,
"maxItems": 15,
"type": "array",
"name": "headset"
}
}
},
"attendeesAccessCode": {
"description": " Set the Attendees Access Code for a secure conference call. The access code can be modified in the Self Care Portal. For more information on how to modify the access code, see the Cisco Unified Communications Self Care Portal User Guide. ",
"title": "Attendees Access Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"homeNumber": {
"description": " Enter the end user home number. You may use the following special characters: (,), and -. ",
"title": "Home Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"userIdentity": {
"description": "Value should be of of the format user@domain",
"title": "User Identity",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"ipccRoutePartition": {
"description": "Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs with ipccExtension tag only.",
"title": "Ipcc Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"zeroHop": {
"description": "If zeroHop value is false pin will be synchronized with UCxN, if synchronization is enabled for Unity Connection server and if zeroHop is true pin will not be synchronized with UCxN. This tage is supported only for updateUser api",
"title": "Zero Hop",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"department": {
"description": " Enter the end user department information (for example, the department number or name). ",
"title": "Department",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"enableEmcc": {
"description": " Check this box to enable this end user to use the \n Cisco Extension Mobility Cross Cluster feature. For more information about the \n Cisco Extension Mobility Cross Cluster feature, see the Feature Configuration Guide for Cisco Unified Communications Manager. ",
"title": "Enable Extension Mobility Cross Cluster",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"digestCredentials": {
"is_password": true,
"description": " To confirm that you entered the digest credentials correctly, re-enter the credentials in this field. ",
"title": "Confirm Digest Credentials",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"enableUserToHostConferenceNow": {
"description": " Check this check box to allow End User to host Conference Now. ",
"title": "Enable User To Host Conference Now",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"associatedGroups": {
"title": "Associated Groups",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"userGroup": {
"name": "userGroup",
"title": "User Group",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"description": "Name of User Group",
"title": "Groups",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"target": "/api/device/cucm/UserGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxItems": 1,
"maxLength": 100,
"type": "string",
"name": "name",
"target_model_type": "device/cucm/UserGroup",
"choices": []
},
"userRoles": {
"name": "userRoles",
"title": "User Roles",
"minItems": 0,
"required": false,
"readonly": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"userRole": {
"description": "READ ONLY: Name of the User Role associated with the user group will be taken.",
"title": "Roles",
"minItems": 0,
"items": {
"type": "string",
"maxLength": 100
},
"required": false,
"type": "array",
"name": "userRole"
}
}
}
}
},
"required": false,
"type": "array"
}
}
},
"selfService": {
"description": " The Meeting Number is generated automatically when the Self-Service User ID field is configured. ",
"title": "Self Service",
"minItems": 0,
"pattern": "^[0-9*#]{0,27}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"enableMobility": {
"description": " Check this check box to activate Cisco Unified Mobility, which allows the user to manage calls by using a single phone number and to pick up in-progress calls on the desktop phone and cellular phone. Checking this check box triggers licensing to consume device license units for Cisco Unified Mobility. ",
"title": "Enable Mobility",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"phoneProfiles": {
"title": "Phone Profiles",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"profileName": {
"name": "profileName",
"title": "Profile Name",
"minItems": 1,
"items": {
"target_attr": "name",
"type": "string",
"target": "/api/device/cucm/DeviceProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"target_model_type": "device/cucm/DeviceProfile",
"choices": []
},
"required": false,
"type": "array"
}
}
},
"passwordCredentials": {
"description": "Not Applicable for Add. Credential configuration for password.",
"title": "Password Credentials",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"pwdCredUserMustChange": {
"name": "pwdCredUserMustChange",
"title": "Pwd Cred User Must Change",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"pwdCredUserCantChange": {
"name": "pwdCredUserCantChange",
"title": "Pwd Cred User Cant Change",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"pwdCredTimeChanged": {
"name": "pwdCredTimeChanged",
"title": "Pwd Cred Time Changed",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"pwdCredTimeAdminLockout": {
"name": "pwdCredTimeAdminLockout",
"title": "Pwd Cred Time Admin Lockout",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"pwdCredPolicyName": {
"name": "pwdCredPolicyName",
"title": "Pwd Cred Policy Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"pwdCredLockedByAdministrator": {
"name": "pwdCredLockedByAdministrator",
"title": "Pwd Cred Locked By Administrator",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"pwdResetHackCount": {
"description": "The tag will be ignored in add, while update you can reset the hack count.",
"title": "Pwd Reset Hack Count",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean",
"name": "pwdResetHackCount"
},
"pwdCredDoesNotExpire": {
"name": "pwdCredDoesNotExpire",
"title": "Pwd Cred Does Not Expire",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"numericUserId": {
"description": " This pane displays the Instance ID from the CAPF Profile that you configured for this user. To view or update the profile, double-click the Instance ID or click the Instance ID to highlight it; then, click View Details. The End User CAPF Profile Configuration window displays with the current settings. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The MLPP User Identification number must comprise 6 - 20 numeric characters. \n \n \n For information on how to configure the End User CAPF Profile, see the \n Cisco Unified Communications Manager Security Guide. ",
"title": "MLPP User ID",
"minItems": 0,
"pattern": "^[0-9]{6,20}$",
"required": false,
"maxItems": 1,
"type": "string"
},
"subscribeCallingSearchSpaceName": {
"description": " Supported with the BLF Presence feature, the SUBSCRIBE calling search space determines how \n Unified Communications Manager routes presence requests that come from the end user. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the end user. From the drop-down list box, choose the SUBSCRIBE calling search space to use for presence requests for the end user. All calling search spaces that you configure in \n Cisco Unified CM Administration appear in the SUBSCRIBE Calling Search Space drop-down list box. If you do not select a different calling search space for the end user from the drop-down list box, the SUBSCRIBE calling search space defaults to None. To configure a SUBSCRIBE calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces. ",
"title": "SUBSCRIBE Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/Css",
"choices": []
},
"userLocale": {
"description": " From the drop-down list box, choose the locale that is associated with the end user. The user locale identifies a set of detailed information to support end users, including language and font. Unified Communications Manager uses this locale for extension mobility and the Cisco Unified Communications Self Care Portal. For \n Cisco Extension Mobility login, the locale that is specified takes precedence over the device and device profile settings. For \n Cisco Extension Mobility logout, Unified Communications Manager uses the end user locale that the default device profile specifies. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you do not choose an end user locale, the locale that is specified in the Cisco CallManager service parameters as Default User Locale applies. \n \n \n ",
"title": "User Locale",
"minItems": 0,
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/UserLocale/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/UserLocale"
},
"associatedRemoteDestinationProfiles": {
"description": "Read-Only.These groups automatically get added once the user is associated with a Remote Destination Profile.",
"title": "Associated Remote Destination Profiles",
"minItems": 0,
"required": false,
"readonly": true,
"maxItems": 1,
"type": [
"null",
"object"
],
"properties": {
"remoteDestinationProfile": {
"description": " This field lists the remote destination profiles that were created for this user. To view the details of a particular remote destination profile, choose a remote destination profile in the list and click the View Details link.",
"title": "Remote Destination Profiles",
"minItems": 0,
"items": {
"type": "string"
},
"required": false,
"type": "array",
"name": "remoteDestinationProfile"
}
}
},
"enableCti": {
"description": " If this check box is checked, when the user logs in to a device, the AllowCTIControlFlag device property becomes active, which allows control of the device from CTI applications. Until the user logs in to a device, this setting has no effect. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The Allow Control of Device from CTI setting in the end user configuration overrides the AllowCTIControlFlag device property of the device to which the user logs in. \n \n \n ",
"title": "Allow Control of Device from CTI",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"mailid": {
"description": " Enter the end user e-mail address. ",
"title": "Mailid",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"emMaxLoginTime": {
"title": "Em Max Login Time",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"enableMobileVoiceAccess": {
"description": " Check this check box to allow the user to access the Mobile Voice Access integrated voice response (IVR) system to initiate Cisco Unified Mobility calls and activate or deactivate Cisco Unified Mobility capabilities. ",
"title": "Enable Mobile Voice Access",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"nameDialing": {
"title": "Name Dialing",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"presenceGroupName": {
"description": " Use this field to configure the BLF Presence feature. From the drop-down list box, choose a BLF presence group for the end user. The selected group specifies the destinations that the end user can monitor. The default value for BLF Presence Group specifies Standard Presence group, configured with installation. BLF Presence Groups that are configured in \n Cisco Unified Administration also appear in the drop-down list box. BLF Presence Group authorization works with BLF Presence Groups to allow or block presence requests between groups. ",
"title": "BLF Presence Group",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": "string",
"target_model_type": "device/cucm/PresenceGroup",
"choices": []
},
"password": {
"is_password": true,
"description": " This field does not display for LDAP Synchronized users if LDAP Authentication is enabled. Enter the end user password again. ",
"title": "Confirm Password",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"defaultProfile": {
"description": " From the drop-down list box, choose a default extension mobility profile for this end user. ",
"title": "Default Profile",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"telephoneNumber": {
"description": " Enter the end user work number. You may use the following special characters: (,\u00a0), and -. ",
"title": "Telephone Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"mobileNumber": {
"description": " Enter the end user mobile number. You may use the following special characters: (,), and -. ",
"title": "Mobile Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"displayName": {
"description": " This field appears for local end users as well as LDAP synchronized end users. You can specify a display name for the local end users. For LDAP synchronized end users, this field appears if Microsoft Active Directory is used as the corporate directory. It displays the display name of the end user as specified in Microsoft Active Directory. \n \n \n \n Note\u00a0\u00a0\u00a0 \n This field is supported on Administrative XML (AXL) and Bulk Administration Tool (BAT). \n \n \n ",
"title": "Display Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"firstName": {
"description": " Enter the end user first name. ",
"title": "First Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"lastName": {
"description": " Enter the end user last name. ",
"title": "Last Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"serviceProfile": {
"description": "To revert to the System Default Service Profile value, select any value from the drop-down, blank it (i.e. delete ALL text) and submit.",
"title": "UC Service Profile",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/ServiceProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/ServiceProfile",
"choices": []
},
"status": {
"description": "Garbage Collection Status",
"title": "Garbage Collection Status",
"minItems": 0,
"required": false,
"readonly": true,
"maxItems": 1,
"type": "integer"
},
"userid": {
"description": " Enter the unique end user identification name. You can enter any character, including alphanumeric and special characters. No character restrictions exist for this field. You can modify the user ID only for local users. For LDAP synchronized users, you can view the user ID, but you cannot modify it. \n \n \n \n Note\u00a0\u00a0\u00a0 \n We recommend that you do not use a slash (/) in the User ID field. Cisco User Data Services will not function properly for the user when the User ID contains a slash. \n \n \n ",
"title": "Userid",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"ctiControlledDeviceProfiles": {
"title": "Cti Controlled Device Profiles",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"profileName": {
"description": " This drop-down list box displays the CTI-controlled profiles that are available for association with an end user who is configured for CTI. ",
"title": "Controlled Profiles",
"minItems": 1,
"items": {
"target_attr": "name",
"type": "string",
"target": "/api/device/cucm/DeviceProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"target_model_type": "device/cucm/DeviceProfile",
"choices": []
},
"required": true,
"type": "array",
"name": "profileName"
}
}
},
"extensionsInfo": {
"description": "These tags are for Quick User/Phone Add page",
"title": "Extensions Info",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"extension": {
"description": "These tags are for Quick User/Phone Add page",
"title": "Extension",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"pattern": {
"name": "pattern",
"title": "Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"partition": {
"name": "partition",
"title": "Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"linePrimaryUri": {
"name": "linePrimaryUri",
"title": "Line Primary Uri",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"sortOrder": {
"name": "sortOrder",
"title": "Sort Order",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"routePartition": {
"name": "routePartition",
"title": "Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array",
"name": "extension"
}
}
},
"userProfile": {
"title": "User Profile",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/UserProfileProvision/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/UserProfileProvision",
"choices": []
},
"ldapDirectoryName": {
"title": "Ldap Directory Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/LdapDirectory/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/LdapDirectory",
"choices": []
},
"remoteDestinationLimit": {
"description": " Enter the maximum number of phones to which the user is permitted to transfer calls from the desktop phone. ",
"title": "Remote Destination Limit",
"minItems": 0,
"required": false,
"default": 4,
"maxItems": 1,
"type": "integer"
},
"customUserFields": {
"title": "Custom User Fields",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "object",
"properties": {
"customUserField": {
"description": "This Tag is valid only for GetUser",
"title": "Custom User Field",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"name": "name",
"title": "Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"value": {
"name": "value",
"title": "Value",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"maxItems": 5,
"type": "array",
"name": "customUserField"
}
}
},
"lineAppearanceAssociationForPresences": {
"description": "Applicable for Controlled Devices",
"title": "Line Appearance Association For Presences",
"minItems": 0,
"required": false,
"readonly": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"lineAppearanceAssociationForPresence": {
"name": "lineAppearanceAssociationForPresence",
"title": "Line Appearance Association For Presence",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"laapProductType": {
"name": "laapProductType",
"title": "Laap Product Type",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"laapAssociate": {
"name": "laapAssociate",
"title": "Laap Associate",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"laapDeviceName": {
"name": "laapDeviceName",
"title": "Laap Device Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"laapPartition": {
"name": "laapPartition",
"title": "Laap Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"laapDirectory": {
"name": "laapDirectory",
"title": "Laap Directory",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"laapDescription": {
"name": "laapDescription",
"title": "Laap Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"pagerNumber": {
"description": " Enter the end user pager number. You may use the following special characters: (,), and -. ",
"title": "Pager Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
}
}
},
"maxItems": 1
},
"LDAPUser": {
"title": "Ldap User",
"type": "array",
"items": {
"type": "object",
"properties": {
"ldap_username": {
"required": true,
"type": "string",
"description": "The login attribute of the associated LDAP device model instance",
"title": "LDAP Username"
},
"data_username": {
"target": "/api/data/User/choices/?field=username&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "The data username that is mapped to the associated LDAP device model instance.",
"required": false,
"target_attr": "username",
"title": "Data Username",
"type": "string",
"target_model_type": "data/User",
"choices": []
},
"ldap_server": {
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "A reference to the LDAP server which this user must authenticate against.",
"required": false,
"title": "LDAP Server",
"type": "string",
"target_model_type": "data/Ldap",
"choices": []
}
}
},
"maxItems": 1
},
"SSOUser": {
"title": "Sso User",
"type": "array",
"items": {
"type": "object",
"properties": {
"sso_idp": {
"target": "/api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "The entity id of the SSO Identity Provider.",
"required": true,
"target_attr": "entity_id",
"title": "SSO Identity Provider",
"type": "string",
"target_model_type": "data/SsoIdentityProvider",
"choices": []
},
"sso_username": {
"required": true,
"type": "string",
"description": "The name identifier that is used for an SSO authenticated user.",
"title": "SSO Username"
},
"data_username": {
"target": "/api/data/User/choices/?field=username&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "The data username that is mapped to the associated SSO authenticated user.",
"required": false,
"target_attr": "username",
"title": "Data Username",
"type": "string",
"target_model_type": "data/User",
"choices": []
}
}
},
"maxItems": 1
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/WebExClient/add/ |
|
The GUI Add form of relation/WebExClient as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/WebExClient | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Add Cucm User | POST | /api/relation/WebExClient/[pkid]/+AddCUCMUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Add Ldap User | POST | /api/relation/WebExClient/[pkid]/+AddLDAPUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Add Sso User | POST | /api/relation/WebExClient/[pkid]/+AddSSOUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Add Web Ex User | POST | /api/relation/WebExClient/[pkid]/+AddWebExUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Del Cucm User | POST | /api/relation/WebExClient/[pkid]/+DelCUCMUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Del Ldap User | POST | /api/relation/WebExClient/[pkid]/+DelLDAPUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Del Sso User | POST | /api/relation/WebExClient/[pkid]/+DelSSOUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Del Web Ex User | POST | /api/relation/WebExClient/[pkid]/+DelWebExUser | hierarchy=[hierarchy] | If payload required: |