[Index]

Model: device/msonline/MsolUser

Model Details: device/msonline/MsolUser

Title Description Details
City The city of the user.
  • Field Name: City
  • Type: String
DisplayName * The display name of the user.
  • Field Name: DisplayName
  • Type: String
FirstName The first name of the user.
  • Field Name: FirstName
  • Type: String
Title The title of the user.
  • Field Name: Title
  • Type: String
LastName The last name of the user.
  • Field Name: LastName
  • Type: String
TenantId The unique ID of the tenant to perform the operation on. If this is not provided then the value will default to the tenant of the current user. This parameter is only applicable to partner users.
  • Field Name: TenantId
  • Type: String
State The state where the user is located.
  • Field Name: State
  • Type: String
PasswordNeverExpires Sets whether or not the user's password will expire periodically.
  • Field Name: PasswordNeverExpires
  • Type: Boolean
Department The department of the user.
  • Field Name: Department
  • Type: String
LicenseAssignment List of licenses to assign the user.
  • Field Name: LicenseAssignment.[n]
  • Type: Array
AlternateMobilePhones Alternate mobile phone numbers of the user
  • Field Name: AlternateMobilePhones.[n]
  • Type: Array
AlternateEmailAddresses The alternate email addresses of the user.
  • Field Name: AlternateEmailAddresses.[n]
  • Type: Array
BlockCredential When true, the user will not be able to log on using their user ID.
  • Field Name: BlockCredential
  • Type: Boolean
IsLicensed
  • Field Name: IsLicensed
  • Type: Boolean
ForceChangePassword When true, the user will be required to change their password the next time they sign in.
  • Field Name: ForceChangePassword
  • Type: Boolean
Password The new password for the user. If the user is set to require a strong password, then all of the following rules must be met: - The password must contain at least one lowercase letter - The password must contain at least one uppercase letter - The password must contain at least one non-alphanumeric character - The password cannot contain any spaces, tabs, or line breaks - The length of the password must be 8-16 characters - The user name cannot be contained in the password If this value is omitted, then a random password will be assigned to the user.
  • Field Name: Password
  • Type: String
UsageLocation The location of the user where services are consumed. Must be a two-letter country code.
  • Field Name: UsageLocation
  • Type: String
ObjectId The unique ID of the user to retrieve.
  • Field Name: ObjectId
  • Type: String
PreferredLanguage The preferred language of the user.
  • Field Name: PreferredLanguage
  • Type: String
Country The country of the user.
  • Field Name: Country
  • Type: String
Fax The fax number of the user.
  • Field Name: Fax
  • Type: String
StreetAddress The street address of the user.
  • Field Name: StreetAddress
  • Type: String
PhoneNumber The phone number of the user.
  • Field Name: PhoneNumber
  • Type: String
PostalCode The postal code of the user.
  • Field Name: PostalCode
  • Type: String
MobilePhone The mobile phone number of the user.
  • Field Name: MobilePhone
  • Type: String
Office The office of the user.
  • Field Name: Office
  • Type: String
UserPrincipalName * The user ID for this user. This is required.
  • Field Name: UserPrincipalName
  • Type: String
ImmutableId The immutable ID of the user's federated identity. This should be omitted for users with standard identities.
  • Field Name: ImmutableId
  • Type: String
ProxyAddresses
  • Field Name: ProxyAddresses.[n]
  • Type: Array
LicenseOptions License options for license assignment. Used to selectively disable individual service plans within a SKU.
  • Field Name: LicenseOptions
  • Type: String
SignInName
  • Field Name: SignInName
  • Type: String
Licenses
  • Field Name: Licenses.[n]
  • Type: Array
Name
  • Field Name: Licenses.[n].FriendlyName
  • Type: String
EnabledPlans
  • Field Name: EnabledPlans.[n]
  • Type: Array
Name
  • Field Name: Licenses.[n].EnabledPlans.[n].FriendlyName
  • Type: String
ServiceType
  • Field Name: Licenses.[n].EnabledPlans.[n].ServiceType
  • Type: String
ServiceName
  • Field Name: Licenses.[n].EnabledPlans.[n].ServiceName
  • Type: String
ServicePlanId
  • Field Name: Licenses.[n].EnabledPlans.[n].ServicePlanId
  • Type: String
  • Target: /api/device/msonline/UCServicePlan/choices/?choice_title=ServicePlanName&field=ServicePlanId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24x5C1TvbsCXNAqe0Y%24VlfXoiKtV77mEgC/TNy0gIfy6zqmCWlFi6Rv8wHZKXaEfzI75OJtoyD3gjyTPCycTOx0LrcTDuF0xOlAHtZEAa/agOBFAk8dPze6dGlETEJM8aiCm/qYUvMCGuxE4ww9YNvGPkI6VskVbL0KIW429XnQp%2BYg9XiNnG9sUu2WDDZ231BJ04vknJvizBmuK13paWZwd/IY7HMAvaru7ber9Va6zvXjSE5GbMDmTDA088m2Ga/YQ%2B2nIHnzBIZBCK17acm60ksNsd9oRViOnFUWcxaFPbaTGedAIw2Jm2tlfZvjMtYbHlt8YVFFaLgHAp5PdyzcKogS01C0c/tKYMmORP9wFxXcgyKmzHZk614pidv5W5iQmNuJHFp534pI0FSmz2SA7xkUVeIwAJeP18rPq47T7xESbj1KYiEMg09KJHNC3BrgOCdq5tnrvTumOqZ2rA%3D%3D%24%3D%3D
  • Target attr: ServicePlanId
  • Target Model Type: device/msonline/UCServicePlan
  • Format: uri
  • Choices: []
AccountSkuId
  • Field Name: Licenses.[n].AccountSkuId
  • Type: String
  • Target: /api/device/msonline/MsolAccountSku/choices/?choice_title=AccountSkuId&field=AccountSkuId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24NUPjOrWAnLfli9YE%24uXGL34/orUAmyLWTKQWR3rfPGuQ%2B9o5%2BIoKy07Z91RcHx9EU1xBNBxnqCqy%2BsQuBiyKny7HiCaxNprMKHh6Qp/XoixXNN/x5k0PLjdpA34dMVAHCsRmtpcAm2OCBYi7ODW5/scc%2BzYwRfEPGwCzMAtHKmnM69oyLtdP0abLbScvjwtoSWAZP39Tv0/4D4yrmIQCi2XlP7JnbtMbg8RCQQoLYgF52tWcrtJ/hhKTmaEr/FUoYYF%2B3fvtwaPq8LqaNq5eSea0MBoZsqtM9BziOmU6dXkKTLls6Jpr26aQZE81WLoMt5iUQkbifFcuU4%2BG6GotLrne7PXiBnt4uBftijb3ERtyuPZh9wgdRWPqlEA85FgBvPzpl%2BSB5d7AR9F12q0zyMFC1XMHtSbCxzgcjMBlP7fUPWicmivUBMDzrivwSlDrgLxiOUEwi17YQ9A%3D%3D%24%3D%3D
  • Target attr: AccountSkuId
  • Target Model Type: device/msonline/MsolAccountSku
  • Format: uri
  • Choices: []
StrongPasswordRequired Sets whether or not the user requires a strong password.
  • Field Name: StrongPasswordRequired
  • Type: Boolean