N-able Cloud User Hub (Preview)
Cloud User Hub is a unified Microsoft CSP portal that lets you automate common tasks across all Microsoft 365 apps without switching consoles or customers.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Cloud User Hub Support |
| URL | https://documentation.clouduserhub.management/kb/en |
| technicalsupport@n-able.com |
| Connector Metadata | |
|---|---|
| Publisher | N-able Cloud User Hub B.V. |
| Website | https://www.n-able.com |
| Privacy policy | https://www.n-able.com/legal/privacy |
| Categories | Business Management;IT Operations |
Cloud User Hub is a unified Microsoft CSP portal that lets you automate common tasks across all Microsoft 365 apps without switching consoles or customers.
Prerequisites
You will need the following to proceed:
- A Cloud User Hub subscription
- Configured solutions in Cloud User Hub for the specific operations you intend to use
- Configured roles in Cloud User Hub for the specific operations you intend to use .
How to get credentials
You can login with any account that is configured to access Cloud User Hub. For automation scenarios we advise you to use a dedicated service account.
Get started with your connector
Start with Get organizations, to retrieve a list of organizations your're allowed to manage (including your own). Organizations are returned according to the configured role scopes in Cloud User Hub. Use the Ids for consecutive calls. For operations that required a partner Id, use the Id from your own organization. For some operations you'll require a tenant Id instead of the internal Cloud User Hub Id or both.
Known issues and limitations
Some operations require the target organization to have a matching Microsoft 365 license and/or an active Azure subscription. For example: configuring conditional access, requires an Microsoft Entra ID Premium license.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add a Command Block job for a group |
Add a Command Block job. The provider and action validation is based on the specific Command Block. |
| Add a Command Block job for a user |
Add a Command Block job. The provider and action validation is based on the specific Command Block. |
| Add a Command Block job for an organization |
Add a Command Block job. The provider and action validation is based on the specific Command Block. |
| Add a member to a group |
Add a member to a Microsoft 365 group or a security group through the members navigation property. |
| Add a member to a user group |
Add a member to a user group, the member should belong to the same organization as the group. |
| Assign a license to a user |
Add or remove licenses for the user. You can also enable and disable specific plans associated with a license. |
| Create Azure AD group |
Create azure AD group. |
| Create user |
The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties. |
| Delete Cloud User Hub user group |
Delete a user group. |
| Delete user |
Delete a user. When deleted, user resources are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. |
| Get a list of Cloud User Hub user group members |
Get a list of user group members of a specific group. |
| Get Azure AD security groups |
Get a list of Azure AD security groups of all organizations you are authorized to view. |
| Get Cloud User Hub user groups |
Get a list of groups of all organizations you are authorized to view. |
| Get Command Block details |
Get the details of a Command Block. Provider and action validation depend on the the specific Command Block. |
| Get Command Block jobs for all authorized organizations |
Get Command Block jobs for Command Blocks you're authorized to view. |
| Get Command Block jobs of a specific organization |
Get Command Block jobs for Command Blocks you're authorized to view. |
| Get Command Categories |
Get all available categories and subcategories. |
| Get details of a single user job |
Get details of a single user job, provider and action validation depend on the the specific command block. |
| Get locales |
Get locales. |
| Get organization subscribed SKUs |
Get the list of commercial subscriptions that an organization has acquired. |
| Get organizations |
Get all organizations you are authorized to view. |
| Get statistics on the Command Block jobs for all authorized organizations |
Get statistics on the Command Block jobs for Command Blocks you're authorized to view. |
| Get subscriptions |
Retrieves all subscriptions for the customer of a partner by their active directory tenant identifier. |
| Get user details |
Get a user by Microsoft object identifier. |
| Get user license details |
Retrieve a list of license details objects for enterprise users. |
| Get users |
Retrieve a list of user objects. |
| List Command Blocks |
Retrieve a list of available Command Blocks. |
| List organization domains |
Retrieve a list of domain objects. |
| Remove a member from a user group |
Remove a member to a user group. |
| Remove member |
Remove a member from a group via the members navigation property. |
| Update subscription quantity |
Update the quantity of a subscription. |
| User change password |
Update the password profile of a user to reset their password. |
Add a Command Block job for a group
Add a Command Block job. The provider and action validation is based on the specific Command Block.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Id
|
organizationId | True | string |
Format - uuid. Unique identifier of the organization. |
|
Command Block Id
|
commandBlockId | True | string |
Format - uuid. Unique identifier of the Command Block. |
|
Target Group Id
|
targetGroupId | True | string |
Format - uuid. Unique identifier of the target group. |
|
Technical id
|
technicalIdentifier | string |
Technical Identifier. |
|
|
Value
|
value | string |
Value. |
|
|
Schedule id
|
scheduleId | string |
Schedule identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | string |
Value. |
Add a Command Block job for a user
Add a Command Block job. The provider and action validation is based on the specific Command Block.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Id
|
organizationId | True | string |
Format - uuid. Unique identifier of the organization. |
|
Command Block Id
|
commandBlockId | True | string |
Format - uuid. Unique identifier of the Command Block. |
|
Target User Id
|
targetUserId | True | string |
Format - uuid. Unique identifier of the target user. |
|
Technical id
|
technicalIdentifier | string |
Technical Identifier. |
|
|
Value
|
value | string |
Value. |
|
|
Schedule id
|
scheduleId | string |
Schedule identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | string |
Value. |
Add a Command Block job for an organization
Add a Command Block job. The provider and action validation is based on the specific Command Block.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Id
|
organizationId | True | string |
Format - uuid. Unique identifier of the organization. |
|
Command Block Id
|
commandBlockId | True | string |
Format - uuid. Unique identifier of the Command Block. |
|
Target Organization Id
|
targetOrganizationId | True | string |
Format - uuid. Unique identifier of the target organization. |
|
Technical id
|
technicalIdentifier | string |
Technical Identifier |
|
|
Value
|
value | string |
Value. |
|
|
Schedule id
|
scheduleId | string |
Schedule identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | string |
Value. |
Add a member to a group
Add a member to a Microsoft 365 group or a security group through the members navigation property.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Microsoft object id of the group.
|
microsoftObjectId | True | string |
Microsoft object identifier of the group. |
|
Member
|
@odata.id | True | string |
URI of the directory, user, group, or organizational contact object to be added. |
Add a member to a user group
Add a member to a user group, the member should belong to the same organization as the group.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Cloud User Hub user group id.
|
userGroupId | True | string |
Cloud User Hub user group identifier. |
|
Cloud User Hub user id.
|
userId | True | string |
Cloud User Hub user identifier. |
Assign a license to a user
Add or remove licenses for the user. You can also enable and disable specific plans associated with a license.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
Microsoft object identifier of the user. |
|
disabledPlans
|
disabledPlans | array of |
Disabled plans. |
|
|
Sku id
|
skuId | string |
Sku identifier of the Microsoft license. |
|
|
Remove licenses
|
removeLicenses | array of |
A collection of GUIDs that identify the licenses to remove. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Value. |
|
Id
|
value.id | string |
Identifier of the license object. |
|
Sku id
|
value.skuId | string |
Microsoft sku identifier. |
|
Sku partnumber
|
value.skuPartNumber | string |
Microsoft Sku partnumber. |
|
servicePlans
|
value.servicePlans | array of object |
Service plans. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan identifier. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplan name. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Provisioning status. |
|
appliesTo
|
value.servicePlans.appliesTo | string |
Applies to. |
Create Azure AD group
Create azure AD group.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Description
|
description | string |
Description of the group. |
|
|
Display name
|
displayName | string |
Display name of the group. |
|
|
groupTypes
|
groupTypes | array of string |
Group types. |
|
|
Mail enabled
|
mailEnabled | boolean |
Indicates if the group is mail enabled. |
|
|
Mail nickname
|
mailNickname | string |
Mail nickname of the group. |
|
|
Security enabled
|
securityEnabled | boolean |
Indicates if the group is security enabled. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Identifier of the group. |
|
Deleted on
|
deletedDateTime | string |
Deleted on. |
|
Classification
|
classification | string |
Classification of the group. |
|
Created on
|
createdDateTime | string |
Created on. |
|
creationOptions
|
creationOptions | array of string |
Creation options. |
|
Description
|
description | string |
Description. |
|
Display name
|
displayName | string |
Display name. |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
Mail
|
string |
E-mail address of the group. |
|
|
Mail enabled
|
mailEnabled | boolean |
Indicates the group is mail enabled. |
|
Mail nickname
|
mailNickname | string |
Mail nickname of the group. |
|
On premise last sync
|
onPremisesLastSyncDateTime | string |
Indicates when the group was synced to on premise. |
|
On premise security identifier
|
onPremisesSecurityIdentifier | string |
On premise security identifier of the group. |
|
On premise sync enabled
|
onPremisesSyncEnabled | string |
Indicates if on premise sync is enabled. |
|
Preferred data location
|
preferredDataLocation | string |
Preferred data location of the group. |
|
proxyAddresses
|
proxyAddresses | array of string |
Proxy addresses. |
|
Renewed
|
renewedDateTime | string |
Renewed date time of the group. |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
Resource behavior options. |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
Resource provsioning options. |
|
Security enabled
|
securityEnabled | boolean |
Indicates if the group is security enabled. |
|
Visbility
|
visibility | string |
Visibility of the group. |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
On premise provisioning errors. |
Create user
The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Account enabled
|
accountEnabled | boolean |
Account enabled true or false. |
|
|
Display name
|
displayName | string |
Display name of the user. |
|
|
Mail nickname
|
mailNickname | string |
Mail nickname of the user. |
|
|
User principal name
|
userPrincipalName | string |
User principal name of the user. |
|
|
Force change password next signin
|
forceChangePasswordNextSignIn | boolean |
Force the user to change the password at next sign in. |
|
|
Password
|
password | string |
New password for the user. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData context. |
|
Id
|
id | string |
Cloud User Hub Identifier. |
|
businessPhones
|
businessPhones | array of string |
Business phones of the user. |
|
Display name
|
displayName | string |
Display name of the user. |
|
Given name
|
givenName | string |
Given name. |
|
Job title
|
jobTitle | string |
Job title of the user. |
|
Mail
|
string |
E-mail address of the user. |
|
|
Mobile phone
|
mobilePhone | string |
Mobile phonenumber of the user. |
|
Office location
|
officeLocation | string |
Office location of the user. |
|
Preferred language
|
preferredLanguage | string |
Preferred language as configured in Azure AD. |
|
Surname
|
surname | string |
Surname of the user. |
|
User Principal Name
|
userPrincipalName | string |
User principal name of the user. |
Delete Cloud User Hub user group
Delete a user group.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Cloud User Hub identifier for the user group.
|
userGroupId | True | string |
Cloud User Hub identifier for the user group. |
Delete user
Delete a user. When deleted, user resources are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
Microsoft object identifier of the user. |
Get a list of Cloud User Hub user group members
Get a list of user group members of a specific group.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Cloud User Hub identifier of the group.
|
userGroupId | True | string |
Cloud User Hub identifier of the group. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
@odata.count | integer |
OData count. |
|
value
|
value | array of object |
Value. |
|
Name
|
value.name | string |
Name. |
|
User principal name
|
value.upn | string |
User principal name of the group. |
|
Id
|
value.id | string |
Identifier of the group member object. |
|
Group id
|
value.groupId | string |
Cloud User Hub identifier of the group. |
|
Created on
|
value.createdOn | string |
Created on. |
|
Modified on
|
value.modifiedOn | string |
Modified on. |
Get Azure AD security groups
Get a list of Azure AD security groups of all organizations you are authorized to view.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Value. |
|
Created on
|
value.createdDateTime | string |
Created on. |
|
Displayname
|
value.displayName | string |
Display name. |
|
groupTypes
|
value.groupTypes | array of string |
Group types. |
|
Id
|
value.id | string |
Microsoft object identifier of the group. |
|
Security enabled
|
value.securityEnabled | boolean |
Indicates if the group is security enabled. |
|
Mail
|
value.mail | string |
E-mail address of the group. |
Get Cloud User Hub user groups
Get a list of groups of all organizations you are authorized to view.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter groups.
|
$filter | True | string |
Filter on groups in an organization. Use: organizationId in ('{organizationId}'). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
@odata.count | integer |
OData count. |
|
value
|
value | array of object |
Value. |
|
Organization Id
|
value.organizationId | string |
Cloud User Hub organization identifier. |
|
Name
|
value.name | string |
Name of the group. |
|
Description
|
value.description | string |
Description for the group. |
|
Id
|
value.id | string |
Identifier of the group. |
|
Created on
|
value.createdOn | string |
Created on. |
|
Modified on
|
value.modifiedOn | string |
Modified on. |
Get Command Block details
Get the details of a Command Block. Provider and action validation depend on the the specific Command Block.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Command Block Id
|
commandBlockId | True | string |
Format - uuid. Unique identifier of the Command Block. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
Version
|
version | integer |
Version. |
|
Category id
|
categoryId | string |
Category Id. |
|
Technical id
|
technicalIdentifier | string |
Technical Identifier. |
|
Required read action
|
requiredReadAction | string |
Required read action. |
|
Required write action
|
requiredWriteAction | string |
Required write action. |
|
Required provider
|
requiredProvider | string |
Required provider. |
|
Type
|
type | string |
Type. |
|
Id
|
category.id | string |
Id. |
|
Technical id
|
category.technicalIdentifier | string |
Technical Identifier. |
|
Id
|
parentCategory.id | string |
Id. |
|
Technical id
|
parentCategory.technicalIdentifier | string |
Technical Identifier. |
|
Id
|
menuCategory.id | string |
Id. |
|
Technical id
|
menuCategory.technicalIdentifier | string |
Technical Identifier. |
|
Multi selection
|
commandInput.multiSelection | string |
Multi selection. |
|
layoutGroups
|
commandInput.layoutGroups | array of object |
Layout groups. |
|
Technical id
|
commandInput.layoutGroups.technicalIdentifier | string |
Technical Identifier. |
|
layoutGroupFormats
|
commandInput.layoutGroups.layoutGroupFormats | array of object |
Layout group formats. |
|
type
|
commandInput.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
Property. |
|
properties
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
Properties. |
|
parameters
|
commandInput.parameters | array of object |
Parameters. |
|
Default value
|
commandInput.parameters.defaultValue | string |
Default value. |
|
Technical id
|
commandInput.parameters.technicalIdentifier | string |
Technical Identifier. |
|
Schema
|
commandInput.parameters.schema | string |
Schema. |
|
Sensitive
|
commandInput.parameters.sensitive | boolean |
Sensitive. |
|
Required
|
commandInput.parameters.required | boolean |
Required. |
|
Value
|
commandInput.parameters.value | string |
Value. |
|
Command Set
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
Command Set. |
|
Command Block
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
Command Block. |
|
linkedCommandBlocks
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Linked Command Blocks. |
|
technicalIdentifier
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Technical Identifier. |
|
version
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Version. |
|
layoutGroups
|
commandOutput.layoutGroups | array of object |
Layout groups. |
|
Technical id
|
commandOutput.layoutGroups.technicalIdentifier | string |
Technical Identifier. |
|
layoutGroupFormats
|
commandOutput.layoutGroups.layoutGroupFormats | array of object |
Layout group formats. |
|
type
|
commandOutput.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
Property. |
|
properties
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
Properties. |
|
parameters
|
commandOutput.parameters | array of object |
Parameters. |
|
Example
|
commandOutput.parameters.example | string |
Example. |
|
Technical id
|
commandOutput.parameters.technicalIdentifier | string |
Technical identifier. |
|
Schema
|
commandOutput.parameters.schema | string |
Schema. |
|
Sensitive
|
commandOutput.parameters.sensitive | boolean |
Sensitive. |
|
Required
|
commandOutput.parameters.required | boolean |
Required. |
|
Value
|
commandOutput.parameters.value | string |
Value. |
|
Command Set
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
Command Set. |
|
Command Block
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
Commmand Block. |
Get Command Block jobs for all authorized organizations
Get Command Block jobs for Command Blocks you're authorized to view.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
$top items
|
$top | string |
Return only the first $top items. |
|
|
$skip items
|
$skip | string |
The number of items to skip. |
|
|
Select filter
|
$select | string |
$select odata filter. |
|
|
Order by
|
$orderby | string |
Determines what values are used to order a collection of records. |
|
|
Filter
|
$filter | string |
A function that must evaluate to true for a record to be returned. |
|
|
Count
|
$count | string |
Determines if the count of items should be included in a collection. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData context. |
|
OData count
|
@odata.count | integer |
OData count. |
|
OData next link
|
@odata.nextLink | string |
OData next link |
|
value
|
value | array of object |
Value. |
|
Id
|
value.id | string |
Identifier. |
|
Command Block id
|
value.commandBlockId | string |
Command Block identifier. |
|
Command Set name
|
value.commandSetName | string |
Command Set name. |
|
Command Set id
|
value.commandSetId | string |
Command Set identifier |
|
Command Set Block id
|
value.commandSetBlockId | string |
Command Set Block identifier. |
|
User id
|
value.userId | string |
User identifier. |
|
User principal name
|
value.userUpn | string |
User principal name. |
|
Group id
|
value.groupId | string |
Group identifier. |
|
Group name
|
value.groupName | string |
Group name. |
|
Organization id
|
value.organizationId | string |
Organization identifier. |
|
Organization name
|
value.organizationName | string |
Organization name. |
|
Actor user upn
|
value.actorUserUpn | string |
Actor user principal name. |
|
Actor organization id
|
value.actorOrganizationId | string |
Actor organization identifier. |
|
Actor organization name
|
value.actorOrganizationName | string |
Actor organization name. |
|
Status
|
value.status | string |
Status. |
|
Executed on
|
value.executedOn | string |
Executed on. |
|
Command Block technical id
|
value.commandBlockTechnicalIdentifier | string |
Command Block technical identifier. |
|
Command Block version
|
value.commandBlockVersion | integer |
Command Block version. |
|
Planned execution
|
value.plannedExecution | string |
Planned execution. |
|
Schedule id
|
value.scheduleId | string |
Schedule identifier. |
|
Schedule name
|
value.scheduleName | string |
Schedule name. |
Get Command Block jobs of a specific organization
Get Command Block jobs for Command Blocks you're authorized to view.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Id.
|
organizationId | True | string |
Format - uuid. Unique identifier of the organization. |
|
$top items
|
$top | string |
Return only the first $top items. |
|
|
$skip items
|
$skip | string |
The number of items to skip. |
|
|
Select filter
|
$select | string |
$select odata filter. |
|
|
Order by
|
$orderby | string |
Determines what values are used to order a collection of records. |
|
|
Filter
|
$filter | string |
A function that must evaluate to true for a record to be returned. |
|
|
Count
|
$count | string |
Determines weather or not to include the count of items in a collection. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData context. |
|
OData count
|
@odata.count | integer |
OData count. |
|
OData nextlink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Value. |
|
Id
|
value.id | string |
Id. |
|
Command Block id
|
value.commandBlockId | string |
Command Block identifier. |
|
Command Set name
|
value.commandSetName | string |
Command set name. |
|
Command Set id
|
value.commandSetId | string |
Command Set identifier. |
|
Command Set Block id
|
value.commandSetBlockId | string |
Command Set Block identifier. |
|
User id
|
value.userId | string |
User identifier. |
|
User upn
|
value.userUpn | string |
User principal name. |
|
Group id
|
value.groupId | string |
Group identifier. |
|
Group name
|
value.groupName | string |
Group name. |
|
Organization id
|
value.organizationId | string |
Organization identifier. |
|
Organization name
|
value.organizationName | string |
Organization name. |
|
Actor user principal name
|
value.actorUserUpn | string |
Actor user principal name. |
|
Actor organization id
|
value.actorOrganizationId | string |
Actor organization identifier. |
|
Actor organization name
|
value.actorOrganizationName | string |
Actor organization name. |
|
Status
|
value.status | string |
Status. |
|
Executed on
|
value.executedOn | string |
Executed on. |
|
Command Block technical id
|
value.commandBlockTechnicalIdentifier | string |
Command Block technical identifier. |
|
Command Block version
|
value.commandBlockVersion | integer |
Command Block version. |
|
Planned execution
|
value.plannedExecution | string |
Planned execution. |
|
Schedule id
|
value.scheduleId | string |
Schedule identifier. |
|
Schedule name
|
value.scheduleName | string |
Schedule name. |
Get Command Categories
Get all available categories and subcategories.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
$top items
|
$top | string |
Return only the first $top items. |
|
|
$skip items
|
$skip | string |
The number of items to skip. |
|
|
Select filter
|
$select | string |
$select odata filter. |
|
|
Order by
|
$orderby | string |
Determines what values are used to order a collection of records. |
|
|
Filter
|
$filter | string |
A function that must evaluate to true for a record to be returned. |
|
|
Count
|
$count | string |
Determines weather or not to include the count of items in a collection. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData context. |
|
OData count
|
@odata.count | integer |
OData count. |
|
OData next link
|
@odata.nextLink | string |
OData next link. |
|
value
|
value | array of object |
Value. |
|
Id
|
value.id | string |
Id. |
|
Technical id
|
value.technicalIdentifier | string |
Technical Identifier. |
|
Parent category id
|
value.parentCategoryId | string |
Parent category identifier. |
Get details of a single user job
Get details of a single user job, provider and action validation depend on the the specific command block.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Id
|
organizationId | True | string |
Format - uuid. Unique identifier of the organization. |
|
Command Block Id
|
commandBlockId | True | string |
Format - uuid. Unique identifier of the command block. |
|
Job Id
|
jobId | True | string |
Format - uuid. Unique identifier of the job. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
Command Block id
|
commandBlockId | string |
Command Block identifier. |
|
Command Set name
|
commandSetName | string |
Command set name. |
|
Command Set id
|
commandSetId | string |
Command Set identifier. |
|
Command Set Block id
|
commandSetBlockId | string |
Command Set Block identifier. |
|
User id
|
userId | string |
User identifier. |
|
User upn
|
userUpn | string |
User principal name of the user. |
|
Group id
|
groupId | string |
Group identifier. |
|
Group name
|
groupName | string |
Group name. |
|
Organization id
|
organizationId | string |
Organization identifier. |
|
Organization name
|
organizationName | string |
Organization name. |
|
Actor upn
|
actorUserUpn | string |
Actor user principal name. |
|
Actor organization id
|
actorOrganizationId | string |
Actor organization identifier. |
|
Actor organization name
|
actorOrganizationName | string |
Actor organization name. |
|
Status
|
status | string |
Status. |
|
Executed on
|
executedOn | string |
Executed on. |
|
Command Block technical id
|
commandBlockTechnicalIdentifier | string |
Command Block technical identifier. |
|
Command Block version
|
commandBlockVersion | integer |
Command Block version. |
|
layoutGroups
|
output.body.layoutGroups | array of object |
Layout group formats. |
|
layoutGroupFormats
|
output.body.layoutGroups.layoutGroupFormats | array of object |
Layout group formats. |
|
type
|
output.body.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
output.body.layoutGroups.layoutGroupFormats.property | string |
Property. |
|
properties
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
Properties. |
|
parameters
|
output.body.parameters | array of object |
Parameters. |
|
Technical id
|
output.body.parameters.technicalIdentifier | string |
Technical Identifier. |
|
Value
|
output.body.parameters.value | string |
Value. |
|
Schema
|
output.body.parameters.schema | string |
Schema. |
|
Command Set
|
output.body.parameters.placeholderEnabled.commandSet | boolean |
Command Set. |
|
Command Block
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
Command Block. |
|
Error code
|
output.errorCode | string |
Error code. |
|
Success
|
output.isSuccess | boolean |
Successful. |
|
layoutGroups
|
input.layoutGroups | array of object |
Layout groups. |
|
layoutGroupFormats
|
input.layoutGroups.layoutGroupFormats | array of object |
Layout group formats. |
|
type
|
input.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
input.layoutGroups.layoutGroupFormats.property | string |
Property. |
|
properties
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
Properties. |
|
Multiple organizations
|
input.multiSelection.multipleOrganizations | boolean |
Multiple organizations. |
|
Multiple users
|
input.multiSelection.multipleUsers | boolean |
Multiple users. |
|
parameters
|
input.parameters | array of object |
Parameters. |
|
Technical id
|
input.parameters.technicalIdentifier | string |
Technical Identifier. |
|
Value
|
input.parameters.value | string |
Value. |
|
Default value
|
input.parameters.defaultValue | string |
Default value. |
|
Type
|
input.parameters.schema.type | string |
Type. |
|
Format
|
input.parameters.schema.format | string |
Format. |
|
Pattern
|
input.parameters.schema.pattern | string |
Pattern. |
|
Minimal length
|
input.parameters.schema.minLength | string |
Minimal length. |
|
Command Set
|
input.parameters.placeholderEnabled.commandSet | boolean |
Command Set. |
|
Command Block
|
input.parameters.placeholderEnabled.commandBlock | boolean |
Command Block. |
|
linkedCommandBlocks
|
input.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Linked Command Blocks. |
|
technicalIdentifier
|
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Technical Identifier. |
|
version
|
input.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Version. |
Get locales
Get locales.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData context. |
|
Count
|
@odata.count | integer |
OData count. |
|
OData nextLink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Value. |
|
Id
|
value.id | string |
Locale identifier. |
|
Locale code
|
value.localeCode | string |
ISO-639 Language Codes. |
|
Country code
|
value.countryCode | string |
ISO-3166 Country Codes. |
|
Country name
|
value.countryName | string |
Country name. |
Get organization subscribed SKUs
Get the list of commercial subscriptions that an organization has acquired.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Value. |
|
Capability status
|
value.capabilityStatus | string |
Capability status of the Microsoft sku. |
|
Consumed units
|
value.consumedUnits | integer |
Consumed units for this sku. |
|
Id
|
value.id | string |
Identifier of the subscribed sku object. |
|
Sku id
|
value.skuId | string |
Sku identifier of the Microsoft license. |
|
Sku partnumber
|
value.skuPartNumber | string |
Sku partnumber of the Microsoft license. |
|
Applies to
|
value.appliesTo | string |
Applies to user or organization. |
|
Enabled
|
value.prepaidUnits.enabled | integer |
Enabled subscribed skus. |
|
Suspended
|
value.prepaidUnits.suspended | integer |
Suspended subscribed skus. |
|
Warning
|
value.prepaidUnits.warning | integer |
Subscribed skus with warning. |
|
servicePlans
|
value.servicePlans | array of object |
Service plans. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan identifier. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplan name. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Provisioning status. |
|
appliesTo
|
value.servicePlans.appliesTo | string |
Applies to. |
Get organizations
Get all organizations you are authorized to view.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData count
|
@odata.count | integer |
OData count. |
|
value
|
value | array of object |
Value. |
|
Name
|
value.name | string |
Name of the Azure AD organization. |
|
Microsoft tenantId
|
value.microsoftTenantId | string |
Microsoft tenant identifier of the organization. |
|
Created on
|
value.createdOn | string |
Created on. |
|
Modified on
|
value.modifiedOn | string |
Modified on. |
|
Id
|
value.id | string |
Cloud User Hub identifier. |
Get statistics on the Command Block jobs for all authorized organizations
Get statistics on the Command Block jobs for Command Blocks you're authorized to view.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Category Id
|
categoryId | True | string |
Format - uuid. Unique identifier of the category. |
|
Select filter
|
$select | string |
$select odata filter. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData context. |
|
Type
|
type | string |
Type. |
|
Category
|
category | string |
Category. |
|
Period
|
period | string |
Period. |
|
Completed
|
completed | integer |
Completed. |
|
Queued
|
queued | integer |
Queued. |
|
Failed
|
failed | integer |
Failed. |
Get subscriptions
Retrieves all subscriptions for the customer of a partner by their active directory tenant identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub partner identifier.
|
partnerId | True | string |
Cloud User Hub partner identifier. |
|
Cloud User Hub customer identifier.
|
customerId | True | string |
Cloud User Hub customer identifier. |
|
Microsoft tenant Id of the customer.
|
tenantId | True | string |
Microsoft tenant identifier of the customer. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Total count
|
totalCount | integer |
Total count of the subscription object. |
|
items
|
items | array of object |
Items. |
|
Id
|
items.id | string |
Identifier of the subscription. |
|
Entitlement id
|
items.entitlementId | string |
Entitlement identifier of the subscription. |
|
Friendly name
|
items.friendlyName | string |
Friendly name of the subscription. |
|
Quantity
|
items.quantity | integer |
Quantity of the subscription. |
|
Unit type
|
items.unitType | string |
Unit type of the subscription. |
|
Created on
|
items.creationDate | string |
Created on date of the subscription. |
|
Effective start date
|
items.effectiveStartDate | string |
Effective start date of the subscription. |
|
Commitment end date
|
items.commitmentEndDate | string |
Commitment end date of the subscription. |
|
Status
|
items.status | string |
Status of the subscription. |
|
Auto renew
|
items.autoRenewEnabled | boolean |
Indicates if auto renew is enabled for the subscription. |
|
Billing type
|
items.billingType | string |
Billing type of the subscription. |
|
Contract type
|
items.contractType | string |
Contract type of the subscription. |
|
Uri
|
items.links.offer.uri | string |
Uri of the subscription. |
|
Method
|
items.links.offer.method | string |
Method of the subscription. |
|
headers
|
items.links.offer.headers | array of |
Headers. |
|
Uri
|
items.links.self.uri | string |
Uri of the subscription. |
|
Method
|
items.links.self.method | string |
Method of the subscription. |
|
headers
|
items.links.self.headers | array of |
Headers. |
|
Order id
|
items.orderId | string |
Order identifier of the subscription. |
|
Etag
|
items.attributes.etag | string |
Etag of the subscription. |
|
Object type
|
items.attributes.objectType | string |
Object type of the subscription. |
|
Object type
|
attributes.objectType | string |
Object type of the subscription. |
Get user details
Get a user by Microsoft object identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
Microsoft object identifier of the user. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Account enabled
|
accountEnabled | boolean |
Account enabled true or false. |
|
Employee id
|
employeeId | string |
Employee identifier of the user. |
|
Display name
|
displayName | string |
Display name of the user. |
|
Given name
|
givenName | string |
Given name of the user. |
|
Surname
|
surname | string |
Surname of the user. |
|
User principal name
|
userPrincipalName | string |
User principal name of the user. |
|
Job title
|
jobTitle | string |
Job title of the user. |
|
Department
|
department | string |
Department of the user. |
|
Company name
|
companyName | string |
Company name of the user. |
|
Usagelocation
|
usageLocation | string |
Usage location of the user. |
|
Street address
|
streetAddress | string |
Street address of the user. |
|
City
|
city | string |
City of the user. |
|
State
|
state | string |
State of the user. |
|
Postal code
|
postalCode | string |
Postal code of the user. |
|
Country
|
country | string |
Country of the user. |
Get user license details
Retrieve a list of license details objects for enterprise users.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
Microsoft object identifier of the user. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Value. |
|
Id
|
value.id | string |
Identifier of the user's license. |
|
Sku id
|
value.skuId | string |
Sku identifier of the Microsoft license. |
|
Sku partnumber
|
value.skuPartNumber | string |
Sku partnumber of the Microsoft license. |
|
servicePlans
|
value.servicePlans | array of object |
Service plans. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan identifier. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplan name. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Provisioning status. |
|
appliesTo
|
value.servicePlans.appliesTo | string |
Applies to. |
Get users
Retrieve a list of user objects.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter users.
|
$filter | True | string |
Filter on users in an organization. Use: organizationId in ('{organizationId}'). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData count
|
@odata.count | integer |
OData count. |
|
value
|
value | array of object |
Value. |
|
Organization id
|
value.organizationId | string |
Cloud User Hub organization identifier. |
|
Microsoft object identifier
|
value.microsoftObjectIdentifier | string |
Microsoft object identifier of the user. |
|
User principal name
|
value.upn | string |
User principal name of the user. |
|
First name
|
value.firstName | string |
First name of the user. |
|
Last name
|
value.lastName | string |
Last name of the user. |
|
Display name
|
value.displayName | string |
Display name of the user. |
|
Language
|
value.language | string |
Language of the user. |
|
Usage location
|
value.usageLocation | string |
Usage location of the user. |
|
Id
|
value.id | string |
Cloud User Hub identifier of the user. |
|
Created On
|
value.createdOn | string |
Created On. |
|
Modified on
|
value.modifiedOn | string |
Modified on. |
List Command Blocks
Retrieve a list of available Command Blocks.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
$top items
|
$top | string |
Return only the first $top items. |
|
|
$skip items
|
$skip | string |
The number of items to skip. |
|
|
Select filter
|
$select | string |
$select odata filter. |
|
|
Order by
|
$orderby | string |
Determines what values are used to order a collection of records. |
|
|
Filter
|
$filter | string |
A function that must evaluate to true for a record to be returned. |
|
|
Count
|
$count | string |
Determines not to include the count of items in a collection. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData context. |
|
OData count
|
@odata.count | integer |
OData count. |
|
OData next link
|
@odata.nextLink | string |
OData next link. |
|
value
|
value | array of object |
Value. |
|
Id
|
value.id | string |
Identifier. |
|
Technical id
|
value.technicalIdentifier | string |
Technical Identifier. |
|
Type
|
value.type | string |
Type. |
|
Version
|
value.version | integer |
Version. |
|
Category id
|
value.categoryId | string |
Category Identifier. |
|
Required read action
|
value.requiredReadAction | string |
Required read action. |
|
Required write action
|
value.requiredWriteAction | string |
Required write action. |
|
Required provider
|
value.requiredProvider | string |
Required provider. |
|
Menu category id
|
value.menuCategory.id | string |
Identifier of the menu category. |
|
Technical id
|
value.menuCategory.technicalIdentifier | string |
Technical Identifier. |
|
Parent category id
|
value.parentCategory.id | string |
Identifier of the parent category. |
|
Technical id
|
value.parentCategory.technicalIdentifier | string |
Technical Identifier. |
|
Id
|
value.category.id | string |
Id of the category. |
|
Technical identifier
|
value.category.technicalIdentifier | string |
Technical identifier. |
List organization domains
Retrieve a list of domain objects.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Value. |
|
Authentication type
|
value.authenticationType | string |
Authentication type of the domain. |
|
Availability status
|
value.availabilityStatus | string |
Availability status of the domain. |
|
Id
|
value.id | string |
Identifier of the domain. |
|
Admin managed
|
value.isAdminManaged | boolean |
Indicates if the domain is admin managed. |
|
Default
|
value.isDefault | boolean |
Indicates if this is the default domain. |
|
Initial
|
value.isInitial | boolean |
Indicates if this is the initial domain. |
|
Root
|
value.isRoot | boolean |
Indicates if this is the root domain. |
|
Verified
|
value.isVerified | boolean |
Indicates if the domain is verified. |
|
supportedServices
|
value.supportedServices | array of string |
Supported services. |
|
Password validity
|
value.passwordValidityPeriodInDays | integer |
Indicates the password validity in days. |
|
Password notification windows
|
value.passwordNotificationWindowInDays | integer |
Indicates the password notifcation window in days. |
|
State
|
value.state | string |
State of the domain. |
Remove a member from a user group
Remove a member to a user group.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Cloud User Hub user group id.
|
userGroupId | True | string |
Cloud User Hub user group identifier. |
|
Cloud User Hub user id.
|
userId | True | string |
Cloud User Hub user identifier. |
Remove member
Remove a member from a group via the members navigation property.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Microsoft object id of the group.
|
groupMicrosoftObjectId | True | string |
Microsoft object identifier of the group. |
|
Microsoft object id of the user.
|
userMicrosoftObjectId | True | string |
Microsoft object identifier of the user. |
Update subscription quantity
Update the quantity of a subscription.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub partner id.
|
partnerId | True | string |
Cloud User Hub partner identifier. |
|
Cloud User Hub customer id.
|
customerId | True | string |
Cloud User Hub customer identifier. |
|
Microsoft tenant id of the customer.
|
tenantId | True | string |
Microsoft tenant identifier of the customer. |
|
Subsription id.
|
subscriptionId | True | string |
Subscription identifier of the customer. |
|
Quantity
|
quantity | integer |
Quantity of the subscription. |
User change password
Update the password profile of a user to reset their password.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cloud User Hub organization id.
|
organizationId | True | string |
Cloud User Hub organization identifier. |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
Microsoft object identifier of the user. |
|
Force password change at signin
|
forceChangePasswordNextSignIn | boolean |
Force the user to change the password at next signin. |
|
|
Password
|
password | string |
New password to set. |