Hub d’utilisateurs cloud en mode N (préversion)
Cloud User Hub est un portail Microsoft CSP unifié qui vous permet d’automatiser les tâches courantes sur toutes les applications Microsoft 365 sans changer de console ou de clients.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Prise en charge du hub d’utilisateurs cloud |
| URL | https://documentation.clouduserhub.management/kb/en |
| Messagerie électronique | technicalsupport@n-able.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Hub d’utilisateurs cloud compatible B.V. |
| Site internet | https://www.n-able.com |
| Politique de confidentialité | https://www.n-able.com/legal/privacy |
| Catégories | Gestion de l’entreprise ;Opérations informatiques |
Cloud User Hub est un portail Microsoft CSP unifié qui vous permet d’automatiser les tâches courantes sur toutes les applications Microsoft 365 sans changer de console ou de clients.
Prerequisites
Vous devez procéder comme suit :
- Un abonnement Cloud User Hub
- Solutions configurées dans Cloud User Hub pour les opérations spécifiques que vous envisagez d’utiliser
- Rôles configurés dans Cloud User Hub pour les opérations spécifiques que vous envisagez d’utiliser.
Comment obtenir des informations d’identification
Vous pouvez vous connecter avec n’importe quel compte configuré pour accéder au hub d’utilisateurs cloud. Pour les scénarios d’automatisation, nous vous conseillons d’utiliser un compte de service dédié.
Bien démarrer avec votre connecteur
Commencez par obtenir des organisations pour récupérer une liste d’organisations que vous êtes autorisé à gérer (y compris votre propre). Les organisations sont retournées en fonction des étendues de rôle configurées dans Cloud User Hub. Utilisez les ID pour les appels consécutifs. Pour les opérations qui ont requis un ID de partenaire, utilisez l’ID de votre propre organisation. Pour certaines opérations, vous aurez besoin d’un ID de locataire au lieu de l’ID de hub d’utilisateur cloud interne ou des deux.
Problèmes connus et limitations
Certaines opérations nécessitent que l’organisation cible dispose d’une licence Microsoft 365 correspondante et/ou d’un abonnement Azure actif. Par exemple : configuration de l’accès conditionnel, nécessite une licence Microsoft Entra ID Premium.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un membre à un groupe |
Ajoutez un membre à un groupe Microsoft 365 ou à un groupe de sécurité via la propriété de navigation des membres. |
| Ajouter un membre à un groupe d’utilisateurs |
Ajoutez un membre à un groupe d’utilisateurs, le membre doit appartenir à la même organisation que le groupe. |
| Ajouter un travail de bloc de commandes pour un groupe |
Ajoutez un travail de bloc de commandes. Le fournisseur et la validation d’action sont basés sur le bloc de commande spécifique. |
| Ajouter un travail de bloc de commandes pour un utilisateur |
Ajoutez un travail de bloc de commandes. Le fournisseur et la validation d’action sont basés sur le bloc de commande spécifique. |
| Ajouter un travail de bloc de commandes pour une organisation |
Ajoutez un travail de bloc de commandes. Le fournisseur et la validation d’action sont basés sur le bloc de commande spécifique. |
| Attribuer une licence à un utilisateur |
Ajoutez ou supprimez des licences pour l’utilisateur. Vous pouvez également activer et désactiver des plans spécifiques associés à une licence. |
| Créer un groupe Azure AD |
Créez un groupe Azure AD. |
| Créer un utilisateur |
Le corps de la demande contient l’utilisateur à créer. Au minimum, vous devez spécifier les propriétés requises pour l’utilisateur. Vous pouvez éventuellement spécifier toutes les autres propriétés accessibles en écriture. |
| Listes de blocs de commandes |
Récupérez la liste des blocs de commandes disponibles. |
| Mettre à jour la quantité d’abonnement |
Mettez à jour la quantité d’un abonnement. |
| Mot de passe de modification de l’utilisateur |
Mettez à jour le profil de mot de passe d’un utilisateur pour réinitialiser son mot de passe. |
| Obtenir des abonnements |
Récupère tous les abonnements pour le client d’un partenaire par son identificateur de locataire Active Directory. |
| Obtenir des groupes de sécurité Azure AD |
Obtenez la liste des groupes de sécurité Azure AD de toutes les organisations que vous êtes autorisé à afficher. |
| Obtenir des groupes d’utilisateurs Cloud User Hub |
Obtenez la liste des groupes de toutes les organisations que vous êtes autorisé à afficher. |
| Obtenir des organisations |
Obtenez toutes les organisations que vous êtes autorisé à afficher. |
| Obtenir des références SKU abonnées à l’organisation |
Obtenez la liste des abonnements commerciaux acquis par une organisation. |
| Obtenir des statistiques sur les travaux de bloc de commandes pour toutes les organisations autorisées |
Obtenez des statistiques sur les travaux de bloc de commandes pour les blocs de commandes que vous êtes autorisé à afficher. |
| Obtenir des travaux de bloc de commandes d’une organisation spécifique |
Obtenez des travaux de bloc de commandes pour les blocs de commandes que vous êtes autorisé à afficher. |
| Obtenir des travaux de bloc de commandes pour toutes les organisations autorisées |
Obtenez des travaux de bloc de commandes pour les blocs de commandes que vous êtes autorisé à afficher. |
| Obtenir des utilisateurs |
Récupérer une liste d’objets utilisateur. |
| Obtenir la liste des membres du groupe d’utilisateurs Cloud User Hub |
Obtenir la liste des membres d’un groupe d’utilisateurs d’un groupe spécifique. |
| Obtenir les catégories de commandes |
Obtenez toutes les catégories et sous-catégories disponibles. |
| Obtenir les détails de la licence utilisateur |
Récupérez une liste d’objets de détails de licence pour les utilisateurs d’entreprise. |
| Obtenir les détails de l’utilisateur |
Obtenir un utilisateur par l’identificateur d’objet Microsoft. |
| Obtenir les détails du bloc de commandes |
Obtenez les détails d’un bloc de commandes. La validation du fournisseur et de l’action dépend du bloc de commande spécifique. |
| Obtenir les détails d’un travail d’utilisateur unique |
Obtenir les détails d’un travail, d’un fournisseur et d’une validation d’action d’un seul utilisateur dépend du bloc de commandes spécifique. |
| Obtenir les paramètres régionaux |
Obtenir les paramètres régionaux. |
| Répertorier les domaines d’organisation |
Récupérez une liste d’objets de domaine. |
| Supprimer le groupe d’utilisateurs Cloud User Hub |
Supprimez un groupe d’utilisateurs. |
| Supprimer l’utilisateur |
Supprimez un utilisateur. En cas de suppression, les ressources utilisateur sont déplacées vers un conteneur temporaire et peuvent être restaurées dans les 30 jours. Après ce délai, elles sont définitivement supprimés. |
| Supprimer un membre |
Supprimez un membre d’un groupe via la propriété de navigation des membres. |
| Supprimer un membre d’un groupe d’utilisateurs |
Supprimez un membre d’un groupe d’utilisateurs. |
Ajouter un membre à un groupe
Ajoutez un membre à un groupe Microsoft 365 ou à un groupe de sécurité via la propriété de navigation des membres.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID d’objet Microsoft du groupe.
|
microsoftObjectId | True | string |
Identificateur d’objet Microsoft du groupe. |
|
Membre
|
@odata.id | True | string |
URI de l’annuaire, de l’utilisateur, du groupe ou de l’objet contact organisationnel à ajouter. |
Ajouter un membre à un groupe d’utilisateurs
Ajoutez un membre à un groupe d’utilisateurs, le membre doit appartenir à la même organisation que le groupe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID de groupe d’utilisateurs cloud User Hub.
|
userGroupId | True | string |
Identificateur de groupe d’utilisateurs cloud User Hub. |
|
ID d’utilisateur du hub d’utilisateurs cloud.
|
userId | True | string |
Identificateur d’utilisateur cloud User Hub. |
Ajouter un travail de bloc de commandes pour un groupe
Ajoutez un travail de bloc de commandes. Le fournisseur et la validation d’action sont basés sur le bloc de commande spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation
|
organizationId | True | string |
Format - uuid. Identificateur unique de l’organisation. |
|
ID de bloc de commande
|
commandBlockId | True | string |
Format - uuid. Identificateur unique du bloc de commandes. |
|
ID de groupe cible
|
targetGroupId | True | string |
Format - uuid. Identificateur unique du groupe cible. |
|
ID technique
|
technicalIdentifier | string |
Identificateur technique. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
ID de planification
|
scheduleId | string |
Identificateur de planification. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Valeur
|
value | string |
Valeur. |
Ajouter un travail de bloc de commandes pour un utilisateur
Ajoutez un travail de bloc de commandes. Le fournisseur et la validation d’action sont basés sur le bloc de commande spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation
|
organizationId | True | string |
Format - uuid. Identificateur unique de l’organisation. |
|
ID de bloc de commande
|
commandBlockId | True | string |
Format - uuid. Identificateur unique du bloc de commandes. |
|
ID d’utilisateur cible
|
targetUserId | True | string |
Format - uuid. Identificateur unique de l’utilisateur cible. |
|
ID technique
|
technicalIdentifier | string |
Identificateur technique. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
ID de planification
|
scheduleId | string |
Identificateur de planification. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Valeur
|
value | string |
Valeur. |
Ajouter un travail de bloc de commandes pour une organisation
Ajoutez un travail de bloc de commandes. Le fournisseur et la validation d’action sont basés sur le bloc de commande spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation
|
organizationId | True | string |
Format - uuid. Identificateur unique de l’organisation. |
|
ID de bloc de commande
|
commandBlockId | True | string |
Format - uuid. Identificateur unique du bloc de commandes. |
|
ID de l’organisation cible
|
targetOrganizationId | True | string |
Format - uuid. Identificateur unique de l’organisation cible. |
|
ID technique
|
technicalIdentifier | string |
Identificateur technique |
|
|
Valeur
|
value | string |
Valeur. |
|
|
ID de planification
|
scheduleId | string |
Identificateur de planification. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Valeur
|
value | string |
Valeur. |
Attribuer une licence à un utilisateur
Ajoutez ou supprimez des licences pour l’utilisateur. Vous pouvez également activer et désactiver des plans spécifiques associés à une licence.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID d’objet Microsoft de l’utilisateur.
|
microsoftObjectId | True | string |
Identificateur d’objet Microsoft de l’utilisateur. |
|
disabledPlans
|
disabledPlans | array of |
Plans désactivés. |
|
|
ID de produit
|
skuId | string |
Identificateur de référence SKU de la licence Microsoft. |
|
|
Supprimer des licences
|
removeLicenses | array of |
Collection de GUID qui identifient les licences à supprimer. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valeur. |
|
Id
|
value.id | string |
Identificateur de l’objet de licence. |
|
ID de produit
|
value.skuId | string |
Identificateur de référence SKU Microsoft. |
|
Numéro de partie de référence SKU
|
value.skuPartNumber | string |
Numéro de partie de la référence SKU Microsoft. |
|
servicePlans
|
value.servicePlans | array of object |
Plans de service. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identificateur de plan de service. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nom du plan de service. |
|
provisionnementÉtat
|
value.servicePlans.provisioningStatus | string |
État d’approvisionnement. |
|
s’appliqueÀ
|
value.servicePlans.appliesTo | string |
S’applique à. |
Créer un groupe Azure AD
Créez un groupe Azure AD.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
Descriptif
|
description | string |
Description du groupe. |
|
|
Nom affiché
|
displayName | string |
Nom complet du groupe. |
|
|
groupTypes
|
groupTypes | array of string |
Types de groupes. |
|
|
Messagerie activée
|
mailEnabled | boolean |
Indique si le groupe est activé. |
|
|
Surnom du courrier
|
mailNickname | string |
Surnom de courrier du groupe. |
|
|
Sécurité activée
|
securityEnabled | boolean |
Indique si le groupe est activé pour la sécurité. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Identificateur du groupe. |
|
Supprimé sur
|
deletedDateTime | string |
Supprimé le. |
|
Classification
|
classification | string |
Classification du groupe. |
|
Créé le
|
createdDateTime | string |
Créé le. |
|
creationOptions
|
creationOptions | array of string |
Options de création. |
|
Descriptif
|
description | string |
Description. |
|
Nom affiché
|
displayName | string |
Nom complet. |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
Mail
|
string |
Adresse de messagerie du groupe. |
|
|
Messagerie activée
|
mailEnabled | boolean |
Indique que le groupe est activé. |
|
Surnom du courrier
|
mailNickname | string |
Surnom de courrier du groupe. |
|
Dernière synchronisation locale
|
onPremisesLastSyncDateTime | string |
Indique quand le groupe a été synchronisé sur site. |
|
Identificateur de sécurité local
|
onPremisesSecurityIdentifier | string |
Identificateur de sécurité local du groupe. |
|
Synchronisation locale activée
|
onPremisesSyncEnabled | string |
Indique si la synchronisation locale est activée. |
|
Emplacement de données préféré
|
preferredDataLocation | string |
Emplacement de données préféré du groupe. |
|
proxyAddresses
|
proxyAddresses | array of string |
Adresses proxy. |
|
Renouvelé
|
renewedDateTime | string |
Date renouvelée du groupe. |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
Options de comportement des ressources. |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
Options de provsioning des ressources. |
|
Sécurité activée
|
securityEnabled | boolean |
Indique si le groupe est activé pour la sécurité. |
|
Visabilité
|
visibility | string |
Visibilité du groupe. |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
Erreurs d’approvisionnement locales. |
Créer un utilisateur
Le corps de la demande contient l’utilisateur à créer. Au minimum, vous devez spécifier les propriétés requises pour l’utilisateur. Vous pouvez éventuellement spécifier toutes les autres propriétés accessibles en écriture.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
Compte activé
|
accountEnabled | boolean |
Compte activé true ou false. |
|
|
Nom affiché
|
displayName | string |
Nom affiché de l’utilisateur. |
|
|
Surnom du courrier
|
mailNickname | string |
Surnom du courrier de l’utilisateur. |
|
|
Nom d’utilisateur principal
|
userPrincipalName | string |
Nom d’utilisateur principal de l’utilisateur. |
|
|
Forcer la modification du mot de passe de connexion suivante
|
forceChangePasswordNextSignIn | boolean |
Forcez l’utilisateur à modifier le mot de passe lors de la prochaine connexion. |
|
|
Mot de passe
|
password | string |
Nouveau mot de passe pour l’utilisateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Contexte OData
|
@odata.context | string |
Contexte OData. |
|
Id
|
id | string |
Identificateur du hub d’utilisateurs cloud. |
|
businessPhones
|
businessPhones | array of string |
Téléphones professionnels de l’utilisateur. |
|
Nom affiché
|
displayName | string |
Nom affiché de l’utilisateur. |
|
Prénom
|
givenName | string |
Prénom. |
|
Fonction
|
jobTitle | string |
Titre du travail de l’utilisateur. |
|
Mail
|
string |
Adresse de messagerie de l’utilisateur. |
|
|
Téléphone portable
|
mobilePhone | string |
Numéro de téléphone mobile de l’utilisateur. |
|
Emplacement du bureau
|
officeLocation | string |
Emplacement Office de l’utilisateur. |
|
Langage préféré
|
preferredLanguage | string |
Langage préféré tel qu’il est configuré dans Azure AD. |
|
Surname
|
surname | string |
Nom de famille de l’utilisateur. |
|
Nom d’utilisateur principal
|
userPrincipalName | string |
Nom d’utilisateur principal de l’utilisateur. |
Listes de blocs de commandes
Récupérez la liste des blocs de commandes disponibles.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
éléments $top
|
$top | string |
Retourne uniquement les premiers éléments $top. |
|
|
éléments $skip
|
$skip | string |
Nonmbre d’éléments à ignorer. |
|
|
Sélectionner un filtre
|
$select | string |
$select filtre odata. |
|
|
Commande par
|
$orderby | string |
Détermine les valeurs utilisées pour classer une collection d’enregistrements. |
|
|
Filter
|
$filter | string |
Fonction qui doit évaluer la valeur true pour qu’un enregistrement soit retourné. |
|
|
Nombre
|
$count | string |
Détermine de ne pas inclure le nombre d’éléments dans une collection. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Contexte OData
|
@odata.context | string |
Contexte OData. |
|
Nombre OData
|
@odata.count | integer |
Nombre OData. |
|
Lien suivant OData
|
@odata.nextLink | string |
Lien suivant OData. |
|
value
|
value | array of object |
Valeur. |
|
Id
|
value.id | string |
Identificateur. |
|
ID technique
|
value.technicalIdentifier | string |
Identificateur technique. |
|
Type
|
value.type | string |
Type. |
|
Version
|
value.version | integer |
Version. |
|
ID de catégorie
|
value.categoryId | string |
Identificateur de catégorie. |
|
Action de lecture requise
|
value.requiredReadAction | string |
Action de lecture requise. |
|
Action d’écriture requise
|
value.requiredWriteAction | string |
Action d’écriture requise. |
|
Fournisseur requis
|
value.requiredProvider | string |
Fournisseur requis. |
|
ID de catégorie de menu
|
value.menuCategory.id | string |
Identificateur de la catégorie de menu. |
|
ID technique
|
value.menuCategory.technicalIdentifier | string |
Identificateur technique. |
|
ID de catégorie parent
|
value.parentCategory.id | string |
Identificateur de la catégorie parente. |
|
ID technique
|
value.parentCategory.technicalIdentifier | string |
Identificateur technique. |
|
Id
|
value.category.id | string |
ID de la catégorie. |
|
Identificateur technique
|
value.category.technicalIdentifier | string |
Identificateur technique. |
Mettre à jour la quantité d’abonnement
Mettez à jour la quantité d’un abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de partenaire Cloud User Hub.
|
partnerId | True | string |
Identificateur de partenaire Cloud User Hub. |
|
ID client du hub d’utilisateurs cloud.
|
customerId | True | string |
Identificateur du client Du hub d’utilisateurs cloud. |
|
ID de locataire Microsoft du client.
|
tenantId | True | string |
Identificateur de locataire Microsoft du client. |
|
ID de sous-iption.
|
subscriptionId | True | string |
Identificateur d’abonnement du client. |
|
Quantité
|
quantity | integer |
Quantité de l’abonnement. |
Mot de passe de modification de l’utilisateur
Mettez à jour le profil de mot de passe d’un utilisateur pour réinitialiser son mot de passe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID d’objet Microsoft de l’utilisateur.
|
microsoftObjectId | True | string |
Identificateur d’objet Microsoft de l’utilisateur. |
|
Forcer la modification du mot de passe lors de la connexion
|
forceChangePasswordNextSignIn | boolean |
Forcez l’utilisateur à modifier le mot de passe au prochain signe. |
|
|
Mot de passe
|
password | string |
Nouveau mot de passe à définir. |
Obtenir des abonnements
Récupère tous les abonnements pour le client d’un partenaire par son identificateur de locataire Active Directory.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur de partenaire Cloud User Hub.
|
partnerId | True | string |
Identificateur de partenaire Cloud User Hub. |
|
Identificateur du client Du hub d’utilisateurs cloud.
|
customerId | True | string |
Identificateur du client Du hub d’utilisateurs cloud. |
|
ID de locataire Microsoft du client.
|
tenantId | True | string |
Identificateur de locataire Microsoft du client. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre total
|
totalCount | integer |
Nombre total d’objets d’abonnement. |
|
items
|
items | array of object |
Articles. |
|
Id
|
items.id | string |
Identificateur de l’abonnement. |
|
ID de droit
|
items.entitlementId | string |
Identificateur de droit de l’abonnement. |
|
Nom convivial
|
items.friendlyName | string |
Nom convivial de l’abonnement. |
|
Quantité
|
items.quantity | integer |
Quantité de l’abonnement. |
|
Type d’unité
|
items.unitType | string |
Type d’unité de l’abonnement. |
|
Créé le
|
items.creationDate | string |
Créé à la date de l’abonnement. |
|
Date de début effective
|
items.effectiveStartDate | string |
Date de début effective de l’abonnement. |
|
Date de fin de l’engagement
|
items.commitmentEndDate | string |
Date de fin de l’engagement de l’abonnement. |
|
Statut
|
items.status | string |
Statut de l’abonnement. |
|
Renouvellement automatique
|
items.autoRenewEnabled | boolean |
Indique si le renouvellement automatique est activé pour l’abonnement. |
|
Type de facturation
|
items.billingType | string |
Type de facturation de l’abonnement. |
|
Type de contrat
|
items.contractType | string |
Type de contrat de l’abonnement. |
|
Uri
|
items.links.offer.uri | string |
Uri de l’abonnement. |
|
Méthode
|
items.links.offer.method | string |
Méthode de l’abonnement. |
|
headers
|
items.links.offer.headers | array of |
En-têtes. |
|
Uri
|
items.links.self.uri | string |
Uri de l’abonnement. |
|
Méthode
|
items.links.self.method | string |
Méthode de l’abonnement. |
|
headers
|
items.links.self.headers | array of |
En-têtes. |
|
ID de commande
|
items.orderId | string |
Identificateur de commande de l’abonnement. |
|
Etag
|
items.attributes.etag | string |
Etag de l’abonnement. |
|
Type d’objet
|
items.attributes.objectType | string |
Type d’objet de l’abonnement. |
|
Type d’objet
|
attributes.objectType | string |
Type d’objet de l’abonnement. |
Obtenir des groupes de sécurité Azure AD
Obtenez la liste des groupes de sécurité Azure AD de toutes les organisations que vous êtes autorisé à afficher.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valeur. |
|
Créé le
|
value.createdDateTime | string |
Créé le. |
|
Displayname
|
value.displayName | string |
Nom complet. |
|
groupTypes
|
value.groupTypes | array of string |
Types de groupes. |
|
Id
|
value.id | string |
Identificateur d’objet Microsoft du groupe. |
|
Sécurité activée
|
value.securityEnabled | boolean |
Indique si le groupe est activé pour la sécurité. |
|
Mail
|
value.mail | string |
Adresse de messagerie du groupe. |
Obtenir des groupes d’utilisateurs Cloud User Hub
Obtenez la liste des groupes de toutes les organisations que vous êtes autorisé à afficher.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Groupes de filtres.
|
$filter | True | string |
Filtrez sur les groupes d’une organisation. Utiliser : organizationId in ('{organizationId}'). |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
@odata.count | integer |
Nombre OData. |
|
value
|
value | array of object |
Valeur. |
|
ID d’organisation
|
value.organizationId | string |
Identificateur de l’organisation Cloud User Hub. |
|
Nom
|
value.name | string |
Nom du groupe. |
|
Descriptif
|
value.description | string |
Description du groupe. |
|
Id
|
value.id | string |
Identificateur du groupe. |
|
Créé le
|
value.createdOn | string |
Créé le. |
|
Date de modification
|
value.modifiedOn | string |
Modifié le. |
Obtenir des organisations
Obtenez toutes les organisations que vous êtes autorisé à afficher.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre OData
|
@odata.count | integer |
Nombre OData. |
|
value
|
value | array of object |
Valeur. |
|
Nom
|
value.name | string |
Nom de l’organisation Azure AD. |
|
TenantId Microsoft
|
value.microsoftTenantId | string |
Identificateur de locataire Microsoft de l’organisation. |
|
Créé le
|
value.createdOn | string |
Créé le. |
|
Date de modification
|
value.modifiedOn | string |
Modifié le. |
|
Id
|
value.id | string |
Identificateur du hub d’utilisateurs cloud. |
Obtenir des références SKU abonnées à l’organisation
Obtenez la liste des abonnements commerciaux acquis par une organisation.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valeur. |
|
État de la fonctionnalité
|
value.capabilityStatus | string |
État de la fonctionnalité de la référence SKU Microsoft. |
|
Unités consommées
|
value.consumedUnits | integer |
Unités consommées pour cette référence SKU. |
|
Id
|
value.id | string |
Identificateur de l’objet sku abonné. |
|
ID de produit
|
value.skuId | string |
Identificateur de référence SKU de la licence Microsoft. |
|
Numéro de partie de référence SKU
|
value.skuPartNumber | string |
Numéro de référence SKU de la licence Microsoft. |
|
S’applique à
|
value.appliesTo | string |
S’applique à l’utilisateur ou à l’organisation. |
|
Enabled
|
value.prepaidUnits.enabled | integer |
Références SKU abonnées activées. |
|
Interrompu
|
value.prepaidUnits.suspended | integer |
Références sku abonnées suspendues. |
|
Avertissement
|
value.prepaidUnits.warning | integer |
Références SKU abonnées avec avertissement. |
|
servicePlans
|
value.servicePlans | array of object |
Plans de service. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identificateur de plan de service. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nom du plan de service. |
|
provisionnementÉtat
|
value.servicePlans.provisioningStatus | string |
État d’approvisionnement. |
|
s’appliqueÀ
|
value.servicePlans.appliesTo | string |
S’applique à. |
Obtenir des statistiques sur les travaux de bloc de commandes pour toutes les organisations autorisées
Obtenez des statistiques sur les travaux de bloc de commandes pour les blocs de commandes que vous êtes autorisé à afficher.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de catégorie
|
categoryId | True | string |
Format - uuid. Identificateur unique de la catégorie. |
|
Sélectionner un filtre
|
$select | string |
$select filtre odata. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Contexte OData
|
@odata.context | string |
Contexte OData. |
|
Type
|
type | string |
Type. |
|
Catégorie
|
category | string |
Catégorie. |
|
Période
|
period | string |
Période. |
|
Terminé
|
completed | integer |
Terminé. |
|
Mis(e) en file d’attente
|
queued | integer |
Queue. |
|
Échec
|
failed | integer |
Raté. |
Obtenir des travaux de bloc de commandes d’une organisation spécifique
Obtenez des travaux de bloc de commandes pour les blocs de commandes que vous êtes autorisé à afficher.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’organisation.
|
organizationId | True | string |
Format - uuid. Identificateur unique de l’organisation. |
|
éléments $top
|
$top | string |
Retourne uniquement les premiers éléments $top. |
|
|
éléments $skip
|
$skip | string |
Nonmbre d’éléments à ignorer. |
|
|
Sélectionner un filtre
|
$select | string |
$select filtre odata. |
|
|
Commande par
|
$orderby | string |
Détermine les valeurs utilisées pour classer une collection d’enregistrements. |
|
|
Filter
|
$filter | string |
Fonction qui doit évaluer la valeur true pour qu’un enregistrement soit retourné. |
|
|
Nombre
|
$count | string |
Détermine la météo ou ne pas inclure le nombre d’éléments dans une collection. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Contexte OData
|
@odata.context | string |
Contexte OData. |
|
Nombre OData
|
@odata.count | integer |
Nombre OData. |
|
OData nextlink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Valeur. |
|
Id
|
value.id | string |
Id. |
|
ID de bloc de commande
|
value.commandBlockId | string |
Identificateur de bloc de commande. |
|
Nom du jeu de commandes
|
value.commandSetName | string |
Nom du jeu de commandes. |
|
ID du jeu de commandes
|
value.commandSetId | string |
Identificateur du jeu de commandes. |
|
ID de bloc de jeu de commandes
|
value.commandSetBlockId | string |
Identificateur de bloc de jeu de commandes. |
|
Identifiant utilisateur
|
value.userId | string |
Identificateur d’utilisateur. |
|
Upn de l’utilisateur
|
value.userUpn | string |
Nom d’utilisateur principal. |
|
ID de groupe
|
value.groupId | string |
Identificateur de groupe. |
|
Nom du groupe
|
value.groupName | string |
Nom du groupe. |
|
ID de l’organisation
|
value.organizationId | string |
Identificateur de l’organisation. |
|
Nom de l’organisation
|
value.organizationName | string |
Nom de l’organisation. |
|
Nom d’utilisateur principal de l’acteur
|
value.actorUserUpn | string |
Nom d’utilisateur de l’acteur principal. |
|
ID de l’organisation d’acteur
|
value.actorOrganizationId | string |
Identificateur de l’organisation d’acteur. |
|
Nom de l’organisation d’acteur
|
value.actorOrganizationName | string |
Nom de l’organisation d’acteur. |
|
Statut
|
value.status | string |
État. |
|
Exécuté sur
|
value.executedOn | string |
Exécuté. |
|
ID technique du bloc de commandes
|
value.commandBlockTechnicalIdentifier | string |
Identificateur technique du bloc de commandes. |
|
Version du bloc de commandes
|
value.commandBlockVersion | integer |
Version du bloc de commandes. |
|
Exécution planifiée
|
value.plannedExecution | string |
Exécution planifiée. |
|
ID de planification
|
value.scheduleId | string |
Identificateur de planification. |
|
Nom de la planification
|
value.scheduleName | string |
Nom de l’horaire. |
Obtenir des travaux de bloc de commandes pour toutes les organisations autorisées
Obtenez des travaux de bloc de commandes pour les blocs de commandes que vous êtes autorisé à afficher.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
éléments $top
|
$top | string |
Retourne uniquement les premiers éléments $top. |
|
|
éléments $skip
|
$skip | string |
Nonmbre d’éléments à ignorer. |
|
|
Sélectionner un filtre
|
$select | string |
$select filtre odata. |
|
|
Commande par
|
$orderby | string |
Détermine les valeurs utilisées pour classer une collection d’enregistrements. |
|
|
Filter
|
$filter | string |
Fonction qui doit évaluer la valeur true pour qu’un enregistrement soit retourné. |
|
|
Nombre
|
$count | string |
Détermine si le nombre d’éléments doit être inclus dans une collection. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Contexte OData
|
@odata.context | string |
Contexte OData. |
|
Nombre OData
|
@odata.count | integer |
Nombre OData. |
|
Lien suivant OData
|
@odata.nextLink | string |
Lien suivant OData |
|
value
|
value | array of object |
Valeur. |
|
Id
|
value.id | string |
Identificateur. |
|
ID de bloc de commande
|
value.commandBlockId | string |
Identificateur de bloc de commande. |
|
Nom du jeu de commandes
|
value.commandSetName | string |
Nom du jeu de commandes. |
|
ID du jeu de commandes
|
value.commandSetId | string |
Identificateur du jeu de commandes |
|
ID de bloc de jeu de commandes
|
value.commandSetBlockId | string |
Identificateur de bloc de jeu de commandes. |
|
Identifiant utilisateur
|
value.userId | string |
Identificateur d’utilisateur. |
|
Nom d’utilisateur principal
|
value.userUpn | string |
Nom d’utilisateur principal. |
|
ID de groupe
|
value.groupId | string |
Identificateur de groupe. |
|
Nom du groupe
|
value.groupName | string |
Nom du groupe. |
|
ID de l’organisation
|
value.organizationId | string |
Identificateur de l’organisation. |
|
Nom de l’organisation
|
value.organizationName | string |
Nom de l’organisation. |
|
Utilisateur d’acteur upn
|
value.actorUserUpn | string |
Nom d’utilisateur de l’acteur principal. |
|
ID de l’organisation d’acteur
|
value.actorOrganizationId | string |
Identificateur de l’organisation d’acteur. |
|
Nom de l’organisation d’acteur
|
value.actorOrganizationName | string |
Nom de l’organisation d’acteur. |
|
Statut
|
value.status | string |
État. |
|
Exécuté sur
|
value.executedOn | string |
Exécuté. |
|
ID technique du bloc de commandes
|
value.commandBlockTechnicalIdentifier | string |
Identificateur technique du bloc de commandes. |
|
Version du bloc de commandes
|
value.commandBlockVersion | integer |
Version du bloc de commandes. |
|
Exécution planifiée
|
value.plannedExecution | string |
Exécution planifiée. |
|
ID de planification
|
value.scheduleId | string |
Identificateur de planification. |
|
Nom de la planification
|
value.scheduleName | string |
Nom de l’horaire. |
Obtenir des utilisateurs
Récupérer une liste d’objets utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Filtrez les utilisateurs.
|
$filter | True | string |
Filtrez sur les utilisateurs d’une organisation. Utiliser : organizationId in ('{organizationId}'). |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre OData
|
@odata.count | integer |
Nombre OData. |
|
value
|
value | array of object |
Valeur. |
|
ID de l’organisation
|
value.organizationId | string |
Identificateur de l’organisation Cloud User Hub. |
|
Identificateur d’objet Microsoft
|
value.microsoftObjectIdentifier | string |
Identificateur d’objet Microsoft de l’utilisateur. |
|
Nom d’utilisateur principal
|
value.upn | string |
Nom d’utilisateur principal de l’utilisateur. |
|
Prénom
|
value.firstName | string |
Prénom de l’utilisateur. |
|
Nom
|
value.lastName | string |
Nom de l’utilisateur. |
|
Nom affiché
|
value.displayName | string |
Nom affiché de l’utilisateur. |
|
Language
|
value.language | string |
Langue de l’utilisateur. |
|
Emplacement d’utilisation
|
value.usageLocation | string |
Emplacement d’utilisation de l’utilisateur. |
|
Id
|
value.id | string |
Identificateur du hub d’utilisateurs cloud de l’utilisateur. |
|
Création le
|
value.createdOn | string |
Créé sur. |
|
Date de modification
|
value.modifiedOn | string |
Modifié le. |
Obtenir la liste des membres du groupe d’utilisateurs Cloud User Hub
Obtenir la liste des membres d’un groupe d’utilisateurs d’un groupe spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
Identificateur du hub d’utilisateurs cloud du groupe.
|
userGroupId | True | string |
Identificateur du hub d’utilisateurs cloud du groupe. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
@odata.count | integer |
Nombre OData. |
|
value
|
value | array of object |
Valeur. |
|
Nom
|
value.name | string |
Nom. |
|
Nom d’utilisateur principal
|
value.upn | string |
Nom d’utilisateur principal du groupe. |
|
Id
|
value.id | string |
Identificateur de l’objet membre du groupe. |
|
ID de groupe
|
value.groupId | string |
Identificateur du hub d’utilisateurs cloud du groupe. |
|
Créé le
|
value.createdOn | string |
Créé le. |
|
Date de modification
|
value.modifiedOn | string |
Modifié le. |
Obtenir les catégories de commandes
Obtenez toutes les catégories et sous-catégories disponibles.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
éléments $top
|
$top | string |
Retourne uniquement les premiers éléments $top. |
|
|
éléments $skip
|
$skip | string |
Nonmbre d’éléments à ignorer. |
|
|
Sélectionner un filtre
|
$select | string |
$select filtre odata. |
|
|
Commande par
|
$orderby | string |
Détermine les valeurs utilisées pour classer une collection d’enregistrements. |
|
|
Filter
|
$filter | string |
Fonction qui doit évaluer la valeur true pour qu’un enregistrement soit retourné. |
|
|
Nombre
|
$count | string |
Détermine la météo ou ne pas inclure le nombre d’éléments dans une collection. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Contexte OData
|
@odata.context | string |
Contexte OData. |
|
Nombre OData
|
@odata.count | integer |
Nombre OData. |
|
Lien suivant OData
|
@odata.nextLink | string |
Lien suivant OData. |
|
value
|
value | array of object |
Valeur. |
|
Id
|
value.id | string |
Id. |
|
ID technique
|
value.technicalIdentifier | string |
Identificateur technique. |
|
ID de catégorie parent
|
value.parentCategoryId | string |
Identificateur de catégorie parent. |
Obtenir les détails de la licence utilisateur
Récupérez une liste d’objets de détails de licence pour les utilisateurs d’entreprise.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID d’objet Microsoft de l’utilisateur.
|
microsoftObjectId | True | string |
Identificateur d’objet Microsoft de l’utilisateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valeur. |
|
Id
|
value.id | string |
Identificateur de la licence de l’utilisateur. |
|
ID de produit
|
value.skuId | string |
Identificateur de référence SKU de la licence Microsoft. |
|
Numéro de partie de référence SKU
|
value.skuPartNumber | string |
Numéro de référence SKU de la licence Microsoft. |
|
servicePlans
|
value.servicePlans | array of object |
Plans de service. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identificateur de plan de service. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nom du plan de service. |
|
provisionnementÉtat
|
value.servicePlans.provisioningStatus | string |
État d’approvisionnement. |
|
s’appliqueÀ
|
value.servicePlans.appliesTo | string |
S’applique à. |
Obtenir les détails de l’utilisateur
Obtenir un utilisateur par l’identificateur d’objet Microsoft.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID d’objet Microsoft de l’utilisateur.
|
microsoftObjectId | True | string |
Identificateur d’objet Microsoft de l’utilisateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Compte activé
|
accountEnabled | boolean |
Compte activé true ou false. |
|
ID de l’employé
|
employeeId | string |
Identificateur d’employé de l’utilisateur. |
|
Nom affiché
|
displayName | string |
Nom affiché de l’utilisateur. |
|
Prénom
|
givenName | string |
Nom donné de l’utilisateur. |
|
Surname
|
surname | string |
Nom de famille de l’utilisateur. |
|
Nom d’utilisateur principal
|
userPrincipalName | string |
Nom d’utilisateur principal de l’utilisateur. |
|
Fonction
|
jobTitle | string |
Titre du travail de l’utilisateur. |
|
Département
|
department | string |
Service de l’utilisateur. |
|
Nom de la société
|
companyName | string |
Nom de l’entreprise de l’utilisateur. |
|
Utilisationlocation
|
usageLocation | string |
Emplacement d’utilisation de l’utilisateur. |
|
Adresse postale
|
streetAddress | string |
Adresse postale de l’utilisateur. |
|
Ville
|
city | string |
Ville de l’utilisateur. |
|
État
|
state | string |
État de l’utilisateur. |
|
Code postal
|
postalCode | string |
Code postal de l’utilisateur. |
|
Pays
|
country | string |
Pays de l’utilisateur. |
Obtenir les détails du bloc de commandes
Obtenez les détails d’un bloc de commandes. La validation du fournisseur et de l’action dépend du bloc de commande spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de bloc de commande
|
commandBlockId | True | string |
Format - uuid. Identificateur unique du bloc de commandes. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
Version
|
version | integer |
Version. |
|
ID de catégorie
|
categoryId | string |
ID de catégorie. |
|
ID technique
|
technicalIdentifier | string |
Identificateur technique. |
|
Action de lecture requise
|
requiredReadAction | string |
Action de lecture requise. |
|
Action d’écriture requise
|
requiredWriteAction | string |
Action d’écriture requise. |
|
Fournisseur requis
|
requiredProvider | string |
Fournisseur requis. |
|
Type
|
type | string |
Type. |
|
Id
|
category.id | string |
Id. |
|
ID technique
|
category.technicalIdentifier | string |
Identificateur technique. |
|
Id
|
parentCategory.id | string |
Id. |
|
ID technique
|
parentCategory.technicalIdentifier | string |
Identificateur technique. |
|
Id
|
menuCategory.id | string |
Id. |
|
ID technique
|
menuCategory.technicalIdentifier | string |
Identificateur technique. |
|
Sélection multiple
|
commandInput.multiSelection | string |
Sélection multiple. |
|
layoutGroups
|
commandInput.layoutGroups | array of object |
Groupes de disposition. |
|
ID technique
|
commandInput.layoutGroups.technicalIdentifier | string |
Identificateur technique. |
|
layoutGroupFormats
|
commandInput.layoutGroups.layoutGroupFormats | array of object |
Formats de groupe de disposition. |
|
type
|
commandInput.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
Propriété. |
|
Propriétés
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
Propriétés. |
|
parameters
|
commandInput.parameters | array of object |
Paramètres. |
|
Valeur par défaut
|
commandInput.parameters.defaultValue | string |
Valeur par défaut. |
|
ID technique
|
commandInput.parameters.technicalIdentifier | string |
Identificateur technique. |
|
Schema
|
commandInput.parameters.schema | string |
Schéma : |
|
Sensible
|
commandInput.parameters.sensitive | boolean |
Sensible. |
|
Obligatoire
|
commandInput.parameters.required | boolean |
Obligatoire. |
|
Valeur
|
commandInput.parameters.value | string |
Valeur. |
|
Jeu de commandes
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
Jeu de commandes. |
|
Bloc de commandes
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
Bloc de commandes. |
|
linkedCommandBlocks
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Blocs de commandes liés. |
|
technicalIdentifier
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Identificateur technique. |
|
version
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Version. |
|
layoutGroups
|
commandOutput.layoutGroups | array of object |
Groupes de disposition. |
|
ID technique
|
commandOutput.layoutGroups.technicalIdentifier | string |
Identificateur technique. |
|
layoutGroupFormats
|
commandOutput.layoutGroups.layoutGroupFormats | array of object |
Formats de groupe de disposition. |
|
type
|
commandOutput.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
Propriété. |
|
Propriétés
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
Propriétés. |
|
parameters
|
commandOutput.parameters | array of object |
Paramètres. |
|
Example
|
commandOutput.parameters.example | string |
Exemple. |
|
ID technique
|
commandOutput.parameters.technicalIdentifier | string |
Identificateur technique. |
|
Schema
|
commandOutput.parameters.schema | string |
Schéma : |
|
Sensible
|
commandOutput.parameters.sensitive | boolean |
Sensible. |
|
Obligatoire
|
commandOutput.parameters.required | boolean |
Obligatoire. |
|
Valeur
|
commandOutput.parameters.value | string |
Valeur. |
|
Jeu de commandes
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
Jeu de commandes. |
|
Bloc de commandes
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
Commmand Block. |
Obtenir les détails d’un travail d’utilisateur unique
Obtenir les détails d’un travail, d’un fournisseur et d’une validation d’action d’un seul utilisateur dépend du bloc de commandes spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation
|
organizationId | True | string |
Format - uuid. Identificateur unique de l’organisation. |
|
ID de bloc de commande
|
commandBlockId | True | string |
Format - uuid. Identificateur unique du bloc de commandes. |
|
ID du travail
|
jobId | True | string |
Format - uuid. Identificateur unique du travail. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
ID de bloc de commande
|
commandBlockId | string |
Identificateur de bloc de commande. |
|
Nom du jeu de commandes
|
commandSetName | string |
Nom du jeu de commandes. |
|
ID du jeu de commandes
|
commandSetId | string |
Identificateur du jeu de commandes. |
|
ID de bloc de jeu de commandes
|
commandSetBlockId | string |
Identificateur de bloc de jeu de commandes. |
|
Identifiant utilisateur
|
userId | string |
Identificateur d’utilisateur. |
|
Upn de l’utilisateur
|
userUpn | string |
Nom d’utilisateur principal de l’utilisateur. |
|
ID de groupe
|
groupId | string |
Identificateur de groupe. |
|
Nom du groupe
|
groupName | string |
Nom du groupe. |
|
ID de l’organisation
|
organizationId | string |
Identificateur de l’organisation. |
|
Nom de l’organisation
|
organizationName | string |
Nom de l’organisation. |
|
Upn d’acteur
|
actorUserUpn | string |
Nom d’utilisateur de l’acteur principal. |
|
ID de l’organisation d’acteur
|
actorOrganizationId | string |
Identificateur de l’organisation d’acteur. |
|
Nom de l’organisation d’acteur
|
actorOrganizationName | string |
Nom de l’organisation d’acteur. |
|
Statut
|
status | string |
État. |
|
Exécuté sur
|
executedOn | string |
Exécuté. |
|
ID technique du bloc de commandes
|
commandBlockTechnicalIdentifier | string |
Identificateur technique du bloc de commandes. |
|
Version du bloc de commandes
|
commandBlockVersion | integer |
Version du bloc de commandes. |
|
layoutGroups
|
output.body.layoutGroups | array of object |
Formats de groupe de disposition. |
|
layoutGroupFormats
|
output.body.layoutGroups.layoutGroupFormats | array of object |
Formats de groupe de disposition. |
|
type
|
output.body.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
output.body.layoutGroups.layoutGroupFormats.property | string |
Propriété. |
|
Propriétés
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
Propriétés. |
|
parameters
|
output.body.parameters | array of object |
Paramètres. |
|
ID technique
|
output.body.parameters.technicalIdentifier | string |
Identificateur technique. |
|
Valeur
|
output.body.parameters.value | string |
Valeur. |
|
Schema
|
output.body.parameters.schema | string |
Schéma : |
|
Jeu de commandes
|
output.body.parameters.placeholderEnabled.commandSet | boolean |
Jeu de commandes. |
|
Bloc de commandes
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
Bloc de commandes. |
|
Code d’erreur
|
output.errorCode | string |
Code d’erreur. |
|
Success
|
output.isSuccess | boolean |
Réussi. |
|
layoutGroups
|
input.layoutGroups | array of object |
Groupes de disposition. |
|
layoutGroupFormats
|
input.layoutGroups.layoutGroupFormats | array of object |
Formats de groupe de disposition. |
|
type
|
input.layoutGroups.layoutGroupFormats.type | string |
Type. |
|
property
|
input.layoutGroups.layoutGroupFormats.property | string |
Propriété. |
|
Propriétés
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
Propriétés. |
|
Plusieurs organisations
|
input.multiSelection.multipleOrganizations | boolean |
Plusieurs organisations. |
|
Plusieurs utilisateurs
|
input.multiSelection.multipleUsers | boolean |
Plusieurs utilisateurs. |
|
parameters
|
input.parameters | array of object |
Paramètres. |
|
ID technique
|
input.parameters.technicalIdentifier | string |
Identificateur technique. |
|
Valeur
|
input.parameters.value | string |
Valeur. |
|
Valeur par défaut
|
input.parameters.defaultValue | string |
Valeur par défaut. |
|
Type
|
input.parameters.schema.type | string |
Type. |
|
Format
|
input.parameters.schema.format | string |
Format. |
|
Motif
|
input.parameters.schema.pattern | string |
Modèle. |
|
Longueur minimale
|
input.parameters.schema.minLength | string |
Longueur minimale. |
|
Jeu de commandes
|
input.parameters.placeholderEnabled.commandSet | boolean |
Jeu de commandes. |
|
Bloc de commandes
|
input.parameters.placeholderEnabled.commandBlock | boolean |
Bloc de commandes. |
|
linkedCommandBlocks
|
input.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Blocs de commandes liés. |
|
technicalIdentifier
|
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Identificateur technique. |
|
version
|
input.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Version. |
Obtenir les paramètres régionaux
Obtenir les paramètres régionaux.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Contexte OData
|
@odata.context | string |
Contexte OData. |
|
Nombre
|
@odata.count | integer |
Nombre OData. |
|
OData nextLink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Valeur. |
|
Id
|
value.id | string |
Identificateur de paramètres régionaux. |
|
Code de paramètres régionaux
|
value.localeCode | string |
Codes de langue ISO-639. |
|
Code du pays
|
value.countryCode | string |
Codes pays ISO-3166. |
|
Nom du pays
|
value.countryName | string |
Nom du pays. |
Répertorier les domaines d’organisation
Récupérez une liste d’objets de domaine.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valeur. |
|
Type d’authentification
|
value.authenticationType | string |
Type d’authentification du domaine. |
|
État de disponibilité
|
value.availabilityStatus | string |
État de disponibilité du domaine. |
|
Id
|
value.id | string |
Identificateur du domaine. |
|
Géré par l’administrateur
|
value.isAdminManaged | boolean |
Indique si le domaine est géré par l’administrateur. |
|
Par défaut
|
value.isDefault | boolean |
Indique s’il s’agit du domaine par défaut. |
|
Initial
|
value.isInitial | boolean |
Indique s’il s’agit du domaine initial. |
|
Racine
|
value.isRoot | boolean |
Indique s’il s’agit du domaine racine. |
|
Vérifié
|
value.isVerified | boolean |
Indique si le domaine est vérifié. |
|
supportedServices
|
value.supportedServices | array of string |
Services pris en charge. |
|
Validité du mot de passe
|
value.passwordValidityPeriodInDays | integer |
Indique la validité du mot de passe en jours. |
|
Fenêtres de notification de mot de passe
|
value.passwordNotificationWindowInDays | integer |
Indique la fenêtre de notifcation de mot de passe en jours. |
|
État
|
value.state | string |
État du domaine. |
Supprimer le groupe d’utilisateurs Cloud User Hub
Supprimez un groupe d’utilisateurs.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
Identificateur du hub d’utilisateurs cloud pour le groupe d’utilisateurs.
|
userGroupId | True | string |
Identificateur du hub d’utilisateurs cloud pour le groupe d’utilisateurs. |
Supprimer l’utilisateur
Supprimez un utilisateur. En cas de suppression, les ressources utilisateur sont déplacées vers un conteneur temporaire et peuvent être restaurées dans les 30 jours. Après ce délai, elles sont définitivement supprimés.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID d’objet Microsoft de l’utilisateur.
|
microsoftObjectId | True | string |
Identificateur d’objet Microsoft de l’utilisateur. |
Supprimer un membre
Supprimez un membre d’un groupe via la propriété de navigation des membres.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID d’objet Microsoft du groupe.
|
groupMicrosoftObjectId | True | string |
Identificateur d’objet Microsoft du groupe. |
|
ID d’objet Microsoft de l’utilisateur.
|
userMicrosoftObjectId | True | string |
Identificateur d’objet Microsoft de l’utilisateur. |
Supprimer un membre d’un groupe d’utilisateurs
Supprimez un membre d’un groupe d’utilisateurs.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation du Hub d’utilisateurs cloud.
|
organizationId | True | string |
Identificateur de l’organisation Cloud User Hub. |
|
ID de groupe d’utilisateurs cloud User Hub.
|
userGroupId | True | string |
Identificateur de groupe d’utilisateurs cloud User Hub. |
|
ID d’utilisateur du hub d’utilisateurs cloud.
|
userId | True | string |
Identificateur d’utilisateur cloud User Hub. |