[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": {
"City": {
"readonly": true,
"type": "string",
"name": "City",
"title": "City"
},
"DisplayName": {
"readonly": true,
"type": "string",
"name": "DisplayName",
"title": "Display Name"
},
"FirstName": {
"readonly": true,
"type": "string",
"name": "FirstName",
"title": "First Name"
},
"Title": {
"readonly": true,
"type": "string",
"name": "Title",
"title": "Title"
},
"LastName": {
"readonly": true,
"type": "string",
"name": "LastName",
"title": "Last Name"
},
"State": {
"readonly": true,
"type": "string",
"name": "State",
"title": "State"
},
"Department": {
"readonly": true,
"type": "string",
"name": "Department",
"title": "Department"
},
"MsTeams": {
"items": {
"type": "object",
"properties": {
"City": {
"readonly": true,
"type": "string",
"name": "City",
"title": "City"
},
"TeamsEmergencyCallingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Emergency Calling Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallingPolicy",
"type": "string",
"name": "TeamsEmergencyCallingPolicy"
},
"DisplayName": {
"readonly": true,
"type": "string",
"name": "DisplayName",
"title": "Display Name"
},
"TeamsUpgradeNotificationsEnabled": {
"readonly": true,
"type": "boolean",
"name": "TeamsUpgradeNotificationsEnabled",
"title": "Teams Upgrade Notifications Enabled"
},
"HostingProvider": {
"readonly": true,
"type": "string",
"name": "HostingProvider",
"title": "Hosting Provider"
},
"TeamsVideoInteropServicePolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsVideoInteropServicePolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Video Interop Service Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsVideoInteropServicePolicy",
"type": "string",
"name": "TeamsVideoInteropServicePolicy"
},
"TeamsUpgradePolicyIsReadOnly": {
"readonly": true,
"type": "string",
"name": "TeamsUpgradePolicyIsReadOnly",
"title": "Teams Upgrade Policy Is ReadOnly"
},
"LineURItel": {
"type": "string",
"name": "LineURItel",
"title": "Line URI TEL portion"
},
"TeamsCallingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsCallingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Calling Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsCallingPolicy",
"type": "string",
"name": "TeamsCallingPolicy"
},
"LineURI": {
"type": [
"string",
"null"
],
"name": "LineURI",
"title": "Line URI"
},
"TeamsEmergencyCallRoutingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Emergency Call Routing Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy",
"type": "string",
"name": "TeamsEmergencyCallRoutingPolicy"
},
"Department": {
"readonly": true,
"type": "string",
"name": "Department",
"title": "Department"
},
"TeamsUpdateManagementPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsUpdateManagementPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Update Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsUpdateManagementPolicy",
"type": "string",
"name": "TeamsUpdateManagementPolicy"
},
"GivenName": {
"readonly": true,
"type": "string",
"name": "GivenName",
"title": "Given Name"
},
"TeamsMessagingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsMessagingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Messaging Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsMessagingPolicy",
"type": "string",
"name": "TeamsMessagingPolicy"
},
"InterpretedUserType": {
"readonly": true,
"title": "Interpreted User Type",
"type": "string",
"name": "InterpretedUserType",
"description": "Internal diagnostic property"
},
"TenantDialPlan": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTenantDialplan/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Dial Plan",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTenantDialplan",
"type": "string",
"name": "TenantDialPlan"
},
"ExternalAccessPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsExternalAccessPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "External Access Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsExternalAccessPolicy",
"type": "string",
"name": "ExternalAccessPolicy"
},
"TeamsUpgradePolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsUpgradePolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Upgrade Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsUpgradePolicy",
"type": "string",
"name": "TeamsUpgradePolicy"
},
"EnterpriseVoiceEnabled": {
"type": "boolean",
"name": "EnterpriseVoiceEnabled",
"title": "Enterprise Voice Enabled"
},
"LineURIext": {
"type": "string",
"name": "LineURIext",
"title": "Line URI EXT portion"
},
"Company": {
"readonly": true,
"type": "string",
"name": "Company",
"title": "Company"
},
"OnlineVoiceRoutingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Voice Routing Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"type": "string",
"name": "OnlineVoiceRoutingPolicy"
},
"TeamsAudioConferencingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsAudioConferencingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Audio Conferencing Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsAudioConferencingPolicy",
"type": "string",
"name": "TeamsAudioConferencingPolicy"
},
"SipProxyAddress": {
"readonly": true,
"type": "string",
"name": "SipProxyAddress",
"title": "SIP Proxy Address"
},
"SipAddress": {
"readonly": true,
"type": "string",
"name": "SipAddress",
"title": "SIP Address"
},
"UsageLocation": {
"readonly": true,
"type": "string",
"name": "UsageLocation",
"title": "Usage Location"
},
"Identity": {
"readonly": true,
"type": "string",
"name": "Identity",
"title": "Identity"
},
"TeamsMeetingBroadcastPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsMeetingBroadcastPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Live Events Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsMeetingBroadcastPolicy",
"type": "string",
"name": "TeamsMeetingBroadcastPolicy"
},
"TeamsEnhancedEncryptionPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsEnhancedEncryptionPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Enhanced Encryption Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEnhancedEncryptionPolicy",
"type": "string",
"name": "TeamsEnhancedEncryptionPolicy"
},
"FeatureTypes": {
"items": {
"type": "string"
},
"type": "array",
"name": "FeatureTypes",
"title": "Feature Types"
},
"TeamsAppPermissionPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsAppPermissionPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "App Permission Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsAppPermissionPolicy",
"type": "string",
"name": "TeamsAppPermissionPolicy"
},
"ObjectId": {
"readonly": true,
"required": true,
"type": "string",
"name": "ObjectId",
"title": "Object ID"
},
"Country": {
"readonly": true,
"type": "string",
"name": "Country",
"title": "Country"
},
"TeamsAppSetupPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsAppSetupPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "App Setup Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsAppSetupPolicy",
"type": "string",
"name": "TeamsAppSetupPolicy"
},
"Alias": {
"readonly": true,
"type": "string",
"name": "Alias",
"title": "Alias"
},
"TeamsChannelsPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsChannelsPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Teams Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsChannelsPolicy",
"type": "string",
"name": "TeamsChannelsPolicy"
},
"TeamsCallParkPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsCallParkPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Park Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsCallParkPolicy",
"type": "string",
"name": "TeamsCallParkPolicy"
},
"PostalCode": {
"readonly": true,
"type": "string",
"name": "PostalCode",
"title": "Postal Code"
},
"OnlineVoicemailPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsOnlineVoicemailPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Voicemail Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsOnlineVoicemailPolicy",
"type": "string",
"name": "OnlineVoicemailPolicy"
},
"TeamsMeetingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsMeetingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Meeting Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsMeetingPolicy",
"type": "string",
"name": "TeamsMeetingPolicy"
},
"AccountEnabled": {
"type": "boolean",
"name": "AccountEnabled",
"title": "Account Enabled"
},
"SamAccountName": {
"readonly": true,
"type": "string",
"name": "SamAccountName",
"title": "SAM Account Name"
},
"TeamsUpgradeEffectiveMode": {
"readonly": true,
"type": "string",
"name": "TeamsUpgradeEffectiveMode",
"title": "Teams Upgrade Effective Mode"
},
"UserPrincipalName": {
"readonly": true,
"type": "string",
"name": "UserPrincipalName",
"title": "User Principal Name"
},
"IsSipEnabled": {
"readonly": true,
"type": "boolean",
"name": "IsSipEnabled",
"title": "Is SIP Enabled"
},
"Street": {
"readonly": true,
"type": "string",
"name": "Street",
"title": "Street"
},
"TeamsTemplatePermissionPolicy": {
"type": "string",
"name": "TeamsTemplatePermissionPolicy",
"title": "Templates Policy"
},
"LineURIType": {
"choices": [
{
"value": "DirectRouting",
"title": "Direct Routing"
},
{
"value": "CallingPlan",
"title": "Calling Plan"
},
{
"value": "OperatorConnect",
"title": "Operator Connect"
}
],
"type": "string",
"name": "LineURIType",
"title": "Line Type"
},
"CallingLineIdentity": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsCallingLineIdentity/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Caller ID Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsCallingLineIdentity",
"type": "string",
"name": "CallingLineIdentity"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Ms Teams"
},
"User": {
"items": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"description": "The User last name.",
"title": "Last 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"
},
"ldap_server": {
"description": "A reference to the LDAP server which this user must authenticate against.",
"title": "LDAP Server",
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "data/Ldap",
"type": "string",
"target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"manager": {
"type": "string",
"description": "Manager.",
"title": "Manager"
},
"postal_code": {
"type": "string",
"description": "Contains code used by a Postal Service to identify postal service zones.",
"title": "Postal Code"
},
"jabber_id": {
"type": "string",
"description": "Jabber ID",
"title": "Jabber ID"
},
"display_name": {
"type": "string",
"description": "Display name of the user",
"title": "Display Name"
},
"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"
},
"title": {
"type": "string",
"description": "Title.",
"title": "Title"
},
"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"
},
"home_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's home phone number(s).",
"title": "Home Phone"
},
"customString3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"customString2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"customString1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"customString7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"customString6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"customString5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"customString4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"customString9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"customString8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"mvs_primary_line_cos": {
"type": "string",
"title": "Primary Class of Service"
},
"mvs_hybrid_status": {
"required": false,
"type": "string",
"title": "Hybrid Status"
},
"username_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in the LDAP Directory.",
"title": "LDAP Directory User Name"
},
"password": {
"is_password": true,
"description": "The User password.",
"title": "Password",
"pattern": ".{8,}",
"store_encrypted": true,
"type": "string"
},
"mvs_primary_line": {
"type": "string",
"title": "Primary Line"
},
"account_information": {
"properties": {
"reason_for_disabled": {
"required": false,
"type": "string",
"description": "A description of why the account is disabled.",
"title": "Reason for Disabled"
},
"locked": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been locked to prevent the user from logging in.",
"title": "Locked"
},
"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"
},
"security_questions": {
"items": {
"type": "object",
"properties": {
"answer": {
"title": "Answer",
"required": true,
"type": "string",
"maxLength": 128
},
"question": {
"maxLength": 128,
"required": true,
"type": "string",
"displayable": true,
"title": "Question"
}
}
},
"type": "array",
"title": "Security Questions"
},
"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"
},
"credential_policy": {
"description": "Specifies the policy with the rules used to govern this user's credentials.",
"title": "Credential Policy",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"target_model_type": "data/CredentialPolicy",
"type": "string",
"target": "/api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"failed_login_lock_date": {
"title": "Time Locked Due to Failed Login Attempts",
"required": false,
"type": "string",
"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"
},
"password_last_change_time_by_user": {
"description": "The time when the password was last changed by the user.",
"title": "Time of Last Password Change By User",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"password_last_change_time": {
"description": "The time when the password was last changed.",
"title": "Time of Last Password Change",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"num_of_failed_login_attempts": {
"default": "0",
"required": false,
"type": "integer",
"description": "The total number of failed login attempts since last successful login.",
"title": "Number of Failed Login Attempts Since Last Successful Login"
},
"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"
},
"last_login_time": {
"description": "The time the user last logged in successfully.",
"title": "Time of Last Successful Login",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
}
},
"required": false,
"type": "object",
"description": "Additional account information for the given user.",
"title": "Account Information"
},
"telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Telephone Number.",
"title": "Telephone Number"
},
"street": {
"type": "string",
"description": "Contains site information from a postal address.",
"title": "Street"
},
"object_class": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Object Class"
},
"building_name": {
"type": "string",
"description": "Building name or number.",
"title": "Building Name"
},
"first_name": {
"type": "string",
"description": "The User first name.",
"title": "First Name"
},
"employee_number": {
"type": "string",
"description": "Employee number of the user",
"title": "Employee Number"
},
"username_cuc": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unity Connection.",
"title": "Cisco Unity Connection User Name"
},
"entitlement_profile": {
"is_password": false,
"target_model_type": "data/HcsEntitlementProfileDAT",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "Entitlement Profile",
"type": "string"
},
"state": {
"type": "string",
"description": "Contains full names of state or province.",
"title": "State"
},
"email": {
"required": false,
"type": "string",
"description": "The User email address.",
"title": "Email Address"
},
"username_microsoft": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Microsoft Username.",
"title": "Microsoft 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"
},
"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"
},
"sync_source": {
"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).",
"title": "Sync Source",
"default": "LOCAL",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/UserSyncSource",
"type": "string",
"target": "/api/data/UserSyncSource/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"auth_method": {
"default": "Local",
"choices": [
{
"value": "Local",
"title": "Local"
},
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "LDAP",
"title": "LDAP"
},
{
"value": "SSO",
"title": "SSO"
}
],
"type": "string",
"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"
},
"sso_idp": {
"description": "The entity id of the SSO Identity Provider.",
"title": "SSO Identity Provider",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "entity_id",
"target_model_type": "data/SsoIdentityProvider",
"type": "string",
"target": "/api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"customListOfStrings7": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 7"
},
"preferred_language": {
"type": "string",
"description": "Preferred Language.",
"title": "Preferred Language"
},
"country": {
"type": "string",
"description": "Country name.",
"title": "Country"
},
"username_open_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Opoen LDAP.",
"title": "Open LDAP User Name"
},
"unverified_mailbox": {
"type": "string",
"description": "Unverified Mail Box.",
"title": "Unverified Mail Box"
},
"mvs_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",
"description": "Extensions to select primary details from.",
"title": "Extensions"
},
"ldap_username": {
"type": "string",
"description": "The login attribute of the associated LDAP device model instance",
"title": "LDAP Username"
},
"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"
},
"facsimile_telephone_number": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's facsimile telephone Number(s).",
"title": "Facsimile Telephone Number"
},
"employee_type": {
"type": "string",
"description": "Employee type",
"title": "Employee Type"
},
"city": {
"type": "string",
"description": "Contains the name of a person's locality.",
"title": "City"
},
"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"
},
"username": {
"required": true,
"type": "string",
"description": "User's Username.",
"title": "User Name"
},
"physical_delivery_office_name": {
"type": "string",
"description": "Physical Delivery Office Name.",
"title": "Physical Delivery Office Name"
},
"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"
},
"language": {
"description": "The preferred language for this user.",
"format": "uri",
"default": "en-us",
"required": false,
"choices": [],
"target_attr": "lcid",
"target_model_type": "data/Language",
"title": "Language",
"type": "string",
"target": "/api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"member_of": {
"items": {
"type": "string"
},
"type": "array",
"description": "The user can be a member of a variety of groups.",
"title": "Member Of"
},
"username_ms_ldap": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Microsoft LDAP.",
"title": "Microsoft LDAP User Name"
},
"customString10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"ip_phone": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP phone number(s).",
"title": "IP Phone"
},
"customListOfStrings10": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom List of Strings",
"title": "Custom List of Strings 10"
},
"username_broadworks": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Broadworks.",
"title": "Broadworks User Name"
},
"customBoolean10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"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"
},
"timezone": {
"type": "string",
"description": "Timezone.",
"title": "Timezone"
},
"directory_uri": {
"type": "string",
"description": "Alphanumeric Directory URI (e.g. SIP URI)",
"title": "Directory URI"
},
"other_mailbox": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"title": "Other Mailbox"
},
"role": {
"description": "The role to which the user belongs. See: Role.",
"title": "Role",
"format": "uri",
"required": true,
"choices": [],
"target_attr": "name",
"target_model_type": "data/Role",
"type": "string",
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"department": {
"type": "string",
"description": "Department names and numbers.",
"title": "Department"
},
"username_zoom": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Zoom.",
"title": "Zoom 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"
},
"sso_username": {
"required": false,
"type": "string",
"description": "The name identifier that is used for an SSO authenticated user.",
"title": "SSO Username"
},
"username_hcmf": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Cisco HCMF.",
"title": "HCMF User Name"
},
"ou": {
"minItems": 0,
"items": {
"is_password": false,
"type": "string"
},
"type": "array",
"description": "The name of the person's organization unit.",
"title": "Organizational Unit"
},
"photo_url": {
"type": "string",
"description": "Photo URL.",
"title": "Photo URL"
},
"customBoolean7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"customBoolean6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"customBoolean5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"customBoolean4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"customBoolean3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"customBoolean2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"customBoolean1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"mobile": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains strings that represent the user's IP mobile number(s).",
"title": "Mobile"
},
"customBoolean9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"customBoolean8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"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.",
"title": "Authorized Admin Hierarchy",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"target_model_type": "data/AuthorizedAdminHierarchy",
"type": "string",
"target": "/api/data/AuthorizedAdminHierarchy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"organization": {
"type": "string",
"description": "The name of the person's organization.",
"title": "Organization"
},
"username_webex_teams": {
"required": false,
"type": "string",
"description": "The username corresponding to the the Username in Webex App.",
"title": "Webex App User Name"
},
"set_language": {
"default": false,
"required": false,
"type": "boolean",
"description": "Indicate if the user's language is set by language default in the hierarchy.",
"title": "Set by Default Language"
}
}
},
"type": "array",
"maxItems": 1,
"title": "User"
},
"UsageLocation": {
"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"
}
],
"type": "string",
"name": "UsageLocation",
"title": "Usage Location"
},
"ObjectId": {
"readonly": true,
"required": true,
"type": "string",
"name": "ObjectId",
"title": "Object ID"
},
"Country": {
"readonly": true,
"type": "string",
"name": "Country",
"title": "Country"
},
"guicontrol": {
"type": "object",
"properties": {
"user_status": {
"type": "string",
"description": "User status",
"title": "User status"
},
"name": {
"type": "string",
"description": "Name",
"title": "Name"
},
"user_hybrid_service": {
"type": "string",
"description": "Hybrid Service Name",
"title": "User Hybrid service"
}
},
"title": "Guicontrol"
},
"StreetAddress": {
"readonly": true,
"type": "string",
"name": "StreetAddress",
"title": "Street Address"
},
"PhoneNumber": {
"readonly": true,
"type": "string",
"name": "PhoneNumber",
"title": "Phone Number"
},
"PostalCode": {
"readonly": true,
"type": "string",
"name": "PostalCode",
"title": "Postal Code"
},
"MobilePhone": {
"readonly": true,
"type": "string",
"name": "Mobile Phone",
"title": "Mobile Phone"
},
"Office": {
"readonly": true,
"type": "string",
"name": "Office",
"title": "Office"
},
"UserPrincipalName": {
"readonly": true,
"type": "string",
"name": "UserPrincipalName",
"title": "User Principal Name"
},
"DisplayLicenses": {
"readonly": true,
"type": "string",
"name": "DisplayLicenses",
"title": "Licenses Summary"
},
"ProxyAddresses": {
"items": {
"readonly": true,
"type": "string"
},
"readonly": true,
"type": "array",
"name": "ProxyAddresses",
"title": "Proxy Addresses"
},
"Licenses": {
"items": {
"type": "object",
"properties": {
"SkuId": {
"readonly": true,
"type": "string",
"name": "SkuId",
"title": "SKU ID"
},
"ServicePlans": {
"items": {
"type": "object",
"properties": {
"ServiceName": {
"readonly": true,
"type": "string",
"name": "ServiceName",
"title": "Service Name"
},
"Enabled": {
"type": "boolean",
"name": "Enabled",
"title": "Enabled"
},
"ServicePlanId": {
"readonly": true,
"type": "string",
"name": "ServicePlanId",
"title": "Service Plan ID"
}
}
},
"type": "array",
"name": "ServicePlans",
"title": "Service Plans"
},
"AccountSkuId": {
"target": "/api/device/msgraph/MsolAccountSku/choices/?field=SkuPartNumber&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "SKU Part Number",
"choices": [],
"target_attr": "SkuPartNumber",
"target_model_type": "device/msgraph/MsolAccountSku",
"type": "string",
"name": "AccountSkuId"
}
}
},
"type": "array",
"name": "Licenses",
"title": "Licenses"
},
"UserMailbox": {
"items": {
"type": "object",
"properties": {
"MaxSendSize": {
"title": "Maximum Send Size",
"type": "string",
"name": "MaxSendSize",
"description": "The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox.\\n\\nWhen you enter a value, qualify the value with one of the following units:\\n\\n B (bytes)\\n KB (kilobytes)\\n MB (megabytes)\\n GB (gigabytes)\\n\\nUnqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.\\n\\nA valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited.\\n\\nIn Exchange Online, the value is determined by the subscriptions and licenses that administrators purchase and assign in the Microsoft 365 admin center. You can lower the value, and you may be able to raise the value, but you can't exceed the maximum value that's allowed by the subscription or license.\\n\\nIn Exchange Online, you use this parameter to configure the MaxSendSize value on existing mailboxes. Use the Set-MailboxPlan cmdlet to change the MaxSendSize value for all new mailboxes that you create in the future.\\n\\nIn on-premises Exchange, the default value unlimited indicates the maximum send size for the mailbox is imposed elsewhere (for example, organization, server, or connector limits).\\n\\nBase64 encoding increases the size of messages by approximately 33%, so specify a value that's 33% larger than the actual maximum message size that you want to enforce. For example, the value 64 MB results in a maximum message size of approximately 48 MB."
},
"Name": {
"type": "string",
"name": "Name",
"title": "Name"
},
"UserPrincipalName": {
"type": "string",
"name": "UserPrincipalName",
"title": "User Principal Name"
},
"DisplayName": {
"type": "string",
"name": "DisplayName",
"title": "Display Name"
},
"CalendarPermissions": {
"items": {
"type": "object",
"properties": {
"User": {
"target_title": "DisplayName",
"target": "/api/device/msexchangeonline/UserMailbox/choices/?choice_title=DisplayName&field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "User",
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msexchangeonline/UserMailbox",
"type": "string",
"name": "User"
},
"AccessRights": {
"items": {
"type": "string",
"choices": [
{
"value": "Owner",
"title": "Owner"
},
{
"value": "PublishingEditor",
"title": "Publishing Editor"
},
{
"value": "Editor",
"title": "Editor"
},
{
"value": "PublishingAuthor",
"title": "Publishing Author"
},
{
"value": "Author",
"title": "Author"
},
{
"value": "NonEditingAuthor",
"title": "Non Editing Author"
},
{
"value": "Reviewer",
"title": "Reviewer"
},
{
"value": "Contributor",
"title": "Contributor"
},
{
"value": "AvailabilityOnly",
"title": "Availability Only"
},
{
"value": "LimitedDetails",
"title": "Limited Details"
},
{
"value": "None",
"title": "None"
},
{
"value": "CreateItems",
"title": "Create Items"
},
{
"value": "CreateSubfolders",
"title": "Create Subfolders"
},
{
"value": "DeleteAllItems",
"title": "Delete All Items"
},
{
"value": "DeleteOwnedItems",
"title": "Delete Owned Items"
},
{
"value": "EditAllItems",
"title": "Edit All Items"
},
{
"value": "EditOwnedItems",
"title": "Edit Owned Items"
},
{
"value": "FolderContact",
"title": "Folder Contact"
},
{
"value": "FolderOwner",
"title": "Folder Owner"
},
{
"value": "FolderVisible",
"title": "Folder Visible"
},
{
"value": "ReadItems",
"title": "Read Items"
}
]
},
"type": "array",
"name": "AccessRights",
"title": "Access Rights"
}
}
},
"type": "array",
"name": "CalendarPermissions",
"title": "Calendar Permissions"
},
"EmailAddresses": {
"items": {
"type": "string"
},
"type": "array",
"name": "EmailAddresses",
"title": "Email Addresses"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"name": "Identity",
"title": "Identity"
},
"Permissions": {
"items": {
"type": "object",
"properties": {
"User": {
"target_title": "DisplayName",
"target": "/api/device/msexchangeonline/UserMailbox/choices/?choice_title=DisplayName&field=Name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "User",
"choices": [],
"target_attr": "Name",
"target_model_type": "device/msexchangeonline/UserMailbox",
"type": "string",
"name": "User"
},
"AccessRights": {
"items": {
"type": "string",
"choices": [
{
"value": "FullAccess",
"title": "Read And Manage"
},
{
"value": "SendAs",
"title": "Send As"
},
{
"value": "SendOnBehalfTo",
"title": "Send On Behalf"
}
]
},
"type": "array",
"name": "AccessRights",
"title": "Access Rights"
}
}
},
"type": "array",
"name": "Permissions",
"title": "Permissions"
}
}
},
"type": "array",
"maxItems": 1,
"title": "User Mailbox"
}
},
"schema_version": "0.1"
}
| 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)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "UserPrincipalName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/MicrosoftSubscriber/?skip=0&limit=3&order_by=UserPrincipalName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "0.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/MicrosoftSubscriber/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/MicrosoftSubscriber",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/MicrosoftSubscriber/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/MicrosoftSubscriber/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/MicrosoftSubscriber/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/MicrosoftSubscriber/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/MicrosoftSubscriber",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "UserPrincipalName",
"title": "User Principal Name"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "DisplayLicenses",
"title": "Licenses Summary"
},
{
"name": "Department",
"title": "Department"
},
{
"name": "City",
"title": "City"
},
{
"name": "Country",
"title": "Country"
},
{
"name": "PhoneNumber",
"title": "Phone Number"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"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: |