Microsoft 365 account properties
A JSON object that represents a modification of the user's Microsoft 365 account properties.
Attributes
Examples
- Modify licenses
-
{ "locationName": "US", "signInBlocked": false, "licenseModifications": [ { "skuPartNumber": "O365_BUSINESS_PREMIUM", "assigned": true }, { "skuPartNumber": "ENTERPRISEPREMIUM", "assigned": true } ] }
- Modify individual services
-
{ "locationName": "US", "signInBlocked": false, "licenseModifications": [ { "skuPartNumber": "O365_BUSINESS_PREMIUM", "assigned": true, "enabledServices": [ "CDS_O365_P3", "FLOW_O365_P3" ], "disabledServices": [ "EXCHANGEENTERPRISE" ] } ] }
locationName string
A two-letter country code (ISO 3166-1 alpha-2) that represents the user's location in Microsoft 365 e.g. US or AU.
signInBlocked bool
, optional
Set to true
to block the user's sign-in to Microsoft 365 tenant.
licenseModifications array
, optional
An array of objects, each representing a Microsoft 365 license that should be assigned or revoked.
Show attributes
licenseModifications.skuPartNumber string
The SKU part number of the license e.g. ENTERPRISEPACK.
licenseModifications.assigned bool
Set to true
or false
to respectively assign or revoke the license.
licenseModifications.enabledServices array
, optional
Include this attribute to enable indvidual service plans. Specify an array of service plan identifiers (e.g. EXCHANGEENTERPRISE) that correspond to the services to enable.
licenseModifications.disabledServices array
, optional
Include this attribute to disable individual service plans. Specify an array of service plan identifiers (e.g. EXCHANGEENTERPRISE) that correspond to the services to disable.
This attribute will be ignored if enabledServices is also included in the request body when assigning a new license.
When modifying an assigned license, enabledServices always take precedence over disabledServices if the same service plan is specified in both attributes.