[Index]
Microsoft Subscriber Relation
Model ref.: relation/MicrosoftSubscriber
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": {
"ObjectId": {
"name": "ObjectId",
"type": "string",
"title": "Object ID",
"required": false,
"readonly": true
},
"UserPrincipalName": {
"name": "UserPrincipalName",
"type": "string",
"title": "User Principal Name",
"readonly": true
},
"City": {
"name": "City",
"type": "string",
"title": "City",
"readonly": true
},
"DisplayLicenses": {
"name": "DisplayLicenses",
"type": "string",
"title": "Licenses Summary",
"readonly": true
},
"DisplayName": {
"name": "DisplayName",
"type": "string",
"title": "Display Name",
"readonly": true
},
"FirstName": {
"name": "FirstName",
"type": "string",
"title": "First Name",
"readonly": true
},
"Title": {
"name": "Title",
"type": "string",
"title": "Title",
"readonly": true
},
"LastName": {
"name": "LastName",
"type": "string",
"title": "Last Name",
"readonly": true
},
"PostalCode": {
"name": "PostalCode",
"type": "string",
"title": "Postal Code",
"readonly": true
},
"Department": {
"name": "Department",
"type": "string",
"title": "Department",
"readonly": true
},
"UsageLocation": {
"name": "UsageLocation",
"type": "string",
"title": "Usage Location",
"description": "Country code, eg. US",
"choices": [
{
"value": "AF",
"title": "Afghanistan"
},
{
"value": "AX",
"title": "\u00c5land Islands"
},
{
"value": "AL",
"title": "Albania"
},
{
"value": "DZ",
"title": "Algeria"
},
{
"value": "AS",
"title": "American Samoa"
},
{
"value": "AD",
"title": "Andorra"
},
{
"value": "AO",
"title": "Angola"
},
{
"value": "AI",
"title": "Anguilla"
},
{
"value": "AQ",
"title": "Antarctica"
},
{
"value": "AG",
"title": "Antigua and Barbuda"
},
{
"value": "AR",
"title": "Argentina"
},
{
"value": "AM",
"title": "Armenia"
},
{
"value": "AW",
"title": "Aruba"
},
{
"value": "AU",
"title": "Australia"
},
{
"value": "AT",
"title": "Austria"
},
{
"value": "AZ",
"title": "Azerbaijan"
},
{
"value": "BS",
"title": "Bahamas, The"
},
{
"value": "BH",
"title": "Bahrain"
},
{
"value": "BD",
"title": "Bangladesh"
},
{
"value": "BB",
"title": "Barbados"
},
{
"value": "BY",
"title": "Belarus"
},
{
"value": "BE",
"title": "Belgium"
},
{
"value": "BZ",
"title": "Belize"
},
{
"value": "BJ",
"title": "Benin"
},
{
"value": "BM",
"title": "Bermuda"
},
{
"value": "BT",
"title": "Bhutan"
},
{
"value": "BT",
"title": "Bolivia"
},
{
"value": "BO",
"title": "Bonaire, Saint Eustatius and Saba"
},
{
"value": "BA",
"title": "Bosnia and Herzegovina"
},
{
"value": "BW",
"title": "Botswana"
},
{
"value": "BV",
"title": "Bouvet Island"
},
{
"value": "BR",
"title": "Brazil"
},
{
"value": "IO",
"title": "British Indian Ocean Territory"
},
{
"value": "IO",
"title": "Brunei"
},
{
"value": "BG",
"title": "Bulgaria"
},
{
"value": "BF",
"title": "Burkina Faso"
},
{
"value": "BI",
"title": "Burundi"
},
{
"value": "CV",
"title": "Cabo Verde"
},
{
"value": "KH",
"title": "Cambodia"
},
{
"value": "CM",
"title": "Cameroon"
},
{
"value": "CA",
"title": "Canada"
},
{
"value": "KY",
"title": "Cayman Islands"
},
{
"value": "CF",
"title": "Central African Republic"
},
{
"value": "TD",
"title": "Chad"
},
{
"value": "CL",
"title": "Chile"
},
{
"value": "CN",
"title": "China"
},
{
"value": "CX",
"title": "Christmas Island"
},
{
"value": "CC",
"title": "Cocos (Keeling) Islands"
},
{
"value": "CO",
"title": "Colombia"
},
{
"value": "KM",
"title": "Comoros"
},
{
"value": "CG",
"title": "Congo"
},
{
"value": "CG",
"title": "Congo (DRC)"
},
{
"value": "CK",
"title": "Cook Islands"
},
{
"value": "CR",
"title": "Costa Rica"
},
{
"value": "CR",
"title": "C\u00f4te d\u2019Ivoire"
},
{
"value": "HR",
"title": "Croatia"
},
{
"value": "CW",
"title": "Cura\u00e7ao"
},
{
"value": "CY",
"title": "Cyprus"
},
{
"value": "CY",
"title": "Czech Republic"
},
{
"value": "DK",
"title": "Denmark"
},
{
"value": "DJ",
"title": "Djibouti"
},
{
"value": "DM",
"title": "Dominica"
},
{
"value": "DO",
"title": "Dominican Republic"
},
{
"value": "EC",
"title": "Ecuador"
},
{
"value": "EG",
"title": "Egypt"
},
{
"value": "SV",
"title": "El Salvador"
},
{
"value": "GQ",
"title": "Equatorial Guinea"
},
{
"value": "ER",
"title": "Eritrea"
},
{
"value": "EE",
"title": "Estonia"
},
{
"value": "ET",
"title": "Ethiopia"
},
{
"value": "ET",
"title": "Falkland Islands (Islas Malvinas)"
},
{
"value": "FO",
"title": "Faroe Islands"
},
{
"value": "FJ",
"title": "Fiji Islands"
},
{
"value": "FI",
"title": "Finland"
},
{
"value": "FR",
"title": "France"
},
{
"value": "GF",
"title": "French Guiana"
},
{
"value": "PF",
"title": "French Polynesia"
},
{
"value": "PF",
"title": "French Southern and Antarctic Lands"
},
{
"value": "GA",
"title": "Gabon"
},
{
"value": "GM",
"title": "Gambia, The"
},
{
"value": "GE",
"title": "Georgia"
},
{
"value": "DE",
"title": "Germany"
},
{
"value": "GH",
"title": "Ghana"
},
{
"value": "GI",
"title": "Gibraltar"
},
{
"value": "GR",
"title": "Greece"
},
{
"value": "GL",
"title": "Greenland"
},
{
"value": "GD",
"title": "Grenada"
},
{
"value": "GP",
"title": "Guadeloupe"
},
{
"value": "GU",
"title": "Guam"
},
{
"value": "GT",
"title": "Guatemala"
},
{
"value": "GG",
"title": "Guernsey"
},
{
"value": "GN",
"title": "Guinea"
},
{
"value": "GW",
"title": "Guinea-Bissau"
},
{
"value": "GY",
"title": "Guyana"
},
{
"value": "HT",
"title": "Haiti"
},
{
"value": "HM",
"title": "Heard Island and McDonald Islands"
},
{
"value": "VA",
"title": "Holy See (Vatican City State)"
},
{
"value": "HN",
"title": "Honduras"
},
{
"value": "HK",
"title": "Hong Kong SAR"
},
{
"value": "HU",
"title": "Hungary"
},
{
"value": "IS",
"title": "Iceland"
},
{
"value": "IN",
"title": "India"
},
{
"value": "ID",
"title": "Indonesia"
},
{
"value": "IQ",
"title": "Iraq"
},
{
"value": "IE",
"title": "Ireland"
},
{
"value": "IM",
"title": "Isle of Man"
},
{
"value": "IL",
"title": "Israel"
},
{
"value": "IT",
"title": "Italy"
},
{
"value": "JM",
"title": "Jamaica"
},
{
"value": "JP",
"title": "Japan"
},
{
"value": "JE",
"title": "Jersey"
},
{
"value": "JO",
"title": "Jordan"
},
{
"value": "KZ",
"title": "Kazakhstan"
},
{
"value": "KE",
"title": "Kenya"
},
{
"value": "KI",
"title": "Kiribati"
},
{
"value": "KR",
"title": "Korea, Republic of"
},
{
"value": "KW",
"title": "Kuwait"
},
{
"value": "KG",
"title": "Kyrgyzstan"
},
{
"value": "LA",
"title": "Laos"
},
{
"value": "LV",
"title": "Latvia"
},
{
"value": "LB",
"title": "Lebanon"
},
{
"value": "LS",
"title": "Lesotho"
},
{
"value": "LR",
"title": "Liberia"
},
{
"value": "LY",
"title": "Libya"
},
{
"value": "LI",
"title": "Liechtenstein"
},
{
"value": "LT",
"title": "Lithuania"
},
{
"value": "LU",
"title": "Luxembourg"
},
{
"value": "MO",
"title": "Macao SAR"
},
{
"value": "MO",
"title": "Macedonia, Former Yugoslav Republic of"
},
{
"value": "MG",
"title": "Madagascar"
},
{
"value": "MW",
"title": "Malawi"
},
{
"value": "MY",
"title": "Malaysia"
},
{
"value": "MV",
"title": "Maldives"
},
{
"value": "ML",
"title": "Mali"
},
{
"value": "MT",
"title": "Malta"
},
{
"value": "MH",
"title": "Marshall Islands"
},
{
"value": "MQ",
"title": "Martinique"
},
{
"value": "MR",
"title": "Mauritania"
},
{
"value": "MU",
"title": "Mauritius"
},
{
"value": "YT",
"title": "Mayotte"
},
{
"value": "MX",
"title": "Mexico"
},
{
"value": "MX",
"title": "Micronesia"
},
{
"value": "FM",
"title": "Moldova"
},
{
"value": "MC",
"title": "Monaco"
},
{
"value": "MN",
"title": "Mongolia"
},
{
"value": "ME",
"title": "Montenegro"
},
{
"value": "MS",
"title": "Montserrat"
},
{
"value": "MA",
"title": "Morocco"
},
{
"value": "MZ",
"title": "Mozambique"
},
{
"value": "MM",
"title": "Myanmar"
},
{
"value": "NA",
"title": "Namibia"
},
{
"value": "NR",
"title": "Nauru"
},
{
"value": "NP",
"title": "Nepal"
},
{
"value": "NP",
"title": "Netherlands"
},
{
"value": "NP",
"title": "Netherlands Antilles (Former)"
},
{
"value": "NC",
"title": "New Caledonia"
},
{
"value": "NZ",
"title": "New Zealand"
},
{
"value": "NI",
"title": "Nicaragua"
},
{
"value": "NE",
"title": "Niger"
},
{
"value": "NG",
"title": "Nigeria"
},
{
"value": "NU",
"title": "Niue"
},
{
"value": "NF",
"title": "Norfolk Island"
},
{
"value": "MP",
"title": "Northern Mariana Islands"
},
{
"value": "NO",
"title": "Norway"
},
{
"value": "OM",
"title": "Oman"
},
{
"value": "PK",
"title": "Pakistan"
},
{
"value": "PW",
"title": "Palau"
},
{
"value": "PS",
"title": "Palestinian Authority"
},
{
"value": "PA",
"title": "Panama"
},
{
"value": "PG",
"title": "Papua New Guinea"
},
{
"value": "PY",
"title": "Paraguay"
},
{
"value": "PE",
"title": "Peru"
},
{
"value": "PH",
"title": "Philippines"
},
{
"value": "PN",
"title": "Pitcairn Islands"
},
{
"value": "PL",
"title": "Poland"
},
{
"value": "PT",
"title": "Portugal"
},
{
"value": "PR",
"title": "Puerto Rico"
},
{
"value": "QA",
"title": "Qatar"
},
{
"value": "QA",
"title": "Reunion"
},
{
"value": "RO",
"title": "Romania"
},
{
"value": "RO",
"title": "Russia"
},
{
"value": "RW",
"title": "Rwanda"
},
{
"value": "BL",
"title": "Saint Barth\u00e9lemy"
},
{
"value": "SH",
"title": "Saint Helena, Ascension and Tristan da Cunha"
},
{
"value": "KN",
"title": "Saint Kitts and Nevis"
},
{
"value": "LC",
"title": "Saint Lucia"
},
{
"value": "LC",
"title": "Saint Martin"
},
{
"value": "PM",
"title": "Saint Pierre and Miquelon"
},
{
"value": "VC",
"title": "Saint Vincent and the Grenadines"
},
{
"value": "WS",
"title": "Samoa"
},
{
"value": "SM",
"title": "San Marino"
},
{
"value": "ST",
"title": "S\u00e3o Tom\u00e9 and Pr\u00edncipe"
},
{
"value": "SA",
"title": "Saudi Arabia"
},
{
"value": "SN",
"title": "Senegal"
},
{
"value": "RS",
"title": "Serbia"
},
{
"value": "SC",
"title": "Seychelles"
},
{
"value": "SL",
"title": "Sierra Leone"
},
{
"value": "SG",
"title": "Singapore"
},
{
"value": "SG",
"title": "Sint Maarten"
},
{
"value": "SK",
"title": "Slovakia"
},
{
"value": "SI",
"title": "Slovenia"
},
{
"value": "SB",
"title": "Solomon Islands"
},
{
"value": "SO",
"title": "Somalia"
},
{
"value": "ZA",
"title": "South Africa"
},
{
"value": "GS",
"title": "South Georgia and the South Sandwich Islands"
},
{
"value": "SS",
"title": "South Sudan"
},
{
"value": "ES",
"title": "Spain"
},
{
"value": "LK",
"title": "Sri Lanka"
},
{
"value": "SR",
"title": "Suriname"
},
{
"value": "SJ",
"title": "Svalbard and Jan Mayen Island"
},
{
"value": "SZ",
"title": "Swaziland"
},
{
"value": "SE",
"title": "Sweden"
},
{
"value": "CH",
"title": "Switzerland"
},
{
"value": "SY",
"title": "Taiwan"
},
{
"value": "TJ",
"title": "Tajikistan"
},
{
"value": "TJ",
"title": "Tanzania"
},
{
"value": "TH",
"title": "Thailand"
},
{
"value": "TL",
"title": "Timor-Leste"
},
{
"value": "TG",
"title": "Togo"
},
{
"value": "TK",
"title": "Tokelau"
},
{
"value": "TO",
"title": "Tonga"
},
{
"value": "TT",
"title": "Trinidad and Tobago"
},
{
"value": "TN",
"title": "Tunisia"
},
{
"value": "TR",
"title": "Turkey"
},
{
"value": "TM",
"title": "Turkmenistan"
},
{
"value": "TC",
"title": "Turks and Caicos Islands"
},
{
"value": "TV",
"title": "Tuvalu"
},
{
"value": "TV",
"title": "U.S. Minor Outlying Islands"
},
{
"value": "UG",
"title": "Uganda"
},
{
"value": "UA",
"title": "Ukraine"
},
{
"value": "AE",
"title": "United Arab Emirates"
},
{
"value": "GB",
"title": "United Kingdom"
},
{
"value": "US",
"title": "United States"
},
{
"value": "UY",
"title": "Uruguay"
},
{
"value": "UZ",
"title": "Uzbekistan"
},
{
"value": "VU",
"title": "Vanuatu"
},
{
"value": "VU",
"title": "Venezuela"
},
{
"value": "VN",
"title": "Vietnam"
},
{
"value": "VG",
"title": "Virgin Islands, British"
},
{
"value": "VI",
"title": "Virgin Islands, U.S."
},
{
"value": "WF",
"title": "Wallis and Futuna"
},
{
"value": "EH",
"title": "Western Sahara"
},
{
"value": "YE",
"title": "Yemen"
},
{
"value": "ZM",
"title": "Zambia"
},
{
"value": "ZW",
"title": "Zimbabwe"
}
]
},
"Country": {
"name": "Country",
"type": "string",
"title": "Country",
"readonly": true
},
"StreetAddress": {
"name": "StreetAddress",
"type": "string",
"title": "Street Address",
"readonly": true
},
"PhoneNumber": {
"name": "PhoneNumber",
"type": "string",
"title": "Phone Number",
"readonly": true
},
"MobilePhone": {
"name": "Mobile Phone",
"type": "string",
"title": "Mobile Phone",
"readonly": true
},
"Office": {
"name": "Office",
"type": "string",
"title": "Office",
"readonly": true
},
"State": {
"name": "State",
"type": "string",
"title": "State",
"readonly": true
},
"ProxyAddresses": {
"name": "ProxyAddresses",
"type": "array",
"title": "Proxy Addresses",
"items": {
"type": "string",
"readonly": true
},
"readonly": true
},
"IsLicensed": {
"name": "IsLicensed",
"type": "string",
"title": "Is Licensed",
"readonly": true,
"choices": [
{
"title": "True",
"value": "true"
},
{
"title": "False",
"value": "false"
}
]
},
"Licenses": {
"name": "Licenses",
"type": "array",
"title": "Licenses",
"items": {
"type": "object",
"properties": {
"ServicePlans": {
"name": "ServicePlans",
"type": "array",
"title": "Service Plans",
"items": {
"type": "object",
"properties": {
"ServicePlanId": {
"name": "ServicePlanId",
"type": "string",
"title": "Service Plan ID",
"readonly": true
},
"ServiceName": {
"name": "ServiceName",
"type": "string",
"title": "Service Name",
"readonly": true
},
"Enabled": {
"name": "Enabled",
"type": "boolean",
"title": "Enabled"
}
}
}
},
"AccountSkuId": {
"name": "AccountSkuId",
"type": "string",
"title": "SKU Part Number",
"format": "uri",
"target": "/api/device/msgraph/MsolAccountSku/choices/?field=SkuPartNumber&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "SkuPartNumber",
"target_model_type": "device/msgraph/MsolAccountSku",
"choices": []
},
"SkuId": {
"name": "SkuId",
"type": "string",
"title": "SKU ID",
"readonly": true
}
}
}
},
"Groups": {
"name": "Groups",
"type": "array",
"title": "Groups (INTERNAL USE ONLY)",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"items": {
"type": "object",
"properties": {
"displayName": {
"name": "displayName",
"type": "string",
"title": "Display Name",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"id": {
"name": "id",
"type": "string",
"title": "Id",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
}
}
}
},
"LicenseAssignmentState": {
"name": "LicenseAssignmentState",
"type": "object",
"title": "License Assignment State (INTERNAL USE ONLY)",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"properties": {
"LicenseAssignmentStates": {
"name": "LicenseAssignmentStates",
"type": "array",
"title": "License Assignment States",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"items": {
"type": "object",
"properties": {
"disabledPlans": {
"name": "disabledPlans",
"type": "array",
"title": "Disabled Plans",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"items": {
"type": "string",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows."
},
"readonly": true
},
"skuId": {
"name": "SkuId",
"type": "string",
"title": "SKU ID",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"assignedByGroup": {
"name": "assignedByGroup",
"type": "string",
"title": "Assigned By Group",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"state": {
"name": "state",
"type": "string",
"title": "State",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"error": {
"name": "error",
"type": "string",
"title": "Error",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
},
"lastUpdatedDateTime": {
"name": "lastUpdatedDateTime",
"type": "string",
"title": "Last Updated Date Time",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
}
}
}
},
"LicenseType": {
"name": "LicenseType",
"type": "string",
"title": "License Type",
"description": "This is for internal use only. Setting this field will not be applied by the backend workflows.",
"readonly": true
}
}
},
"extensionAttribute1": {
"name": "extensionAttribute1",
"type": "string",
"title": "Extension Attribute 1",
"description": "Extension Attribute 1",
"readonly": true
},
"extensionAttribute2": {
"name": "extensionAttribute2",
"type": "string",
"title": "Extension Attribute 2",
"description": "Extension Attribute 2",
"readonly": true
},
"extensionAttribute3": {
"name": "extensionAttribute3",
"type": "string",
"title": "Extension Attribute 3",
"description": "Extension Attribute 3",
"readonly": true
},
"extensionAttribute4": {
"name": "extensionAttribute4",
"type": "string",
"title": "Extension Attribute 4",
"description": "Extension Attribute 4",
"readonly": true
},
"extensionAttribute5": {
"name": "extensionAttribute5",
"type": "string",
"title": "Extension Attribute 5",
"description": "Extension Attribute 5",
"readonly": true
},
"extensionAttribute6": {
"name": "extensionAttribute6",
"type": "string",
"title": "Extension Attribute 6",
"description": "Extension Attribute 6",
"readonly": true
},
"extensionAttribute7": {
"name": "extensionAttribute7",
"type": "string",
"title": "Extension Attribute 7",
"description": "Extension Attribute 7",
"readonly": true
},
"extensionAttribute8": {
"name": "extensionAttribute8",
"type": "string",
"title": "Extension Attribute 8",
"description": "Extension Attribute 8",
"readonly": true
},
"extensionAttribute9": {
"name": "extensionAttribute9",
"type": "string",
"title": "Extension Attribute 9",
"description": "Extension Attribute 9",
"readonly": true
},
"extensionAttribute10": {
"name": "extensionAttribute10",
"type": "string",
"title": "Extension Attribute 10",
"description": "Extension Attribute 10",
"readonly": true
},
"extensionAttribute11": {
"name": "extensionAttribute11",
"type": "string",
"title": "Extension Attribute 11",
"description": "Extension Attribute 11",
"readonly": true
},
"extensionAttribute12": {
"name": "extensionAttribute12",
"type": "string",
"title": "Extension Attribute 12",
"description": "Extension Attribute 12",
"readonly": true
},
"extensionAttribute13": {
"name": "extensionAttribute13",
"type": "string",
"title": "Extension Attribute 13",
"description": "Extension Attribute 13",
"readonly": true
},
"extensionAttribute14": {
"name": "extensionAttribute14",
"type": "string",
"title": "Extension Attribute 14",
"description": "Extension Attribute 14",
"readonly": true
},
"extensionAttribute15": {
"name": "extensionAttribute15",
"type": "string",
"title": "Extension Attribute 15",
"description": "Extension Attribute 15",
"readonly": true
},
"MsTeams": {
"title": "Ms Teams",
"type": "array",
"items": {
"type": "object",
"properties": {
"AccountEnabled": {
"name": "AccountEnabled",
"type": "boolean",
"title": "Account Enabled"
},
"Alias": {
"name": "Alias",
"type": "string",
"title": "Alias",
"readonly": true
},
"CallingLineIdentity": {
"name": "CallingLineIdentity",
"type": "string",
"title": "Caller ID Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsCallingLineIdentity/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsCallingLineIdentity",
"choices": []
},
"City": {
"name": "City",
"type": "string",
"title": "City",
"readonly": true
},
"Company": {
"name": "Company",
"type": "string",
"title": "Company",
"readonly": true
},
"Country": {
"name": "Country",
"type": "string",
"title": "Country",
"readonly": true
},
"Department": {
"name": "Department",
"type": "string",
"title": "Department",
"readonly": true
},
"DisplayName": {
"name": "DisplayName",
"type": "string",
"title": "Display Name",
"readonly": true
},
"IsSipEnabled": {
"name": "IsSipEnabled",
"type": "boolean",
"title": "Is SIP Enabled",
"readonly": true
},
"EnterpriseVoiceEnabled": {
"name": "EnterpriseVoiceEnabled",
"type": "boolean",
"title": "Enterprise Voice Enabled"
},
"ExternalAccessPolicy": {
"name": "ExternalAccessPolicy",
"type": "string",
"title": "External Access Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsExternalAccessPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsExternalAccessPolicy",
"choices": []
},
"FeatureTypes": {
"name": "FeatureTypes",
"type": "array",
"title": "Feature Types",
"items": {
"type": "string"
}
},
"GivenName": {
"name": "GivenName",
"type": "string",
"title": "Given Name",
"readonly": true
},
"HostingProvider": {
"name": "HostingProvider",
"type": "string",
"title": "Hosting Provider",
"readonly": true
},
"Identity": {
"name": "Identity",
"type": "string",
"title": "Identity",
"readonly": true
},
"InterpretedUserType": {
"name": "InterpretedUserType",
"description": "Internal diagnostic property",
"type": "string",
"title": "Interpreted User Type",
"readonly": true
},
"LineURIType": {
"name": "LineURIType",
"type": "string",
"title": "Line Type",
"choices": [
{
"value": "DirectRouting",
"title": "Direct Routing"
},
{
"value": "CallingPlan",
"title": "Calling Plan"
},
{
"value": "OperatorConnect",
"title": "Operator Connect"
}
]
},
"LineURI": {
"name": "LineURI",
"type": [
"string",
"null"
],
"title": "Line URI"
},
"LineURItel": {
"name": "LineURItel",
"type": "string",
"title": "Line URI TEL portion"
},
"LineURIext": {
"name": "LineURIext",
"type": "string",
"title": "Line URI EXT portion"
},
"ObjectId": {
"name": "ObjectId",
"type": "string",
"title": "Object ID",
"required": true,
"readonly": true
},
"OnlineVoicemailPolicy": {
"name": "OnlineVoicemailPolicy",
"type": "string",
"title": "Voicemail Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlineVoicemailPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsOnlineVoicemailPolicy",
"choices": []
},
"OnlineVoiceRoutingPolicy": {
"name": "OnlineVoiceRoutingPolicy",
"type": "string",
"title": "Voice Routing Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"choices": []
},
"PostalCode": {
"name": "PostalCode",
"type": "string",
"title": "Postal Code",
"readonly": true
},
"SamAccountName": {
"name": "SamAccountName",
"type": "string",
"title": "SAM Account Name",
"readonly": true
},
"SipAddress": {
"name": "SipAddress",
"type": "string",
"title": "SIP Address",
"readonly": true
},
"SipProxyAddress": {
"name": "SipProxyAddress",
"type": "string",
"title": "SIP Proxy Address",
"readonly": true
},
"Street": {
"name": "Street",
"type": "string",
"title": "Street",
"readonly": true
},
"TeamsAppPermissionPolicy": {
"name": "TeamsAppPermissionPolicy",
"type": "string",
"title": "App Permission Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsAppPermissionPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsAppPermissionPolicy",
"choices": []
},
"TeamsAppSetupPolicy": {
"name": "TeamsAppSetupPolicy",
"type": "string",
"title": "App Setup Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsAppSetupPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsAppSetupPolicy",
"choices": []
},
"TeamsAudioConferencingPolicy": {
"name": "TeamsAudioConferencingPolicy",
"type": "string",
"title": "Audio Conferencing Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsAudioConferencingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsAudioConferencingPolicy",
"choices": []
},
"TeamsCallHoldPolicy": {
"name": "TeamsCallHoldPolicy",
"type": "string",
"title": "Call Hold Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsCallHoldPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsCallHoldPolicy",
"choices": []
},
"TeamsCallParkPolicy": {
"name": "TeamsCallParkPolicy",
"type": "string",
"title": "Call Park Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsCallParkPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsCallParkPolicy",
"choices": []
},
"TeamsCallingPolicy": {
"name": "TeamsCallingPolicy",
"type": "string",
"title": "Calling Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsCallingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsCallingPolicy",
"choices": []
},
"TeamsChannelsPolicy": {
"name": "TeamsChannelsPolicy",
"type": "string",
"title": "Teams Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsChannelsPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsChannelsPolicy",
"choices": []
},
"TeamsEmergencyCallingPolicy": {
"name": "TeamsEmergencyCallingPolicy",
"type": "string",
"title": "Emergency Calling Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallingPolicy",
"choices": []
},
"TeamsEmergencyCallRoutingPolicy": {
"name": "TeamsEmergencyCallRoutingPolicy",
"type": "string",
"title": "Emergency Call Routing Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy",
"choices": []
},
"TeamsEnhancedEncryptionPolicy": {
"name": "TeamsEnhancedEncryptionPolicy",
"type": "string",
"title": "Enhanced Encryption Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsEnhancedEncryptionPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEnhancedEncryptionPolicy",
"choices": []
},
"TeamsMeetingBroadcastPolicy": {
"name": "TeamsMeetingBroadcastPolicy",
"type": "string",
"title": "Live Events Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsMeetingBroadcastPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsMeetingBroadcastPolicy",
"choices": []
},
"TeamsMeetingPolicy": {
"name": "TeamsMeetingPolicy",
"type": "string",
"title": "Meeting Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsMeetingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"choices": []
},
"TeamsMessagingPolicy": {
"name": "TeamsMessagingPolicy",
"type": "string",
"title": "Messaging Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsMessagingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsMessagingPolicy",
"choices": []
},
"TeamsUpdateManagementPolicy": {
"name": "TeamsUpdateManagementPolicy",
"type": "string",
"title": "Update Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsUpdateManagementPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsUpdateManagementPolicy",
"choices": []
},
"TeamsUpgradeEffectiveMode": {
"name": "TeamsUpgradeEffectiveMode",
"type": "string",
"title": "Teams Upgrade Effective Mode",
"readonly": true
},
"TeamsUpgradeNotificationsEnabled": {
"name": "TeamsUpgradeNotificationsEnabled",
"type": "boolean",
"title": "Teams Upgrade Notifications Enabled",
"readonly": true
},
"TeamsUpgradePolicy": {
"name": "TeamsUpgradePolicy",
"type": "string",
"title": "Upgrade Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsUpgradePolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsUpgradePolicy",
"choices": []
},
"TeamsUpgradePolicyIsReadOnly": {
"name": "TeamsUpgradePolicyIsReadOnly",
"type": "string",
"title": "Teams Upgrade Policy Is ReadOnly",
"readonly": true
},
"TeamsVideoInteropServicePolicy": {
"name": "TeamsVideoInteropServicePolicy",
"type": "string",
"title": "Video Interop Service Policy",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsVideoInteropServicePolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsVideoInteropServicePolicy",
"choices": []
},
"TenantDialPlan": {
"name": "TenantDialPlan",
"type": "string",
"title": "Dial Plan",
"format": "uri",
"target": "/api/device/msteamsonline/CsTenantDialplan/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTenantDialplan",
"choices": []
},
"UsageLocation": {
"name": "UsageLocation",
"type": "string",
"title": "Usage Location",
"readonly": true
},
"UserPrincipalName": {
"name": "UserPrincipalName",
"type": "string",
"title": "User Principal Name",
"readonly": true
},
"OnlineDialOutPolicy": {
"name": "OnlineDialOutPolicy",
"type": "string",
"title": "Outbound calling",
"choices": [
{
"value": "DialoutCPCandPSTNInternational",
"title": "Any destination"
},
{
"value": "DialoutCPCInternationalPSTNDomestic",
"title": "In the same country or region as the organizer"
},
{
"value": "DialoutCPCandPSTNDisabled",
"title": "Don't allow"
}
]
},
"UserCallingSettings": {
"name": "UserCallingSettings",
"type": [
"object",
"null"
],
"title": "User calling settings",
"properties": {
"CallAnsweringRuleOption": {
"name": "CallAnsweringRuleOption",
"type": "string",
"title": "Call Answering Rules",
"choices": [
{
"value": "Ring devices",
"title": "Ring devices"
},
{
"value": "Be immediately forwarded",
"title": "Be immediately forwarded"
}
]
},
"IsForwardingEnabled": {
"name": "IsForwardingEnabled",
"type": "boolean",
"title": "Is Forwarding Enabled",
"readonly": true
},
"IsUnansweredEnabled": {
"name": "IsUnansweredEnabled",
"type": "boolean",
"title": "Is Unanswered Enabled",
"readonly": true
},
"ForwardingType": {
"name": "ForwardingType",
"type": "string",
"title": "Forwarding Type",
"readonly": true
},
"ForwardingTargetType": {
"name": "ForwardingTargetType",
"type": "string",
"title": "Forwarding Target Type",
"readonly": true
},
"UnansweredTargetType": {
"name": "UnansweredTargetType",
"type": "string",
"title": "Unanswered Target Type",
"readonly": true
},
"GroupNotificationOverride": {
"name": "GroupNotificationOverride",
"type": "string",
"title": "Group Notification Override"
},
"CallGroupTargets": {
"name": "CallGroupTargets",
"type": "array",
"title": "Call Group Targets",
"items": {
"type": "string"
}
},
"CallGroupTargetsEnhanced": {
"name": "CallGroupTargetsEnhanced",
"type": [
"array",
"null"
],
"title": "Manage call group",
"description": "If you want to make sure calls for this user never go unanswered, add people to the table below. The people in this table will all receive or make calls at the same time on this user's behalf.",
"items": {
"type": "object",
"properties": {
"CallGroupOwnerId": {
"name": "CallGroupOwnerId",
"type": "string",
"title": "Call Group Owner"
},
"NotificationSetting": {
"name": "NotificationSetting",
"type": "string",
"title": "Notification Setting",
"default": "Ring",
"choices": [
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Mute",
"title": "Mute"
},
{
"value": "Banner",
"title": "Banner"
}
]
}
}
}
},
"CallGroupOrder": {
"name": "CallGroupOrder",
"type": "string",
"title": "Order of the call group",
"choices": [
{
"value": "InOrder",
"title": "In order of table of rows"
},
{
"value": "Simultaneous",
"title": "Simultaneous ringing"
}
]
},
"CallGroupDetailDelay": {
"name": "CallGroupDetailDelay",
"type": "string",
"title": "Call Group Detail Delay"
},
"GroupMembershipDetails": {
"name": "GroupMembershipDetails",
"type": [
"array",
"null"
],
"title": "Group Membership Details",
"items": {
"type": "object",
"properties": {
"CallGroupOwnerId": {
"name": "CallGroupOwnerId",
"type": "string",
"title": "Call Group Owner"
},
"NotificationSetting": {
"name": "NotificationSetting",
"type": "string",
"title": "Notification Setting",
"default": "Ring",
"choices": [
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Mute",
"title": "Mute"
},
{
"value": "Banner",
"title": "Banner"
}
]
}
}
},
"readonly": false
},
"SipUri": {
"name": "SipUri",
"type": "string",
"title": "Sip Uri",
"readonly": true
},
"Delegators": {
"name": "Delegators",
"type": [
"array",
"null"
],
"title": "Delegators",
"items": {
"type": "object",
"properties": {
"Id": {
"name": "Id",
"type": "string",
"title": "Display name"
},
"Permission": {
"name": "Permission",
"type": "string",
"title": "Permission",
"choices": [
{
"value": "Make calls",
"title": "Make calls"
},
{
"value": "Receive calls",
"title": "Receive calls"
},
{
"value": "Make and receive calls",
"title": "Make and receive calls"
},
{
"value": "Can't make or receive calls",
"title": "Can't make or receive calls"
}
]
},
"ManageSettings": {
"name": "ManageSettings",
"type": "boolean",
"title": "Allow changing call settings"
}
}
}
},
"SimultaneousSettings": {
"name": "SimultaneousSettings",
"type": [
"object",
"null"
],
"title": "Ring device settings",
"properties": {
"SimultaneousOption": {
"name": "SimultaneousOption",
"type": "string",
"title": "Also allow",
"choices": [
{
"value": "Simultaneous ring a user",
"title": "Simultaneous ring a user"
},
{
"value": "Simultaneous ring a number",
"title": "Simultaneous ring a number"
},
{
"value": "MyDelegates",
"title": "Call delegation"
},
{
"value": "Group",
"title": "Group call pickup"
},
{
"value": "None",
"title": "None"
}
]
},
"SimultaneousUnansweredOption": {
"name": "SimultaneousUnansweredOption",
"type": "string",
"title": "If unanswered",
"choices": [
{
"value": "Voicemail",
"title": "Send to voicemail"
},
{
"value": "Forward to a person",
"title": "Forward to a person"
},
{
"value": "Forward to a number",
"title": "Forward to a number"
},
{
"value": "Group",
"title": "Group call pickup"
},
{
"value": "MyDelegates",
"title": "Call delegation"
},
{
"value": "None",
"title": "None"
}
]
},
"ForwardingTargetPerson": {
"name": "ForwardingTargetPerson",
"type": "string",
"title": "Select a person"
},
"ForwardingTargetNumber": {
"name": "ForwardingTargetNumber",
"type": "string",
"title": "Ring another number"
},
"UnansweredTargetPerson": {
"name": "UnansweredTargetPerson",
"type": "string",
"title": "Select a person"
},
"UnansweredTargetNumber": {
"name": "UnansweredTargetNumber",
"type": "string",
"title": "Ring another number"
},
"UnansweredDelay": {
"name": "UnansweredDelay",
"type": "string",
"title": "Ring for this many seconds before redirecting",
"choices": [
{
"value": "00:00:10",
"title": "10 seconds"
},
{
"value": "00:00:20",
"title": "20 seconds (default)"
},
{
"value": "00:00:30",
"title": "30 seconds"
},
{
"value": "00:00:40",
"title": "40 seconds"
},
{
"value": "00:00:50",
"title": "50 seconds"
},
{
"value": "00:01:00",
"title": "60 seconds"
}
]
},
"Delegates": {
"name": "Delegates",
"type": [
"array",
"null"
],
"title": "Call delegation",
"items": {
"type": "object",
"properties": {
"Id": {
"name": "Id",
"type": "string",
"title": "Display name"
},
"Permission": {
"name": "Permission",
"type": "string",
"title": "Permission",
"choices": [
{
"value": "Make calls",
"title": "Make calls"
},
{
"value": "Receive calls",
"title": "Receive calls"
},
{
"value": "Make and receive calls",
"title": "Make and receive calls"
},
{
"value": "Can't make or receive calls",
"title": "Can't make or receive calls"
}
]
},
"ManageSettings": {
"name": "ManageSettings",
"type": "boolean",
"title": "Allow changing call settings"
}
}
}
},
"UnansweredDelegates": {
"name": "UnansweredDelegates",
"type": [
"array",
"null"
],
"title": "Unanswered call delegation",
"items": {
"type": "object",
"properties": {
"Id": {
"name": "Id",
"type": "string",
"title": "Display name"
},
"Permission": {
"name": "Permission",
"type": "string",
"title": "Permission",
"choices": [
{
"value": "Make calls",
"title": "Make calls"
},
{
"value": "Receive calls",
"title": "Receive calls"
},
{
"value": "Make and receive calls",
"title": "Make and receive calls"
},
{
"value": "Can't make or receive calls",
"title": "Can't make or receive calls"
}
]
},
"ManageSettings": {
"name": "ManageSettings",
"type": "boolean",
"title": "Allow changing call settings"
}
}
}
}
}
},
"ImmediateSettings": {
"name": "ImmediateSettings",
"type": [
"object",
"null"
],
"title": "Immediately forwarded settings",
"properties": {
"ImmediateOption": {
"name": "ImmediateOption",
"type": "string",
"title": "Call forward type",
"choices": [
{
"value": "Voicemail",
"title": "Voicemail"
},
{
"value": "Forward to a person",
"title": "Forward to a person"
},
{
"value": "Another number",
"title": "Another number"
},
{
"value": "MyDelegates",
"title": "Delegate"
},
{
"value": "Group",
"title": "Group call pickup"
}
]
},
"ImmediateUnansweredOption": {
"name": "ImmediateUnansweredOption",
"type": "string",
"title": "If unanswered",
"choices": [
{
"value": "Voicemail",
"title": "Send to voicemail"
},
{
"value": "Forward to a person",
"title": "Forward to a person"
},
{
"value": "Forward to a number",
"title": "Forward to a number"
},
{
"value": "Group",
"title": "Group call pickup"
},
{
"value": "None",
"title": "None"
}
]
},
"ForwardingTargetPerson": {
"name": "ForwardingTargetPerson",
"type": "string",
"title": "Select a person"
},
"ForwardingTargetNumber": {
"name": "ForwardingTargetNumber",
"type": "string",
"title": "Ring another number"
},
"UnansweredTargetPerson": {
"name": "UnansweredTargetPerson",
"type": "string",
"title": "Select a person"
},
"UnansweredTargetNumber": {
"name": "UnansweredTargetNumber",
"type": "string",
"title": "Ring another number"
},
"UnansweredDelay": {
"name": "UnansweredDelay",
"type": "string",
"title": "Ring for this many seconds before redirecting",
"choices": [
{
"value": "00:00:10",
"title": "10 seconds"
},
{
"value": "00:00:20",
"title": "20 seconds (default)"
},
{
"value": "00:00:30",
"title": "30 seconds"
},
{
"value": "00:00:40",
"title": "40 seconds"
},
{
"value": "00:00:50",
"title": "50 seconds"
},
{
"value": "00:01:00",
"title": "60 seconds"
}
]
},
"Delegates": {
"name": "Delegates",
"type": [
"array",
"null"
],
"title": "Call delegation",
"items": {
"type": "object",
"properties": {
"Id": {
"name": "Id",
"type": "string",
"title": "Display name"
},
"Permission": {
"name": "Permission",
"type": "string",
"title": "Permission",
"choices": [
{
"value": "Make calls",
"title": "Make calls"
},
{
"value": "Receive calls",
"title": "Receive calls"
},
{
"value": "Make and receive calls",
"title": "Make and receive calls"
},
{
"value": "Can't make or receive calls",
"title": "Can't make or receive calls"
}
]
},
"ManageSettings": {
"name": "ManageSettings",
"type": "boolean",
"title": "Allow changing call settings"
}
}
}
},
"UnansweredDelegates": {
"name": "UnansweredDelegates",
"type": [
"array",
"null"
],
"title": "Unanswered call delegation",
"items": {
"type": "object",
"properties": {
"Id": {
"name": "Id",
"type": "string",
"title": "Display name"
},
"Permission": {
"name": "Permission",
"type": "string",
"title": "Permission",
"choices": [
{
"value": "Make calls",
"title": "Make calls"
},
{
"value": "Receive calls",
"title": "Receive calls"
},
{
"value": "Make and receive calls",
"title": "Make and receive calls"
},
{
"value": "Can't make or receive calls",
"title": "Can't make or receive calls"
}
]
},
"ManageSettings": {
"name": "ManageSettings",
"type": "boolean",
"title": "Allow changing call settings"
}
}
}
}
}
}
}
},
"UserVoicemailSettings": {
"name": "UserVoicemailSettings",
"type": [
"object",
"null"
],
"title": "User voicemail settings",
"properties": {
"CallAnswerRule": {
"name": "CallAnswerRule",
"type": "string",
"title": "Call answering mode",
"choices": [
{
"value": "RegularVoicemail",
"title": "Caller can leave a voicemail"
},
{
"value": "PromptOnly",
"title": "Play an outgoing message to the caller"
},
{
"value": "DeclineCall",
"title": "Service declines the call with no message"
}
]
},
"CallTransferring": {
"name": "CallTransferring",
"type": "string",
"title": "Call transferring",
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "Transfer to a user",
"title": "Transfer to a user"
},
{
"value": "Transfer to a number",
"title": "Transfer to a number"
}
]
},
"TransferTargetUser": {
"name": "TransferTargetUser",
"type": "string",
"title": "Transfer to user",
"readonly": false
},
"TransferTargetNumber": {
"name": "TransferTargetNumber",
"type": "string",
"title": "Transfer to PSTN number",
"readonly": false
},
"DefaultGreetingPromptOverwrite": {
"name": "DefaultGreetingPromptOverwrite",
"type": "string",
"title": "Default greeting prompt",
"readonly": false
},
"DefaultOofGreetingPromptOverwrite": {
"name": "DefaultOofGreetingPromptOverwrite",
"type": "string",
"title": "Default out of office prompt",
"readonly": false
},
"OofGreetingEnabled": {
"name": "OofGreetingEnabled",
"type": "boolean",
"title": "Always play out-of-office greetings",
"readonly": false
},
"OofGreetingFollowAutomaticRepliesEnabled": {
"name": "OofGreetingFollowAutomaticRepliesEnabled",
"type": "boolean",
"title": "When sending automatic replies",
"readonly": false
},
"OofGreetingFollowCalendarEnabled": {
"name": "OofGreetingFollowCalendarEnabled",
"type": "boolean",
"title": "When calendar shows out-of-office",
"readonly": false
},
"ShareData": {
"name": "ShareData",
"type": "boolean",
"title": "ShareData",
"readonly": false
},
"VoicemailEnabled": {
"name": "VoicemailEnabled",
"type": "boolean",
"title": "Voicemail",
"readonly": false
},
"PromptLanguage": {
"name": "PromptLanguage",
"type": "string",
"title": "Prompt language",
"choices": [
{
"value": "ar-EG",
"title": "Arabic (Egypt)"
},
{
"value": "ar-SA",
"title": "Arabic (Saudi Arabia)"
},
{
"value": "bg-BG",
"title": "Bulgarian (Bulgaria)"
},
{
"value": "ca-ES",
"title": "Catalan (Catalan)"
},
{
"value": "zh-CN",
"title": "Chinese (Simplified, PRC)"
},
{
"value": "zh-HK",
"title": "Chinese (Traditional, Hong Kong S.A.R.)"
},
{
"value": "zh-TW",
"title": "Chinese (Traditional, Taiwan)"
},
{
"value": "hr-HR",
"title": "Croatian (Croatia)"
},
{
"value": "cs-CZ",
"title": "Czechia"
},
{
"value": "da-DK",
"title": "Danish (Denmark)"
},
{
"value": "nl-BE",
"title": "Dutch (Begium)"
},
{
"value": "nl-NL",
"title": "Dutch (Netherlands)"
},
{
"value": "en-AU",
"title": "English (Australia)"
},
{
"value": "en-CA",
"title": "English (Canada)"
},
{
"value": "en-IN",
"title": "English (India)"
},
{
"value": "en-IE",
"title": "English (Ireland)"
},
{
"value": "en-PH",
"title": "English (Philippines)"
},
{
"value": "en-ZA",
"title": "English (South Africa)"
},
{
"value": "en-GB",
"title": "English (United Kingdom)"
},
{
"value": "en-US",
"title": "English (United States)"
},
{
"value": "et-EE",
"title": "Estonian (Estonia)"
},
{
"value": "fi-FI",
"title": "Finnish (Finland)"
},
{
"value": "fr-BE",
"title": "French (Belgium)"
},
{
"value": "fr-CA",
"title": "French (Canada)"
},
{
"value": "fr-FR",
"title": "French (France)"
},
{
"value": "fr-CH",
"title": "French (Switzerland)"
},
{
"value": "de-AT",
"title": "German (Austria)"
},
{
"value": "de-DE",
"title": "German (Germany)"
},
{
"value": "de-CH",
"title": "German (Switzerland)"
},
{
"value": "el-GR",
"title": "Greek (Greece)"
},
{
"value": "he-IL",
"title": "Hebrew (Israel)"
},
{
"value": "hi-IN",
"title": "Hindi (India)"
},
{
"value": "hu-HU",
"title": "Hungarian (Hungary)"
},
{
"value": "id-ID",
"title": "Indonesian (Indonesia)"
},
{
"value": "it-IT",
"title": "Italian (Italy)"
},
{
"value": "ja-JP",
"title": "Japanese (Japan)"
},
{
"value": "ko-KR",
"title": "Korean (Korea)"
},
{
"value": "lv-LV",
"title": "Latvian (Latvia)"
},
{
"value": "lt-LT",
"title": "Lithuanian (Lithuania)"
},
{
"value": "nb-NO",
"title": "Norwegian, Bokm\u00e5l (Norway)"
},
{
"value": "pl-PL",
"title": "Polish (Poland)"
},
{
"value": "pt-BR",
"title": "Portuguese (Brazil)"
},
{
"value": "pt-PT",
"title": "Portuguese (Portugal)"
},
{
"value": "ro-RO",
"title": "Romanian (Romania)"
},
{
"value": "ru-RU",
"title": "Russian (Russia)"
},
{
"value": "sk-SK",
"title": "Slovak (Slovakia)"
},
{
"value": "sl-SI",
"title": "Slovenian (Slovenia)"
},
{
"value": "es-MX",
"title": "Spanish (Mexico)"
},
{
"value": "es-ES",
"title": "Spanish (Spain, International Sort)"
},
{
"value": "sv-SE",
"title": "Swedish (Sweden)"
},
{
"value": "th-TH",
"title": "Thai (Thailand)"
},
{
"value": "tr-TR",
"title": "Turkish (Turkey)"
},
{
"value": "vi-VN",
"title": "Vietnamese (Vietnam)"
},
{
"value": "cy-GB",
"title": "Welsh (United Kingdom)"
}
]
}
}
}
}
},
"maxItems": 1
},
"guicontrol": {
"title": "Guicontrol",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "Name",
"type": "string"
},
"user_status": {
"title": "User status",
"description": "User status",
"type": "string"
},
"user_hybrid_service": {
"title": "User Hybrid service",
"description": "Hybrid Service Name",
"type": "string"
},
"is_phone_system": {
"title": "Phone System flag",
"description": "Phone System flag",
"type": "string"
},
"license_type": {
"title": "License type",
"description": "User License type (Group or Direct)",
"type": "string"
},
"groups": {
"title": "Groups",
"description": "List of groups a user belongs to in Microsoft",
"type": "string"
},
"mvs_hybrid_status_message": {
"title": "Hybrid Status Message",
"type": "string"
},
"mvs_hybrid_status": {
"title": "Hybrid Status",
"type": "boolean"
},
"has_voicemail": {
"title": "Has Voicemail",
"type": "boolean"
}
}
},
"User": {
"title": "User",
"type": "array",
"items": {
"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"
}
}
}
}
},
"maxItems": 1
}
},
"schema_version": "0.3"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/MicrosoftSubscriber |
|
{"hrefs": ["/api/relation/MicrosoftSubscriber/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/MicrosoftSubscriber |
|
{"hrefs": ["/api/relation/MicrosoftSubscriber/[pkid1]", "/api/relation/MicrosoftSubscriber/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MicrosoftSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MicrosoftSubscriber/export/ |
|
{ "hrefs":["/api/relation/MicrosoftSubscriber/[pkid1]", "/api/relation/MicrosoftSubscriber/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/MicrosoftSubscriber and the JSON format can be used to import instances of relation/MicrosoftSubscriber.
GET http://[host-proxy]/api/relation/MicrosoftSubscriber/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/MicrosoftSubscriber | POST | /api/relation/MicrosoftSubscriber/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/MicrosoftSubscriber/ |
|
The relation/MicrosoftSubscriber schema and all instances as JSON. |
(The list will return 0 to 3 relation/MicrosoftSubscriber instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "UserPrincipalName",
"direction": "asc",
"current": "/api/relation/MicrosoftSubscriber/?skip=0&limit=3&order_by=UserPrincipalName&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template",
"move"
],
"meta": {
"model_type": "relation/MicrosoftSubscriber",
"summary_attrs": [
{
"name": "UserPrincipalName",
"title": "User Principal Name"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "IsLicensed",
"title": "Is Licensed"
},
{
"name": "DisplayLicenses",
"title": "Licenses Summary"
},
{
"name": "Department",
"title": "Department"
},
{
"name": "City",
"title": "City"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "PhoneNumber",
"title": "Phone Number"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/MicrosoftSubscriber/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template",
"move"
],
"schema_version": "0.3",
"actions": [
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/MicrosoftSubscriber",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/MicrosoftSubscriber/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/MicrosoftSubscriber/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/MicrosoftSubscriber/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/MicrosoftSubscriber/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/MicrosoftSubscriber. | GET | /api/relation/MicrosoftSubscriber/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/MicrosoftSubscriber as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/MicrosoftSubscriber/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/MicrosoftSubscriber | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/MicrosoftSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MicrosoftSubscriber/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/MicrosoftSubscriber and the JSON format can be used to import instances of relation/MicrosoftSubscriber.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/MicrosoftSubscriber/[pkid] | hierarchy=[hierarchy] | The relation/MicrosoftSubscriber instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/MicrosoftSubscriber/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/MicrosoftSubscriber. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Sync Subscriber | POST | /api/relation/MicrosoftSubscriber/[pkid]/+SyncSubscriber | hierarchy=[hierarchy] | If payload required: |