N-able Cloud User Hub (Vorschau)
Cloud User Hub ist ein einheitliches Microsoft CSP-Portal, mit dem Sie allgemeine Aufgaben in allen Microsoft 365-Apps automatisieren können, ohne Konsolen oder Kunden zu wechseln.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Cloud User Hub-Unterstützung |
| URL | https://documentation.clouduserhub.management/kb/en |
| technicalsupport@n-able.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | N-able Cloud User Hub B.V. |
| Webseite | https://www.n-able.com |
| Datenschutzrichtlinie | https://www.n-able.com/legal/privacy |
| Kategorien | Geschäftsmanagement;IT-Vorgänge |
Cloud User Hub ist ein einheitliches Microsoft CSP-Portal, mit dem Sie allgemeine Aufgaben in allen Microsoft 365-Apps automatisieren können, ohne Konsolen oder Kunden zu wechseln.
Voraussetzungen
Sie benötigen Folgendes, um fortzufahren:
- Ein Cloud User Hub-Abonnement
- Konfigurierte Lösungen im Cloud User Hub für die spezifischen Vorgänge, die Sie verwenden möchten
- Konfigurierte Rollen im Cloud User Hub für die spezifischen Vorgänge, die Sie verwenden möchten.
So erhalten Sie Anmeldeinformationen
Sie können sich mit jedem Konto anmelden, das für den Zugriff auf Cloud User Hub konfiguriert ist. Für Automatisierungsszenarien empfehlen wir Ihnen, ein dediziertes Dienstkonto zu verwenden.
Erste Schritte mit Ihrem Connector
Beginnen Sie mit "Organisationen abrufen", um eine Liste der Organisationen abzurufen, die Sie verwalten dürfen (einschließlich Ihrer eigenen). Organisationen werden gemäß den konfigurierten Rollenbereichen im Cloud User Hub zurückgegeben. Verwenden Sie die IDs für aufeinander folgende Aufrufe. Verwenden Sie für Vorgänge, für die eine Partner-ID erforderlich ist, die ID aus Ihrer eigenen Organisation. Für einige Vorgänge benötigen Sie eine Mandanten-ID anstelle der internen Cloud User Hub-ID oder beides.
Bekannte Probleme und Einschränkungen
Bei einigen Vorgängen muss die Zielorganisation über eine übereinstimmende Microsoft 365-Lizenz und/oder ein aktives Azure-Abonnement verfügen. Beispiel: Die Konfiguration des bedingten Zugriffs erfordert eine Microsoft Entra ID Premium-Lizenz.
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abonnementmenge aktualisieren |
Aktualisieren Sie die Anzahl eines Abonnements. |
| Abonnements abrufen |
Ruft alle Abonnements für den Kunden eines Partners anhand seines Active Directory-Mandantenbezeichners ab. |
| Abrufen einer Liste von Cloud User Hub-Benutzergruppenmitgliedern |
Dient zum Abrufen einer Liste der Benutzergruppenmitglieder einer bestimmten Gruppe. |
| Abrufen von Abonnierten SKUs der Organisation |
Ruft die Liste der kommerziellen Abonnements ab, die eine Organisation erworben hat. |
| Abrufen von Azure AD-Sicherheitsgruppen |
Rufen Sie eine Liste der Azure AD-Sicherheitsgruppen aller Organisationen ab, die Sie anzeigen dürfen. |
| Abrufen von Befehlsblockaufträgen einer bestimmten Organisation |
Abrufen von Befehlsblockaufträgen für Befehlsblöcke, die Sie zum Anzeigen autorisiert haben. |
| Abrufen von Befehlsblockaufträgen für alle autorisierten Organisationen |
Abrufen von Befehlsblockaufträgen für Befehlsblöcke, die Sie zum Anzeigen autorisiert haben. |
| Abrufen von Befehlsblockdetails |
Rufen Sie die Details eines Befehlsblocks ab. Die Anbieter- und Aktionsüberprüfung hängt vom jeweiligen Befehlsblock ab. |
| Abrufen von Benutzerdetails |
Rufen Sie einen Benutzer anhand des Microsoft-Objektbezeichners ab. |
| Abrufen von Benutzerlizenzdetails |
Dient zum Abrufen einer Liste von Lizenzdetailsobjekten für Unternehmensbenutzer. |
| Abrufen von Benutzern |
Dient zum Abrufen einer Liste von Benutzerobjekten. |
| Abrufen von Cloud User Hub-Benutzergruppen |
Dient zum Abrufen einer Liste von Gruppen aller Organisationen, die Sie zum Anzeigen autorisiert haben. |
| Abrufen von Details zu einem einzelnen Benutzerauftrag |
Die Details eines einzelnen Benutzerauftrags, eines Anbieters und einer Aktionsüberprüfung hängen vom jeweiligen Befehlsblock ab. |
| Abrufen von Statistiken zu den Befehlsblockaufträgen für alle autorisierten Organisationen |
Rufen Sie Statistiken zu den Befehlsblockaufträgen für Befehlsblöcke ab, die Sie anzeigen dürfen. |
| Auflisten von Organisationsdomänen |
Dient zum Abrufen einer Liste von Domänenobjekten. |
| Befehlsblöcke auflisten |
Dient zum Abrufen einer Liste der verfügbaren Befehlsblöcke. |
| Befehlskategorien abrufen |
Ruft alle verfügbaren Kategorien und Unterkategorien ab. |
| Benutzer erstellen |
Der Anforderungstext enthält den zu erstellenden Benutzer. Sie müssen mindestens die erforderlichen Eigenschaften für den Benutzer angeben. Sie können optional alle anderen beschreibbaren Eigenschaften angeben. |
| Benutzer löschen |
Löschen eines Benutzers. Beim Löschen werden Benutzerressourcen in einen temporären Container verschoben und können innerhalb von 30 Tagen wiederhergestellt werden. Nach diesem Zeitraum werden sie endgültig gelöscht. |
| Benutzeränderungskennwort |
Aktualisieren Sie das Kennwortprofil eines Benutzers, um sein Kennwort zurückzusetzen. |
| Cloud User Hub-Benutzergruppe löschen |
Löschen einer Benutzergruppe. |
| Entfernen eines Mitglieds aus einer Benutzergruppe |
Entfernen Eines Mitglieds zu einer Benutzergruppe. |
| Erstellen einer Azure AD-Gruppe |
Erstellen Sie azure AD-Gruppe. |
| Gebietsschemas abrufen |
Rufen Sie Gebietsschemas ab. |
| Hinzufügen eines Befehlsblockauftrags für eine Gruppe |
Hinzufügen eines Befehlsblockauftrags. Der Anbieter und die Aktionsüberprüfung basieren auf dem spezifischen Befehlsblock. |
| Hinzufügen eines Befehlsblockauftrags für eine Organisation |
Hinzufügen eines Befehlsblockauftrags. Der Anbieter und die Aktionsüberprüfung basieren auf dem spezifischen Befehlsblock. |
| Hinzufügen eines Befehlsblockauftrags für einen Benutzer |
Hinzufügen eines Befehlsblockauftrags. Der Anbieter und die Aktionsüberprüfung basieren auf dem spezifischen Befehlsblock. |
| Hinzufügen eines Mitglieds zu einer Benutzergruppe |
Fügen Sie einer Benutzergruppe ein Mitglied hinzu, das Mitglied sollte derselben Organisation wie die Gruppe angehören. |
| Hinzufügen eines Mitglieds zu einer Gruppe |
Fügen Sie ein Mitglied zu einer Microsoft 365-Gruppe oder einer Sicherheitsgruppe über die Navigationseigenschaft "Mitglieder" hinzu. |
| Mitglied entfernen |
Entfernen Sie ein Mitglied aus einer Gruppe über die Navigationseigenschaft "Mitglieder". |
| Organisationen abrufen |
Rufen Sie alle Organisationen ab, die Sie zum Anzeigen autorisiert sind. |
| Zuweisen einer Lizenz zu einem Benutzer |
Hinzufügen oder Entfernen von Lizenzen für den Benutzer. Sie können auch bestimmte Pläne aktivieren und deaktivieren, die einer Lizenz zugeordnet sind. |
Abonnementmenge aktualisieren
Aktualisieren Sie die Anzahl eines Abonnements.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cloud User Hub-Partner-ID.
|
partnerId | True | string |
Cloud User Hub-Partnerbezeichner. |
|
Cloud User Hub-Kunden-ID.
|
customerId | True | string |
Cloud User Hub-Kundenbezeichner. |
|
Microsoft-Mandanten-ID des Kunden.
|
tenantId | True | string |
Microsoft-Mandanten-ID des Kunden. |
|
Subsriptions-ID.
|
subscriptionId | True | string |
Abonnement-ID des Kunden. |
|
Menge
|
quantity | integer |
Menge des Abonnements. |
Abonnements abrufen
Ruft alle Abonnements für den Kunden eines Partners anhand seines Active Directory-Mandantenbezeichners ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Cloud User Hub-Partnerbezeichner.
|
partnerId | True | string |
Cloud User Hub-Partnerbezeichner. |
|
Cloud User Hub-Kundenbezeichner.
|
customerId | True | string |
Cloud User Hub-Kundenbezeichner. |
|
Microsoft-Mandanten-ID des Kunden.
|
tenantId | True | string |
Microsoft-Mandanten-ID des Kunden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtanzahl
|
totalCount | integer |
Gesamtanzahl des Abonnementobjekts. |
|
items
|
items | array of object |
Artikel. |
|
Id
|
items.id | string |
Bezeichner des Abonnements. |
|
Berechtigungs-ID
|
items.entitlementId | string |
Berechtigungs-ID des Abonnements. |
|
Freundlicher Name
|
items.friendlyName | string |
Anzeigename des Abonnements. |
|
Menge
|
items.quantity | integer |
Menge des Abonnements. |
|
Einheitstyp
|
items.unitType | string |
Einheitstyp des Abonnements. |
|
Erstellt am
|
items.creationDate | string |
Erstellt am Datum des Abonnements. |
|
Effektives Startdatum
|
items.effectiveStartDate | string |
Effektives Startdatum des Abonnements. |
|
Enddatum der Verpflichtung
|
items.commitmentEndDate | string |
Enddatum des Verpflichtungsabonnements. |
|
Der Status
|
items.status | string |
Status des Abonnements. |
|
Automatische Verlängerung
|
items.autoRenewEnabled | boolean |
Gibt an, ob die automatische Verlängerung für das Abonnement aktiviert ist. |
|
Fakturierungstyp
|
items.billingType | string |
Abrechnungstyp des Abonnements. |
|
Vertragstyp
|
items.contractType | string |
Vertragstyp des Abonnements. |
|
Uri
|
items.links.offer.uri | string |
URI des Abonnements. |
|
Methode
|
items.links.offer.method | string |
Methode des Abonnements. |
|
headers
|
items.links.offer.headers | array of |
Header. |
|
Uri
|
items.links.self.uri | string |
URI des Abonnements. |
|
Methode
|
items.links.self.method | string |
Methode des Abonnements. |
|
headers
|
items.links.self.headers | array of |
Header. |
|
Bestell-ID
|
items.orderId | string |
Auftragsbezeichner des Abonnements. |
|
Etag
|
items.attributes.etag | string |
Etag des Abonnements. |
|
Objekttyp
|
items.attributes.objectType | string |
Objekttyp des Abonnements. |
|
Objekttyp
|
attributes.objectType | string |
Objekttyp des Abonnements. |
Abrufen einer Liste von Cloud User Hub-Benutzergruppenmitgliedern
Dient zum Abrufen einer Liste der Benutzergruppenmitglieder einer bestimmten Gruppe.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Cloud User Hub-ID der Gruppe.
|
userGroupId | True | string |
Cloud User Hub-ID der Gruppe. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
value
|
value | array of object |
Wert. |
|
Name
|
value.name | string |
Name: |
|
Benutzerprinzipalname
|
value.upn | string |
Benutzerprinzipalname der Gruppe. |
|
Id
|
value.id | string |
Bezeichner des Gruppenmitgliedsobjekts. |
|
Gruppen-ID
|
value.groupId | string |
Cloud User Hub-ID der Gruppe. |
|
Erstellt am
|
value.createdOn | string |
Erstellt am. |
|
Geändert am
|
value.modifiedOn | string |
Geändert am. |
Abrufen von Abonnierten SKUs der Organisation
Ruft die Liste der kommerziellen Abonnements ab, die eine Organisation erworben hat.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
value | array of object |
Wert. |
|
Funktionsstatus
|
value.capabilityStatus | string |
Funktionsstatus der Microsoft-Sku. |
|
Verbrauchte Einheiten
|
value.consumedUnits | integer |
Verbrauchte Einheiten für diese Sku. |
|
Id
|
value.id | string |
Bezeichner des abonnierten sku-Objekts. |
|
SKU-ID
|
value.skuId | string |
Sku-ID der Microsoft-Lizenz. |
|
Sku-Teilnummer
|
value.skuPartNumber | string |
Sku-Teilnummer der Microsoft-Lizenz. |
|
Gilt für:
|
value.appliesTo | string |
Gilt für Benutzer oder Organisation. |
|
Enabled
|
value.prepaidUnits.enabled | integer |
Aktivierte abonnierte Skus. |
|
Ausgesetzt
|
value.prepaidUnits.suspended | integer |
Angehaltene abonnierte Skus. |
|
Warnung
|
value.prepaidUnits.warning | integer |
Abonnierte Skus mit Warnung. |
|
servicePlans
|
value.servicePlans | array of object |
Servicepläne. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan-ID. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplanname. |
|
Stand der Bereitstellung
|
value.servicePlans.provisioningStatus | string |
Bereitstellungsstatus. |
|
giltFür
|
value.servicePlans.appliesTo | string |
Gilt für. |
Abrufen von Azure AD-Sicherheitsgruppen
Rufen Sie eine Liste der Azure AD-Sicherheitsgruppen aller Organisationen ab, die Sie anzeigen dürfen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
value | array of object |
Wert. |
|
Erstellt am
|
value.createdDateTime | string |
Erstellt am. |
|
Anzeigename
|
value.displayName | string |
Anzeigename. |
|
groupTypes
|
value.groupTypes | array of string |
Gruppentypen. |
|
Id
|
value.id | string |
Microsoft-Objektbezeichner der Gruppe. |
|
Sicherheit aktiviert
|
value.securityEnabled | boolean |
Gibt an, ob die Gruppe sicherheitsfähig ist. |
|
Mail
|
value.mail | string |
E-Mail-Adresse der Gruppe. |
Abrufen von Befehlsblockaufträgen einer bestimmten Organisation
Abrufen von Befehlsblockaufträgen für Befehlsblöcke, die Sie zum Anzeigen autorisiert haben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Organisations-ID.
|
organizationId | True | string |
Format - uuid. Eindeutiger Bezeichner der Organisation. |
|
$top Elemente
|
$top | string |
Gibt nur die ersten $top Elemente zurück. |
|
|
$skip Elemente
|
$skip | string |
Die Anzahl der zu überspringenden Elemente. |
|
|
Filter auswählen
|
$select | string |
$select odata-Filter. |
|
|
Bestellung nach
|
$orderby | string |
Bestimmt, welche Werte verwendet werden, um eine Auflistung von Datensätzen zu sortieren. |
|
|
Filter
|
$filter | string |
Eine Funktion, die als wahr ausgewertet werden muss, damit ein Datensatz zurückgegeben wird. |
|
|
Anzahl
|
$count | string |
Bestimmt das Wetter oder nicht die Anzahl der Elemente in einer Auflistung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Kontext
|
@odata.context | string |
OData-Kontext. |
|
OData-Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
OData nextlink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Wert. |
|
Id
|
value.id | string |
Id. |
|
Befehlsblock-ID
|
value.commandBlockId | string |
Befehlsblock-ID. |
|
Befehlssatzname
|
value.commandSetName | string |
Befehlssatzname. |
|
Befehlssatz-ID
|
value.commandSetId | string |
Befehlssatz-ID. |
|
Befehlssatz-Block-ID
|
value.commandSetBlockId | string |
Befehlssatz-Blockbezeichner. |
|
Benutzer-ID
|
value.userId | string |
Benutzerkennung. |
|
Benutzerupup
|
value.userUpn | string |
Benutzerprinzipalname. |
|
Gruppen-ID
|
value.groupId | string |
Gruppen-ID. |
|
Gruppenname
|
value.groupName | string |
Gruppenname. |
|
Organisations-ID
|
value.organizationId | string |
Organisationsbezeichner. |
|
Name der Organisation
|
value.organizationName | string |
Name der Organisation. |
|
Benutzerprinzipalname des Akteurs
|
value.actorUserUpn | string |
Benutzerprinzipalname des Akteurs. |
|
Actor-Organisations-ID
|
value.actorOrganizationId | string |
Bezeichner der Akteurorganisation. |
|
Name der Akteurorganisation
|
value.actorOrganizationName | string |
Name der Akteurorganisation. |
|
Der Status
|
value.status | string |
Status: |
|
Ausgeführt am
|
value.executedOn | string |
Ausgeführt am. |
|
Technische ID des Befehlsblocks
|
value.commandBlockTechnicalIdentifier | string |
Technischer Bezeichner "Command Block". |
|
Befehlsblockversion
|
value.commandBlockVersion | integer |
Befehlsblockversion. |
|
Geplante Ausführung
|
value.plannedExecution | string |
Geplante Ausführung. |
|
Zeitplan-ID
|
value.scheduleId | string |
Zeitplanbezeichner. |
|
Zeitplanname
|
value.scheduleName | string |
Name des Zeitplans. |
Abrufen von Befehlsblockaufträgen für alle autorisierten Organisationen
Abrufen von Befehlsblockaufträgen für Befehlsblöcke, die Sie zum Anzeigen autorisiert haben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
$top Elemente
|
$top | string |
Gibt nur die ersten $top Elemente zurück. |
|
|
$skip Elemente
|
$skip | string |
Die Anzahl der zu überspringenden Elemente. |
|
|
Filter auswählen
|
$select | string |
$select odata-Filter. |
|
|
Bestellung nach
|
$orderby | string |
Bestimmt, welche Werte verwendet werden, um eine Auflistung von Datensätzen zu sortieren. |
|
|
Filter
|
$filter | string |
Eine Funktion, die als wahr ausgewertet werden muss, damit ein Datensatz zurückgegeben wird. |
|
|
Anzahl
|
$count | string |
Bestimmt, ob die Anzahl der Elemente in einer Auflistung enthalten sein soll. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Kontext
|
@odata.context | string |
OData-Kontext. |
|
OData-Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
OData nächster Link
|
@odata.nextLink | string |
OData nächster Link |
|
value
|
value | array of object |
Wert. |
|
Id
|
value.id | string |
Bezeichner. |
|
Befehlsblock-ID
|
value.commandBlockId | string |
Befehlsblock-ID. |
|
Befehlssatzname
|
value.commandSetName | string |
Befehlssatzname. |
|
Befehlssatz-ID
|
value.commandSetId | string |
Befehlssatzbezeichner |
|
Befehlssatz-Block-ID
|
value.commandSetBlockId | string |
Befehlssatz-Blockbezeichner. |
|
Benutzer-ID
|
value.userId | string |
Benutzerkennung. |
|
Benutzerprinzipalname
|
value.userUpn | string |
Benutzerprinzipalname. |
|
Gruppen-ID
|
value.groupId | string |
Gruppen-ID. |
|
Gruppenname
|
value.groupName | string |
Gruppenname. |
|
Organisations-ID
|
value.organizationId | string |
Organisationsbezeichner. |
|
Name der Organisation
|
value.organizationName | string |
Name der Organisation. |
|
Upn des Akteurbenutzers
|
value.actorUserUpn | string |
Benutzerprinzipalname des Akteurs. |
|
Actor-Organisations-ID
|
value.actorOrganizationId | string |
Bezeichner der Akteurorganisation. |
|
Name der Akteurorganisation
|
value.actorOrganizationName | string |
Name der Akteurorganisation. |
|
Der Status
|
value.status | string |
Status: |
|
Ausgeführt am
|
value.executedOn | string |
Ausgeführt am. |
|
Technische ID des Befehlsblocks
|
value.commandBlockTechnicalIdentifier | string |
Technischer Bezeichner "Command Block". |
|
Befehlsblockversion
|
value.commandBlockVersion | integer |
Befehlsblockversion. |
|
Geplante Ausführung
|
value.plannedExecution | string |
Geplante Ausführung. |
|
Zeitplan-ID
|
value.scheduleId | string |
Zeitplanbezeichner. |
|
Zeitplanname
|
value.scheduleName | string |
Name des Zeitplans. |
Abrufen von Befehlsblockdetails
Rufen Sie die Details eines Befehlsblocks ab. Die Anbieter- und Aktionsüberprüfung hängt vom jeweiligen Befehlsblock ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Befehlsblock-ID
|
commandBlockId | True | string |
Format - uuid. Eindeutiger Bezeichner des Befehlsblocks. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
Version
|
version | integer |
Version. |
|
Kategorie-ID
|
categoryId | string |
Kategorie-ID. |
|
Technische ID
|
technicalIdentifier | string |
Technischer Bezeichner. |
|
Erforderliche Leseaktion
|
requiredReadAction | string |
Erforderliche Leseaktion. |
|
Erforderliche Schreibaktion
|
requiredWriteAction | string |
Erforderliche Schreibaktion. |
|
Erforderlicher Anbieter
|
requiredProvider | string |
Erforderlicher Anbieter. |
|
Typ
|
type | string |
Typ: |
|
Id
|
category.id | string |
Id. |
|
Technische ID
|
category.technicalIdentifier | string |
Technischer Bezeichner. |
|
Id
|
parentCategory.id | string |
Id. |
|
Technische ID
|
parentCategory.technicalIdentifier | string |
Technischer Bezeichner. |
|
Id
|
menuCategory.id | string |
Id. |
|
Technische ID
|
menuCategory.technicalIdentifier | string |
Technischer Bezeichner. |
|
Mehrfachauswahl
|
commandInput.multiSelection | string |
Mehrfachauswahl. |
|
layoutGroups
|
commandInput.layoutGroups | array of object |
Layoutgruppen. |
|
Technische ID
|
commandInput.layoutGroups.technicalIdentifier | string |
Technischer Bezeichner. |
|
layoutGroupFormats
|
commandInput.layoutGroups.layoutGroupFormats | array of object |
Layoutgruppenformate. |
|
type
|
commandInput.layoutGroups.layoutGroupFormats.type | string |
Typ: |
|
property
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
Eigentum. |
|
Eigenschaften
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
Eigenschaften. |
|
parameters
|
commandInput.parameters | array of object |
Parameter. |
|
Standardwert
|
commandInput.parameters.defaultValue | string |
Standardwert. |
|
Technische ID
|
commandInput.parameters.technicalIdentifier | string |
Technischer Bezeichner. |
|
Schema
|
commandInput.parameters.schema | string |
Schema |
|
Sensibel
|
commandInput.parameters.sensitive | boolean |
Empfindlich. |
|
Erforderlich
|
commandInput.parameters.required | boolean |
Erforderlich. |
|
Wert
|
commandInput.parameters.value | string |
Wert. |
|
Befehlssatz
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
Befehlssatz. |
|
Befehlsblock
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
Befehlsblock. |
|
linkedCommandBlocks
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Verknüpfte Befehlsblöcke. |
|
technicalIdentifier
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Technischer Bezeichner. |
|
Ausgabe
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Version. |
|
layoutGroups
|
commandOutput.layoutGroups | array of object |
Layoutgruppen. |
|
Technische ID
|
commandOutput.layoutGroups.technicalIdentifier | string |
Technischer Bezeichner. |
|
layoutGroupFormats
|
commandOutput.layoutGroups.layoutGroupFormats | array of object |
Layoutgruppenformate. |
|
type
|
commandOutput.layoutGroups.layoutGroupFormats.type | string |
Typ: |
|
property
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
Eigentum. |
|
Eigenschaften
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
Eigenschaften. |
|
parameters
|
commandOutput.parameters | array of object |
Parameter. |
|
Example
|
commandOutput.parameters.example | string |
Beispiel: |
|
Technische ID
|
commandOutput.parameters.technicalIdentifier | string |
Technischer Bezeichner. |
|
Schema
|
commandOutput.parameters.schema | string |
Schema |
|
Sensibel
|
commandOutput.parameters.sensitive | boolean |
Empfindlich. |
|
Erforderlich
|
commandOutput.parameters.required | boolean |
Erforderlich. |
|
Wert
|
commandOutput.parameters.value | string |
Wert. |
|
Befehlssatz
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
Befehlssatz. |
|
Befehlsblock
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
Commmand-Block. |
Abrufen von Benutzerdetails
Rufen Sie einen Benutzer anhand des Microsoft-Objektbezeichners ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objekt-ID des Benutzers.
|
microsoftObjectId | True | string |
Microsoft-Objektbezeichner des Benutzers. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Konto aktiviert
|
accountEnabled | boolean |
Das Konto hat "true" oder "false" aktiviert. |
|
Mitarbeiter-ID
|
employeeId | string |
Mitarbeiter-ID des Benutzers. |
|
Anzeigename
|
displayName | string |
Der Anzeigename des Benutzers. |
|
Vorname
|
givenName | string |
Der Angegebene Name des Benutzers. |
|
Surname
|
surname | string |
Nachname des Benutzers. |
|
Benutzerprinzipalname
|
userPrincipalName | string |
Benutzerprinzipalname des Benutzers. |
|
Berufsbezeichnung
|
jobTitle | string |
Position des Benutzers. |
|
Abteilung
|
department | string |
Abteilung des Benutzers. |
|
Unternehmensname
|
companyName | string |
Firmenname des Benutzers. |
|
Usagelocation
|
usageLocation | string |
Verwendungsort des Benutzers. |
|
Anschrift
|
streetAddress | string |
Straße des Benutzers. |
|
Stadt
|
city | string |
Ort des Benutzers. |
|
Staat
|
state | string |
Status des Benutzers. |
|
Postleitzahl
|
postalCode | string |
Postleitzahl des Benutzers. |
|
Country
|
country | string |
Land des Benutzers. |
Abrufen von Benutzerlizenzdetails
Dient zum Abrufen einer Liste von Lizenzdetailsobjekten für Unternehmensbenutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objekt-ID des Benutzers.
|
microsoftObjectId | True | string |
Microsoft-Objektbezeichner des Benutzers. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
value | array of object |
Wert. |
|
Id
|
value.id | string |
Bezeichner der Lizenz des Benutzers. |
|
SKU-ID
|
value.skuId | string |
Sku-ID der Microsoft-Lizenz. |
|
Sku-Teilnummer
|
value.skuPartNumber | string |
Sku-Teilnummer der Microsoft-Lizenz. |
|
servicePlans
|
value.servicePlans | array of object |
Servicepläne. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan-ID. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplanname. |
|
Stand der Bereitstellung
|
value.servicePlans.provisioningStatus | string |
Bereitstellungsstatus. |
|
giltFür
|
value.servicePlans.appliesTo | string |
Gilt für. |
Abrufen von Benutzern
Dient zum Abrufen einer Liste von Benutzerobjekten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Filtert Benutzer.
|
$filter | True | string |
Filtert nach Benutzern in einer Organisation. Verwenden Sie: organizationId in ('{organizationId}'). |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
value
|
value | array of object |
Wert. |
|
Organisations-ID
|
value.organizationId | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objektbezeichner
|
value.microsoftObjectIdentifier | string |
Microsoft-Objektbezeichner des Benutzers. |
|
Benutzerprinzipalname
|
value.upn | string |
Benutzerprinzipalname des Benutzers. |
|
Vorname
|
value.firstName | string |
Vorname des Benutzers. |
|
Nachname
|
value.lastName | string |
Nachname des Benutzers. |
|
Anzeigename
|
value.displayName | string |
Der Anzeigename des Benutzers. |
|
Language
|
value.language | string |
Sprache des Benutzers. |
|
Verwendungsstandort
|
value.usageLocation | string |
Verwendungsort des Benutzers. |
|
Id
|
value.id | string |
Cloud User Hub-ID des Benutzers. |
|
Erstellt am
|
value.createdOn | string |
Erstellt am. |
|
Geändert am
|
value.modifiedOn | string |
Geändert am. |
Abrufen von Cloud User Hub-Benutzergruppen
Dient zum Abrufen einer Liste von Gruppen aller Organisationen, die Sie zum Anzeigen autorisiert haben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Filtergruppen.
|
$filter | True | string |
Filtern sie nach Gruppen in einer Organisation. Verwenden Sie: organizationId in ('{organizationId}'). |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
value
|
value | array of object |
Wert. |
|
Organisations-ID
|
value.organizationId | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Name
|
value.name | string |
Name der Gruppe. |
|
Description
|
value.description | string |
Beschreibung für die Gruppe. |
|
Id
|
value.id | string |
Bezeichner der Gruppe. |
|
Erstellt am
|
value.createdOn | string |
Erstellt am. |
|
Geändert am
|
value.modifiedOn | string |
Geändert am. |
Abrufen von Details zu einem einzelnen Benutzerauftrag
Die Details eines einzelnen Benutzerauftrags, eines Anbieters und einer Aktionsüberprüfung hängen vom jeweiligen Befehlsblock ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Organisations-ID
|
organizationId | True | string |
Format - uuid. Eindeutiger Bezeichner der Organisation. |
|
Befehlsblock-ID
|
commandBlockId | True | string |
Format - uuid. Eindeutiger Bezeichner des Befehlsblocks. |
|
Auftrags-ID
|
jobId | True | string |
Format - uuid. Eindeutiger Bezeichner des Auftrags. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
Befehlsblock-ID
|
commandBlockId | string |
Befehlsblock-ID. |
|
Befehlssatzname
|
commandSetName | string |
Befehlssatzname. |
|
Befehlssatz-ID
|
commandSetId | string |
Befehlssatz-ID. |
|
Befehlssatz-Block-ID
|
commandSetBlockId | string |
Befehlssatz-Blockbezeichner. |
|
Benutzer-ID
|
userId | string |
Benutzerkennung. |
|
Benutzerupup
|
userUpn | string |
Benutzerprinzipalname des Benutzers. |
|
Gruppen-ID
|
groupId | string |
Gruppen-ID. |
|
Gruppenname
|
groupName | string |
Gruppenname. |
|
Organisations-ID
|
organizationId | string |
Organisationsbezeichner. |
|
Name der Organisation
|
organizationName | string |
Name der Organisation. |
|
Actor upn
|
actorUserUpn | string |
Benutzerprinzipalname des Akteurs. |
|
Actor-Organisations-ID
|
actorOrganizationId | string |
Bezeichner der Akteurorganisation. |
|
Name der Akteurorganisation
|
actorOrganizationName | string |
Name der Akteurorganisation. |
|
Der Status
|
status | string |
Status: |
|
Ausgeführt am
|
executedOn | string |
Ausgeführt am. |
|
Technische ID des Befehlsblocks
|
commandBlockTechnicalIdentifier | string |
Technischer Bezeichner "Command Block". |
|
Befehlsblockversion
|
commandBlockVersion | integer |
Befehlsblockversion. |
|
layoutGroups
|
output.body.layoutGroups | array of object |
Layoutgruppenformate. |
|
layoutGroupFormats
|
output.body.layoutGroups.layoutGroupFormats | array of object |
Layoutgruppenformate. |
|
type
|
output.body.layoutGroups.layoutGroupFormats.type | string |
Typ: |
|
property
|
output.body.layoutGroups.layoutGroupFormats.property | string |
Eigentum. |
|
Eigenschaften
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
Eigenschaften. |
|
parameters
|
output.body.parameters | array of object |
Parameter. |
|
Technische ID
|
output.body.parameters.technicalIdentifier | string |
Technischer Bezeichner. |
|
Wert
|
output.body.parameters.value | string |
Wert. |
|
Schema
|
output.body.parameters.schema | string |
Schema |
|
Befehlssatz
|
output.body.parameters.placeholderEnabled.commandSet | boolean |
Befehlssatz. |
|
Befehlsblock
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
Befehlsblock. |
|
Fehlercode
|
output.errorCode | string |
Fehlercode. |
|
Success
|
output.isSuccess | boolean |
Erfolgreich. |
|
layoutGroups
|
input.layoutGroups | array of object |
Layoutgruppen. |
|
layoutGroupFormats
|
input.layoutGroups.layoutGroupFormats | array of object |
Layoutgruppenformate. |
|
type
|
input.layoutGroups.layoutGroupFormats.type | string |
Typ: |
|
property
|
input.layoutGroups.layoutGroupFormats.property | string |
Eigentum. |
|
Eigenschaften
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
Eigenschaften. |
|
Mehrere Organisationen
|
input.multiSelection.multipleOrganizations | boolean |
Mehrere Organisationen. |
|
Mehrere Benutzer
|
input.multiSelection.multipleUsers | boolean |
Mehrere Benutzer. |
|
parameters
|
input.parameters | array of object |
Parameter. |
|
Technische ID
|
input.parameters.technicalIdentifier | string |
Technischer Bezeichner. |
|
Wert
|
input.parameters.value | string |
Wert. |
|
Standardwert
|
input.parameters.defaultValue | string |
Standardwert. |
|
Typ
|
input.parameters.schema.type | string |
Typ: |
|
Format
|
input.parameters.schema.format | string |
Format. |
|
Muster
|
input.parameters.schema.pattern | string |
Muster. |
|
Minimale Länge
|
input.parameters.schema.minLength | string |
Minimale Länge. |
|
Befehlssatz
|
input.parameters.placeholderEnabled.commandSet | boolean |
Befehlssatz. |
|
Befehlsblock
|
input.parameters.placeholderEnabled.commandBlock | boolean |
Befehlsblock. |
|
linkedCommandBlocks
|
input.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Verknüpfte Befehlsblöcke. |
|
technicalIdentifier
|
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Technischer Bezeichner. |
|
Ausgabe
|
input.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Version. |
Abrufen von Statistiken zu den Befehlsblockaufträgen für alle autorisierten Organisationen
Rufen Sie Statistiken zu den Befehlsblockaufträgen für Befehlsblöcke ab, die Sie anzeigen dürfen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kategorie-ID
|
categoryId | True | string |
Format - uuid. Eindeutiger Bezeichner der Kategorie. |
|
Filter auswählen
|
$select | string |
$select odata-Filter. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Kontext
|
@odata.context | string |
OData-Kontext. |
|
Typ
|
type | string |
Typ: |
|
Kategorie
|
category | string |
Kategorie. |
|
Zeitraum
|
period | string |
Periode. |
|
Abgeschlossen
|
completed | integer |
Abgeschlossen. |
|
In der Warteschlange
|
queued | integer |
Angestanden. |
|
gescheitert
|
failed | integer |
Misslungen. |
Auflisten von Organisationsdomänen
Dient zum Abrufen einer Liste von Domänenobjekten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
value | array of object |
Wert. |
|
Authentifizierungsart
|
value.authenticationType | string |
Authentifizierungstyp der Domäne. |
|
Verfügbarkeitsstatus
|
value.availabilityStatus | string |
Verfügbarkeitsstatus der Domäne. |
|
Id
|
value.id | string |
Bezeichner der Domäne. |
|
Verwalteter Administrator
|
value.isAdminManaged | boolean |
Gibt an, ob die Domäne vom Administrator verwaltet wird. |
|
Standard
|
value.isDefault | boolean |
Gibt an, ob dies die Standarddomäne ist. |
|
Erste
|
value.isInitial | boolean |
Gibt an, ob dies die ursprüngliche Domäne ist. |
|
Stamm
|
value.isRoot | boolean |
Gibt an, ob dies die Stammdomäne ist. |
|
Überprüft
|
value.isVerified | boolean |
Gibt an, ob die Domäne überprüft wird. |
|
supportedServices
|
value.supportedServices | array of string |
Unterstützte Dienste. |
|
Kennwortgültigkeit
|
value.passwordValidityPeriodInDays | integer |
Gibt die Gültigkeit des Kennworts in Tagen an. |
|
Kennwortbenachrichtigungsfenster
|
value.passwordNotificationWindowInDays | integer |
Gibt das Kennwort-Notifcation-Fenster in Tagen an. |
|
Staat
|
value.state | string |
Status der Domäne. |
Befehlsblöcke auflisten
Dient zum Abrufen einer Liste der verfügbaren Befehlsblöcke.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
$top Elemente
|
$top | string |
Gibt nur die ersten $top Elemente zurück. |
|
|
$skip Elemente
|
$skip | string |
Die Anzahl der zu überspringenden Elemente. |
|
|
Filter auswählen
|
$select | string |
$select odata-Filter. |
|
|
Bestellung nach
|
$orderby | string |
Bestimmt, welche Werte verwendet werden, um eine Auflistung von Datensätzen zu sortieren. |
|
|
Filter
|
$filter | string |
Eine Funktion, die als wahr ausgewertet werden muss, damit ein Datensatz zurückgegeben wird. |
|
|
Anzahl
|
$count | string |
Bestimmt, dass die Anzahl der Elemente in einer Auflistung nicht einbezogen werden soll. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Kontext
|
@odata.context | string |
OData-Kontext. |
|
OData-Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
OData nächster Link
|
@odata.nextLink | string |
OData als nächster Link. |
|
value
|
value | array of object |
Wert. |
|
Id
|
value.id | string |
Bezeichner. |
|
Technische ID
|
value.technicalIdentifier | string |
Technischer Bezeichner. |
|
Typ
|
value.type | string |
Typ: |
|
Version
|
value.version | integer |
Version. |
|
Kategorie-ID
|
value.categoryId | string |
Kategoriebezeichner. |
|
Erforderliche Leseaktion
|
value.requiredReadAction | string |
Erforderliche Leseaktion. |
|
Erforderliche Schreibaktion
|
value.requiredWriteAction | string |
Erforderliche Schreibaktion. |
|
Erforderlicher Anbieter
|
value.requiredProvider | string |
Erforderlicher Anbieter. |
|
Menükategorie-ID
|
value.menuCategory.id | string |
Bezeichner der Menükategorie. |
|
Technische ID
|
value.menuCategory.technicalIdentifier | string |
Technischer Bezeichner. |
|
Übergeordnete Kategorie-ID
|
value.parentCategory.id | string |
Bezeichner der übergeordneten Kategorie. |
|
Technische ID
|
value.parentCategory.technicalIdentifier | string |
Technischer Bezeichner. |
|
Id
|
value.category.id | string |
ID der Kategorie. |
|
Technischer Bezeichner
|
value.category.technicalIdentifier | string |
Technischer Bezeichner. |
Befehlskategorien abrufen
Ruft alle verfügbaren Kategorien und Unterkategorien ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
$top Elemente
|
$top | string |
Gibt nur die ersten $top Elemente zurück. |
|
|
$skip Elemente
|
$skip | string |
Die Anzahl der zu überspringenden Elemente. |
|
|
Filter auswählen
|
$select | string |
$select odata-Filter. |
|
|
Bestellung nach
|
$orderby | string |
Bestimmt, welche Werte verwendet werden, um eine Auflistung von Datensätzen zu sortieren. |
|
|
Filter
|
$filter | string |
Eine Funktion, die als wahr ausgewertet werden muss, damit ein Datensatz zurückgegeben wird. |
|
|
Anzahl
|
$count | string |
Bestimmt das Wetter oder nicht die Anzahl der Elemente in einer Auflistung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Kontext
|
@odata.context | string |
OData-Kontext. |
|
OData-Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
OData nächster Link
|
@odata.nextLink | string |
OData als nächster Link. |
|
value
|
value | array of object |
Wert. |
|
Id
|
value.id | string |
Id. |
|
Technische ID
|
value.technicalIdentifier | string |
Technischer Bezeichner. |
|
Übergeordnete Kategorie-ID
|
value.parentCategoryId | string |
Bezeichner der übergeordneten Kategorie. |
Benutzer erstellen
Der Anforderungstext enthält den zu erstellenden Benutzer. Sie müssen mindestens die erforderlichen Eigenschaften für den Benutzer angeben. Sie können optional alle anderen beschreibbaren Eigenschaften angeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Konto aktiviert
|
accountEnabled | boolean |
Das Konto hat "true" oder "false" aktiviert. |
|
|
Anzeigename
|
displayName | string |
Der Anzeigename des Benutzers. |
|
|
E-Mail-Spitzname
|
mailNickname | string |
E-Mail-Spitzname des Benutzers. |
|
|
Benutzerprinzipalname
|
userPrincipalName | string |
Benutzerprinzipalname des Benutzers. |
|
|
Kennwort beim nächsten Anmelden erzwingen
|
forceChangePasswordNextSignIn | boolean |
Erzwingen Sie, dass der Benutzer das Kennwort bei der nächsten Anmeldung ändert. |
|
|
Kennwort
|
password | string |
Neues Kennwort für den Benutzer. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Kontext
|
@odata.context | string |
OData-Kontext. |
|
Id
|
id | string |
Cloud User Hub Identifier. |
|
businessPhones
|
businessPhones | array of string |
Geschäftstelefone des Benutzers. |
|
Anzeigename
|
displayName | string |
Der Anzeigename des Benutzers. |
|
Vorname
|
givenName | string |
Vorname. |
|
Berufsbezeichnung
|
jobTitle | string |
Position des Benutzers. |
|
Mail
|
string |
E-Mail-Adresse des Benutzers. |
|
|
Mobiltelefonnummer
|
mobilePhone | string |
Mobiltelefonnummer des Benutzers. |
|
Bürostandort
|
officeLocation | string |
Office-Speicherort des Benutzers. |
|
Bevorzugte Sprache
|
preferredLanguage | string |
Bevorzugte Sprache wie in Azure AD konfiguriert. |
|
Surname
|
surname | string |
Nachname des Benutzers. |
|
Benutzerprinzipalname
|
userPrincipalName | string |
Benutzerprinzipalname des Benutzers. |
Benutzer löschen
Löschen eines Benutzers. Beim Löschen werden Benutzerressourcen in einen temporären Container verschoben und können innerhalb von 30 Tagen wiederhergestellt werden. Nach diesem Zeitraum werden sie endgültig gelöscht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objekt-ID des Benutzers.
|
microsoftObjectId | True | string |
Microsoft-Objektbezeichner des Benutzers. |
Benutzeränderungskennwort
Aktualisieren Sie das Kennwortprofil eines Benutzers, um sein Kennwort zurückzusetzen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objekt-ID des Benutzers.
|
microsoftObjectId | True | string |
Microsoft-Objektbezeichner des Benutzers. |
|
Erzwingen der Kennwortänderung bei der Anmeldung
|
forceChangePasswordNextSignIn | boolean |
Erzwingen Sie, dass der Benutzer das Kennwort bei der nächsten Anmeldung ändert. |
|
|
Kennwort
|
password | string |
Neues Kennwort, das festgelegt werden soll. |
Cloud User Hub-Benutzergruppe löschen
Löschen einer Benutzergruppe.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Cloud User Hub-ID für die Benutzergruppe.
|
userGroupId | True | string |
Cloud User Hub-ID für die Benutzergruppe. |
Entfernen eines Mitglieds aus einer Benutzergruppe
Entfernen Eines Mitglieds zu einer Benutzergruppe.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Benutzergruppen-ID für Cloud User Hub.
|
userGroupId | True | string |
Benutzergruppenbezeichner für Cloud User Hub. |
|
Benutzer-ID des Cloud User Hub.
|
userId | True | string |
Benutzerbezeichner für Cloud User Hub. |
Erstellen einer Azure AD-Gruppe
Erstellen Sie azure AD-Gruppe.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Description
|
description | string |
Beschreibung der Gruppe. |
|
|
Anzeigename
|
displayName | string |
Anzeigename der Gruppe. |
|
|
groupTypes
|
groupTypes | array of string |
Gruppentypen. |
|
|
E-Mail aktiviert
|
mailEnabled | boolean |
Gibt an, ob die Gruppe E-Mail aktiviert ist. |
|
|
E-Mail-Spitzname
|
mailNickname | string |
E-Mail-Spitzname der Gruppe. |
|
|
Sicherheit aktiviert
|
securityEnabled | boolean |
Gibt an, ob die Gruppe sicherheitsfähig ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
Bezeichner der Gruppe. |
|
Gelöscht am
|
deletedDateTime | string |
Gelöscht am. |
|
Klassifizierung
|
classification | string |
Klassifizierung der Gruppe. |
|
Erstellt am
|
createdDateTime | string |
Erstellt am. |
|
creationOptions
|
creationOptions | array of string |
Erstellungsoptionen. |
|
Description
|
description | string |
Beschreibung. |
|
Anzeigename
|
displayName | string |
Anzeigename. |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
Mail
|
string |
E-Mail-Adresse der Gruppe. |
|
|
E-Mail aktiviert
|
mailEnabled | boolean |
Gibt an, dass die Gruppe E-Mail aktiviert ist. |
|
E-Mail-Spitzname
|
mailNickname | string |
E-Mail-Spitzname der Gruppe. |
|
Lokale letzte Synchronisierung
|
onPremisesLastSyncDateTime | string |
Gibt an, wann die Gruppe lokal synchronisiert wurde. |
|
Lokale Sicherheits-ID
|
onPremisesSecurityIdentifier | string |
Lokale Sicherheits-ID der Gruppe. |
|
Lokale Synchronisierung aktiviert
|
onPremisesSyncEnabled | string |
Gibt an, ob die lokale Synchronisierung aktiviert ist. |
|
Bevorzugter Datenspeicherort
|
preferredDataLocation | string |
Bevorzugter Datenspeicherort der Gruppe. |
|
Proxy-Adressen
|
proxyAddresses | array of string |
Proxyadressen. |
|
Erneut
|
renewedDateTime | string |
Verlängerte Datumszeit der Gruppe. |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
Optionen für das Ressourcenverhalten. |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
Ressourcenprovsionierungsoptionen. |
|
Sicherheit aktiviert
|
securityEnabled | boolean |
Gibt an, ob die Gruppe sicherheitsfähig ist. |
|
Empfindlichkeit
|
visibility | string |
Sichtbarkeit der Gruppe. |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
Lokale Bereitstellungsfehler. |
Gebietsschemas abrufen
Rufen Sie Gebietsschemas ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Kontext
|
@odata.context | string |
OData-Kontext. |
|
Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
OData nextLink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Wert. |
|
Id
|
value.id | string |
Gebietsschema-ID. |
|
Code des Gebietsschemas
|
value.localeCode | string |
ISO-639-Sprachcodes. |
|
Landescode
|
value.countryCode | string |
ISO-3166 Ländercodes. |
|
Ländername
|
value.countryName | string |
Ländername. |
Hinzufügen eines Befehlsblockauftrags für eine Gruppe
Hinzufügen eines Befehlsblockauftrags. Der Anbieter und die Aktionsüberprüfung basieren auf dem spezifischen Befehlsblock.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Organisations-ID
|
organizationId | True | string |
Format - uuid. Eindeutiger Bezeichner der Organisation. |
|
Befehlsblock-ID
|
commandBlockId | True | string |
Format - uuid. Eindeutiger Bezeichner des Befehlsblocks. |
|
Zielgruppen-ID
|
targetGroupId | True | string |
Format - uuid. Eindeutiger Bezeichner der Zielgruppe. |
|
Technische ID
|
technicalIdentifier | string |
Technischer Bezeichner. |
|
|
Wert
|
value | string |
Wert. |
|
|
Zeitplan-ID
|
scheduleId | string |
Zeitplanbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
Wert. |
Hinzufügen eines Befehlsblockauftrags für eine Organisation
Hinzufügen eines Befehlsblockauftrags. Der Anbieter und die Aktionsüberprüfung basieren auf dem spezifischen Befehlsblock.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Organisations-ID
|
organizationId | True | string |
Format - uuid. Eindeutiger Bezeichner der Organisation. |
|
Befehlsblock-ID
|
commandBlockId | True | string |
Format - uuid. Eindeutiger Bezeichner des Befehlsblocks. |
|
Zielorganisations-ID
|
targetOrganizationId | True | string |
Format - uuid. Eindeutiger Bezeichner der Zielorganisation. |
|
Technische ID
|
technicalIdentifier | string |
Technischer Bezeichner |
|
|
Wert
|
value | string |
Wert. |
|
|
Zeitplan-ID
|
scheduleId | string |
Zeitplanbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
Wert. |
Hinzufügen eines Befehlsblockauftrags für einen Benutzer
Hinzufügen eines Befehlsblockauftrags. Der Anbieter und die Aktionsüberprüfung basieren auf dem spezifischen Befehlsblock.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Organisations-ID
|
organizationId | True | string |
Format - uuid. Eindeutiger Bezeichner der Organisation. |
|
Befehlsblock-ID
|
commandBlockId | True | string |
Format - uuid. Eindeutiger Bezeichner des Befehlsblocks. |
|
Zielbenutzer-ID
|
targetUserId | True | string |
Format - uuid. Eindeutiger Bezeichner des Zielbenutzers. |
|
Technische ID
|
technicalIdentifier | string |
Technischer Bezeichner. |
|
|
Wert
|
value | string |
Wert. |
|
|
Zeitplan-ID
|
scheduleId | string |
Zeitplanbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
Wert. |
Hinzufügen eines Mitglieds zu einer Benutzergruppe
Fügen Sie einer Benutzergruppe ein Mitglied hinzu, das Mitglied sollte derselben Organisation wie die Gruppe angehören.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Benutzergruppen-ID für Cloud User Hub.
|
userGroupId | True | string |
Benutzergruppenbezeichner für Cloud User Hub. |
|
Benutzer-ID des Cloud User Hub.
|
userId | True | string |
Benutzerbezeichner für Cloud User Hub. |
Hinzufügen eines Mitglieds zu einer Gruppe
Fügen Sie ein Mitglied zu einer Microsoft 365-Gruppe oder einer Sicherheitsgruppe über die Navigationseigenschaft "Mitglieder" hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objekt-ID der Gruppe.
|
microsoftObjectId | True | string |
Microsoft-Objektbezeichner der Gruppe. |
|
Mitglied
|
@odata.id | True | string |
URI des hinzuzufügenden Verzeichnis-, Benutzer-, Gruppen- oder Organisationskontaktobjekts. |
Mitglied entfernen
Entfernen Sie ein Mitglied aus einer Gruppe über die Navigationseigenschaft "Mitglieder".
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objekt-ID der Gruppe.
|
groupMicrosoftObjectId | True | string |
Microsoft-Objektbezeichner der Gruppe. |
|
Microsoft-Objekt-ID des Benutzers.
|
userMicrosoftObjectId | True | string |
Microsoft-Objektbezeichner des Benutzers. |
Organisationen abrufen
Rufen Sie alle Organisationen ab, die Sie zum Anzeigen autorisiert sind.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
OData-Anzahl
|
@odata.count | integer |
OData-Anzahl. |
|
value
|
value | array of object |
Wert. |
|
Name
|
value.name | string |
Name der Azure AD-Organisation. |
|
Microsoft tenantId
|
value.microsoftTenantId | string |
Microsoft-Mandantenbezeichner der Organisation. |
|
Erstellt am
|
value.createdOn | string |
Erstellt am. |
|
Geändert am
|
value.modifiedOn | string |
Geändert am. |
|
Id
|
value.id | string |
Bezeichner des Cloud-Benutzerhubs. |
Zuweisen einer Lizenz zu einem Benutzer
Hinzufügen oder Entfernen von Lizenzen für den Benutzer. Sie können auch bestimmte Pläne aktivieren und deaktivieren, die einer Lizenz zugeordnet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Id der Cloud User Hub-Organisation.
|
organizationId | True | string |
Bezeichner der Cloud User Hub-Organisation. |
|
Microsoft-Objekt-ID des Benutzers.
|
microsoftObjectId | True | string |
Microsoft-Objektbezeichner des Benutzers. |
|
disabledPlans
|
disabledPlans | array of |
Deaktivierte Pläne. |
|
|
SKU-ID
|
skuId | string |
Sku-ID der Microsoft-Lizenz. |
|
|
Lizenzen entfernen
|
removeLicenses | array of |
Eine Sammlung von GUIDs, die die zu entfernenden Lizenzen identifizieren. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
value | array of object |
Wert. |
|
Id
|
value.id | string |
Bezeichner des Lizenzobjekts. |
|
SKU-ID
|
value.skuId | string |
Microsoft-Sku-ID. |
|
Sku-Teilnummer
|
value.skuPartNumber | string |
Microsoft Sku-Teilnummer. |
|
servicePlans
|
value.servicePlans | array of object |
Servicepläne. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan-ID. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplanname. |
|
Stand der Bereitstellung
|
value.servicePlans.provisioningStatus | string |
Bereitstellungsstatus. |
|
giltFür
|
value.servicePlans.appliesTo | string |
Gilt für. |