N-able Cloud User Hub (wersja zapoznawcza)
Cloud User Hub to ujednolicony portal programu Microsoft CSP, który umożliwia automatyzowanie typowych zadań we wszystkich aplikacjach platformy Microsoft 365 bez przełączania konsol ani klientów.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Obsługa centrum użytkowników w chmurze |
| adres URL | https://documentation.clouduserhub.management/kb/en |
| technicalsupport@n-able.com |
| Metadane łącznika | |
|---|---|
| Publisher | N-able Cloud User Hub B.V. |
| Witryna internetowa | https://www.n-able.com |
| Zasady ochrony prywatności | https://www.n-able.com/legal/privacy |
| Kategorie | Zarządzanie biznesem;operacje IT |
Cloud User Hub to ujednolicony portal programu Microsoft CSP, który umożliwia automatyzowanie typowych zadań we wszystkich aplikacjach platformy Microsoft 365 bez przełączania konsol ani klientów.
Wymagania wstępne
Aby kontynuować, musisz wykonać następujące czynności:
- Subskrypcja usługi Cloud User Hub
- Skonfigurowane rozwiązania w usłudze Cloud User Hub dla określonych operacji, których zamierzasz użyć
- Skonfigurowane role w usłudze Cloud User Hub dla określonych operacji, których zamierzasz użyć.
Jak uzyskać poświadczenia
Możesz zalogować się przy użyciu dowolnego konta skonfigurowanego do uzyskiwania dostępu do usługi Cloud User Hub. W przypadku scenariuszy automatyzacji zalecamy użycie dedykowanego konta usługi.
Wprowadzenie do łącznika
Zacznij od pozycji Pobierz organizacje, aby pobrać listę organizacji, którymi możesz zarządzać (w tym własnym). Organizacje są zwracane zgodnie ze skonfigurowanymi zakresami ról w usłudze Cloud User Hub. Użyj identyfikatorów dla kolejnych wywołań. W przypadku operacji, które wymagały identyfikatora partnera, użyj identyfikatora z własnej organizacji. W przypadku niektórych operacji będziesz potrzebować identyfikatora dzierżawy zamiast wewnętrznego identyfikatora centrum użytkowników chmury lub obu tych operacji.
Znane problemy i ograniczenia
Niektóre operacje wymagają, aby organizacja docelowa miała zgodną licencję platformy Microsoft 365 i/lub aktywną subskrypcję platformy Azure. Na przykład: konfigurowanie dostępu warunkowego wymaga licencji Microsoft Entra ID Premium.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie ilości subskrypcji |
Zaktualizuj ilość subskrypcji. |
| Dodawanie członka do grupy |
Dodaj członka do grupy platformy Microsoft 365 lub grupy zabezpieczeń za pomocą właściwości nawigacji członków. |
| Dodawanie członka do grupy użytkowników |
Dodaj członka do grupy użytkowników, członek powinien należeć do tej samej organizacji co grupa. |
| Dodawanie zadania bloku poleceń dla grupy |
Dodaj zadanie bloku poleceń. Dostawca i walidacja akcji są oparte na określonym bloku poleceń. |
| Dodawanie zadania bloku poleceń dla organizacji |
Dodaj zadanie bloku poleceń. Dostawca i walidacja akcji są oparte na określonym bloku poleceń. |
| Dodawanie zadania bloku poleceń dla użytkownika |
Dodaj zadanie bloku poleceń. Dostawca i walidacja akcji są oparte na określonym bloku poleceń. |
| Lista bloków poleceń |
Pobierz listę dostępnych bloków poleceń. |
| Pobieranie grup użytkowników usługi Cloud User Hub |
Pobierz listę grup wszystkich organizacji, które masz uprawnienia do wyświetlania. |
| Pobieranie grup zabezpieczeń usługi Azure AD |
Pobierz listę grup zabezpieczeń usługi Azure AD wszystkich organizacji, które masz uprawnienia do wyświetlania. |
| Pobieranie jednostek SKU subskrybowanych przez organizację |
Pobierz listę subskrypcji komercyjnych, które uzyskała organizacja. |
| Pobieranie kategorii poleceń |
Pobierz wszystkie dostępne kategorie i podkategorie. |
| Pobieranie listy członków grupy użytkowników usługi Cloud User Hub |
Pobierz listę członków grupy użytkowników określonej grupy. |
| Pobieranie statystyk dotyczących zadań bloku poleceń dla wszystkich autoryzowanych organizacji |
Uzyskaj statystyki dotyczące zadań bloku poleceń dla bloków poleceń, które masz uprawnienia do wyświetlania. |
| Pobieranie subskrypcji |
Pobiera wszystkie subskrypcje dla klienta partnera według identyfikatora dzierżawy usługi Active Directory. |
| Pobieranie szczegółów bloku poleceń |
Uzyskaj szczegółowe informacje o bloku poleceń. Sprawdzanie poprawności dostawcy i akcji zależy od określonego bloku poleceń. |
| Pobieranie szczegółów licencji użytkownika |
Pobieranie listy obiektów szczegółów licencji dla użytkowników przedsiębiorstwa. |
| Pobieranie szczegółów użytkownika |
Pobierz użytkownika według identyfikatora obiektu firmy Microsoft. |
| Pobieranie użytkowników |
Pobieranie listy obiektów użytkownika. |
| Pobieranie zadań bloku poleceń dla wszystkich autoryzowanych organizacji |
Pobierz zadania bloku poleceń dla bloków poleceń, które masz uprawnienia do wyświetlania. |
| Pobieranie zadań bloku poleceń określonej organizacji |
Pobierz zadania bloku poleceń dla bloków poleceń, które masz uprawnienia do wyświetlania. |
| Przypisywanie licencji do użytkownika |
Dodawanie lub usuwanie licencji dla użytkownika. Możesz również włączyć i wyłączyć określone plany skojarzone z licencją. |
| Tworzenie grupy usługi Azure AD |
Utwórz grupę usługi Azure AD. |
| Usuwanie członka z grupy użytkowników |
Usuń członka do grupy użytkowników. |
| Usuwanie grupy użytkowników usługi Cloud User Hub |
Usuń grupę użytkowników. |
| Usuwanie użytkownika |
Usuń użytkownika. Po usunięciu zasoby użytkowników są przenoszone do kontenera tymczasowego i można je przywrócić w ciągu 30 dni. Po tym czasie zostaną one trwale usunięte. |
| Usuń element członkowski |
Usuń członka z grupy za pośrednictwem właściwości nawigacji członków. |
| Utwórz użytkownika |
Treść żądania zawiera użytkownika do utworzenia. Co najmniej należy określić wymagane właściwości dla użytkownika. Opcjonalnie można określić inne właściwości zapisywalne. |
| Uzyskiwanie organizacji |
Uzyskaj wszystkie organizacje, które masz uprawnienia do wyświetlania. |
| Uzyskiwanie szczegółów zadania pojedynczego użytkownika |
Uzyskiwanie szczegółów pojedynczego zadania użytkownika, dostawcy i walidacji akcji zależy od określonego bloku poleceń. |
| Uzyskiwanie ustawień regionalnych |
Pobierz ustawienia regionalne. |
| Wyświetlanie listy domen organizacji |
Pobieranie listy obiektów domeny. |
| Zmiana hasła przez użytkownika |
Zaktualizuj profil hasła użytkownika, aby zresetować swoje hasło. |
Aktualizowanie ilości subskrypcji
Zaktualizuj ilość subskrypcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator partnera centrum użytkowników w chmurze.
|
partnerId | True | string |
Identyfikator partnera centrum użytkowników w chmurze. |
|
Identyfikator klienta usługi Cloud User Hub.
|
customerId | True | string |
Identyfikator klienta usługi Cloud User Hub. |
|
Identyfikator dzierżawy firmy Microsoft klienta.
|
tenantId | True | string |
Identyfikator dzierżawy firmy Microsoft klienta. |
|
Identyfikator subsription.
|
subscriptionId | True | string |
Identyfikator subskrypcji klienta. |
|
Ilość
|
quantity | integer |
Ilość subskrypcji. |
Dodawanie członka do grupy
Dodaj członka do grupy platformy Microsoft 365 lub grupy zabezpieczeń za pomocą właściwości nawigacji członków.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft grupy.
|
microsoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft grupy. |
|
Członek
|
@odata.id | True | string |
Identyfikator URI katalogu, użytkownika, grupy lub obiektu kontaktu organizacyjnego do dodania. |
Dodawanie członka do grupy użytkowników
Dodaj członka do grupy użytkowników, członek powinien należeć do tej samej organizacji co grupa.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator grupy użytkowników usługi Cloud User Hub.
|
userGroupId | True | string |
Identyfikator grupy użytkowników usługi Cloud User Hub. |
|
Identyfikator użytkownika centrum użytkowników w chmurze.
|
userId | True | string |
Identyfikator użytkownika usługi Cloud User Hub. |
Dodawanie zadania bloku poleceń dla grupy
Dodaj zadanie bloku poleceń. Dostawca i walidacja akcji są oparte na określonym bloku poleceń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji
|
organizationId | True | string |
Format — uuid. Unikatowy identyfikator organizacji. |
|
Identyfikator bloku poleceń
|
commandBlockId | True | string |
Format — uuid. Unikatowy identyfikator bloku poleceń. |
|
Identyfikator grupy docelowej
|
targetGroupId | True | string |
Format — uuid. Unikatowy identyfikator grupy docelowej. |
|
Identyfikator techniczny
|
technicalIdentifier | string |
Identyfikator techniczny. |
|
|
Wartość
|
value | string |
Wartość. |
|
|
Identyfikator harmonogramu
|
scheduleId | string |
Identyfikator harmonogramu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | string |
Wartość. |
Dodawanie zadania bloku poleceń dla organizacji
Dodaj zadanie bloku poleceń. Dostawca i walidacja akcji są oparte na określonym bloku poleceń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji
|
organizationId | True | string |
Format — uuid. Unikatowy identyfikator organizacji. |
|
Identyfikator bloku poleceń
|
commandBlockId | True | string |
Format — uuid. Unikatowy identyfikator bloku poleceń. |
|
Identyfikator organizacji docelowej
|
targetOrganizationId | True | string |
Format — uuid. Unikatowy identyfikator organizacji docelowej. |
|
Identyfikator techniczny
|
technicalIdentifier | string |
Identyfikator techniczny |
|
|
Wartość
|
value | string |
Wartość. |
|
|
Identyfikator harmonogramu
|
scheduleId | string |
Identyfikator harmonogramu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | string |
Wartość. |
Dodawanie zadania bloku poleceń dla użytkownika
Dodaj zadanie bloku poleceń. Dostawca i walidacja akcji są oparte na określonym bloku poleceń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji
|
organizationId | True | string |
Format — uuid. Unikatowy identyfikator organizacji. |
|
Identyfikator bloku poleceń
|
commandBlockId | True | string |
Format — uuid. Unikatowy identyfikator bloku poleceń. |
|
Identyfikator użytkownika docelowego
|
targetUserId | True | string |
Format — uuid. Unikatowy identyfikator użytkownika docelowego. |
|
Identyfikator techniczny
|
technicalIdentifier | string |
Identyfikator techniczny. |
|
|
Wartość
|
value | string |
Wartość. |
|
|
Identyfikator harmonogramu
|
scheduleId | string |
Identyfikator harmonogramu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | string |
Wartość. |
Lista bloków poleceń
Pobierz listę dostępnych bloków poleceń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Elementy $top
|
$top | string |
Zwróć tylko pierwsze elementy $top. |
|
|
$skip elementów
|
$skip | string |
Liczba stron do pominięcia. |
|
|
Wybierz filtr
|
$select | string |
$select filtru odata. |
|
|
Zamów według
|
$orderby | string |
Określa, jakie wartości są używane do zamawiania kolekcji rekordów. |
|
|
Filter
|
$filter | string |
Funkcja, która musi mieć wartość true dla rekordu, który ma zostać zwrócony. |
|
|
Liczba
|
$count | string |
Określa, że nie należy uwzględniać liczby elementów w kolekcji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontekst OData
|
@odata.context | string |
Kontekst OData. |
|
Liczba danych OData
|
@odata.count | integer |
Liczba danych OData. |
|
Następny link OData
|
@odata.nextLink | string |
Następny link OData. |
|
value
|
value | array of object |
Wartość. |
|
Id
|
value.id | string |
Identyfikator. |
|
Identyfikator techniczny
|
value.technicalIdentifier | string |
Identyfikator techniczny. |
|
Typ
|
value.type | string |
Typ. |
|
wersja
|
value.version | integer |
Wersja. |
|
Identyfikator kategorii
|
value.categoryId | string |
Identyfikator kategorii. |
|
Wymagana akcja odczytu
|
value.requiredReadAction | string |
Wymagana akcja odczytu. |
|
Wymagana akcja zapisu
|
value.requiredWriteAction | string |
Wymagana akcja zapisu. |
|
Wymagany dostawca
|
value.requiredProvider | string |
Wymagany dostawca. |
|
Identyfikator kategorii menu
|
value.menuCategory.id | string |
Identyfikator kategorii menu. |
|
Identyfikator techniczny
|
value.menuCategory.technicalIdentifier | string |
Identyfikator techniczny. |
|
Identyfikator kategorii nadrzędnej
|
value.parentCategory.id | string |
Identyfikator kategorii nadrzędnej. |
|
Identyfikator techniczny
|
value.parentCategory.technicalIdentifier | string |
Identyfikator techniczny. |
|
Id
|
value.category.id | string |
Identyfikator kategorii. |
|
Identyfikator techniczny
|
value.category.technicalIdentifier | string |
Identyfikator techniczny. |
Pobieranie grup użytkowników usługi Cloud User Hub
Pobierz listę grup wszystkich organizacji, które masz uprawnienia do wyświetlania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Filtruj grupy.
|
$filter | True | string |
Filtruj według grup w organizacji. Użyj: organizationId w elemencie ('{organizationId}'). |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
@odata.count | integer |
Liczba danych OData. |
|
value
|
value | array of object |
Wartość. |
|
Identyfikator organizacji
|
value.organizationId | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Name
|
value.name | string |
Nazwa grupy. |
|
Description
|
value.description | string |
Opis grupy. |
|
Id
|
value.id | string |
Identyfikator grupy. |
|
Utworzono:
|
value.createdOn | string |
Utworzono w dniu. |
|
Data modyfikacji
|
value.modifiedOn | string |
Zmodyfikowano. |
Pobieranie grup zabezpieczeń usługi Azure AD
Pobierz listę grup zabezpieczeń usługi Azure AD wszystkich organizacji, które masz uprawnienia do wyświetlania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | array of object |
Wartość. |
|
Utworzono:
|
value.createdDateTime | string |
Utworzono w dniu. |
|
Nazwa wyświetlana
|
value.displayName | string |
Nazwa wyświetlana. |
|
groupTypes
|
value.groupTypes | array of string |
Typy grup. |
|
Id
|
value.id | string |
Identyfikator obiektu firmy Microsoft grupy. |
|
Włączone zabezpieczenia
|
value.securityEnabled | boolean |
Wskazuje, czy grupa jest włączona zabezpieczeń. |
|
Poczta
|
value.mail | string |
Adres e-mail grupy. |
Pobieranie jednostek SKU subskrybowanych przez organizację
Pobierz listę subskrypcji komercyjnych, które uzyskała organizacja.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | array of object |
Wartość. |
|
Stan możliwości
|
value.capabilityStatus | string |
Stan możliwości jednostki SKU firmy Microsoft. |
|
Zużyte jednostki
|
value.consumedUnits | integer |
Zużyte jednostki dla tej jednostki SKU. |
|
Id
|
value.id | string |
Identyfikator obiektu subskrybowanej jednostki SKU. |
|
Identyfikator jednostki SKU
|
value.skuId | string |
Identyfikator jednostki SKU licencji firmy Microsoft. |
|
Numer części sku
|
value.skuPartNumber | string |
Numer części sku licencji firmy Microsoft. |
|
Odnosi się do
|
value.appliesTo | string |
Dotyczy użytkownika lub organizacji. |
|
Włączona
|
value.prepaidUnits.enabled | integer |
Włączone subskrybowane jednostki SKU. |
|
Zawieszony
|
value.prepaidUnits.suspended | integer |
Wstrzymane subskrybowane jednostki SKU. |
|
Ostrzeżenie
|
value.prepaidUnits.warning | integer |
Subskrybowane jednostki SKU z ostrzeżeniem. |
|
servicePlans
|
value.servicePlans | array of object |
Plany usług. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identyfikator planu usługi. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nazwa planu usługi. |
|
provisioningStatus (stan aprowizacji)
|
value.servicePlans.provisioningStatus | string |
Stan aprowizacji. |
|
dotyczy
|
value.servicePlans.appliesTo | string |
Dotyczy. |
Pobieranie kategorii poleceń
Pobierz wszystkie dostępne kategorie i podkategorie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Elementy $top
|
$top | string |
Zwróć tylko pierwsze elementy $top. |
|
|
$skip elementów
|
$skip | string |
Liczba stron do pominięcia. |
|
|
Wybierz filtr
|
$select | string |
$select filtru odata. |
|
|
Zamów według
|
$orderby | string |
Określa, jakie wartości są używane do zamawiania kolekcji rekordów. |
|
|
Filter
|
$filter | string |
Funkcja, która musi mieć wartość true dla rekordu, który ma zostać zwrócony. |
|
|
Liczba
|
$count | string |
Określa pogodę lub nie uwzględnia liczby elementów w kolekcji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontekst OData
|
@odata.context | string |
Kontekst OData. |
|
Liczba danych OData
|
@odata.count | integer |
Liczba danych OData. |
|
Następny link OData
|
@odata.nextLink | string |
Następny link OData. |
|
value
|
value | array of object |
Wartość. |
|
Id
|
value.id | string |
Id. |
|
Identyfikator techniczny
|
value.technicalIdentifier | string |
Identyfikator techniczny. |
|
Identyfikator kategorii nadrzędnej
|
value.parentCategoryId | string |
Identyfikator kategorii nadrzędnej. |
Pobieranie listy członków grupy użytkowników usługi Cloud User Hub
Pobierz listę członków grupy użytkowników określonej grupy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator centrum użytkowników w chmurze grupy.
|
userGroupId | True | string |
Identyfikator centrum użytkowników w chmurze grupy. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
@odata.count | integer |
Liczba danych OData. |
|
value
|
value | array of object |
Wartość. |
|
Name
|
value.name | string |
Nazwa. |
|
Główna nazwa użytkownika
|
value.upn | string |
Główna nazwa użytkownika grupy. |
|
Id
|
value.id | string |
Identyfikator obiektu członkowskiego grupy. |
|
Identyfikator grupy
|
value.groupId | string |
Identyfikator centrum użytkowników w chmurze grupy. |
|
Utworzono:
|
value.createdOn | string |
Utworzono w dniu. |
|
Data modyfikacji
|
value.modifiedOn | string |
Zmodyfikowano. |
Pobieranie statystyk dotyczących zadań bloku poleceń dla wszystkich autoryzowanych organizacji
Uzyskaj statystyki dotyczące zadań bloku poleceń dla bloków poleceń, które masz uprawnienia do wyświetlania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kategorii
|
categoryId | True | string |
Format — uuid. Unikatowy identyfikator kategorii. |
|
Wybierz filtr
|
$select | string |
$select filtru odata. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontekst OData
|
@odata.context | string |
Kontekst OData. |
|
Typ
|
type | string |
Typ. |
|
Kategoria
|
category | string |
Kategoria. |
|
Okres
|
period | string |
Okres. |
|
Zakończone
|
completed | integer |
Zakończone. |
|
W kolejce
|
queued | integer |
Kolejce. |
|
Nie powiodło się
|
failed | integer |
Nie powiodło się. |
Pobieranie subskrypcji
Pobiera wszystkie subskrypcje dla klienta partnera według identyfikatora dzierżawy usługi Active Directory.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator partnera centrum użytkowników w chmurze.
|
partnerId | True | string |
Identyfikator partnera centrum użytkowników w chmurze. |
|
Identyfikator klienta usługi Cloud User Hub.
|
customerId | True | string |
Identyfikator klienta usługi Cloud User Hub. |
|
Identyfikator dzierżawy firmy Microsoft klienta.
|
tenantId | True | string |
Identyfikator dzierżawy firmy Microsoft klienta. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Łączna liczba
|
totalCount | integer |
Łączna liczba obiektów subskrypcji. |
|
items
|
items | array of object |
Elementy. |
|
Id
|
items.id | string |
Identyfikator subskrypcji. |
|
Identyfikator upoważnienia
|
items.entitlementId | string |
Identyfikator uprawnień subskrypcji. |
|
Przyjazna nazwa
|
items.friendlyName | string |
Przyjazna nazwa subskrypcji. |
|
Ilość
|
items.quantity | integer |
Ilość subskrypcji. |
|
Typ jednostki
|
items.unitType | string |
Typ jednostki subskrypcji. |
|
Utworzono:
|
items.creationDate | string |
Utworzono w dniu subskrypcji. |
|
Data rozpoczęcia obowiązywania
|
items.effectiveStartDate | string |
Data rozpoczęcia subskrypcji. |
|
Data zakończenia zobowiązania
|
items.commitmentEndDate | string |
Data zakończenia zobowiązania subskrypcji. |
|
Status
|
items.status | string |
Status subskrypcji. |
|
Automatyczne odnawianie
|
items.autoRenewEnabled | boolean |
Wskazuje, czy automatyczne odnawianie jest włączone dla subskrypcji. |
|
Typ rozliczania
|
items.billingType | string |
Typ rozliczeń subskrypcji. |
|
Typ kontraktu
|
items.contractType | string |
Typ kontraktu subskrypcji. |
|
Uri
|
items.links.offer.uri | string |
Identyfikator URI subskrypcji. |
|
Metoda
|
items.links.offer.method | string |
Metoda subskrypcji. |
|
headers
|
items.links.offer.headers | array of |
Nagłówki. |
|
Uri
|
items.links.self.uri | string |
Identyfikator URI subskrypcji. |
|
Metoda
|
items.links.self.method | string |
Metoda subskrypcji. |
|
headers
|
items.links.self.headers | array of |
Nagłówki. |
|
Identyfikator zamówienia
|
items.orderId | string |
Identyfikator zamówienia subskrypcji. |
|
Etag
|
items.attributes.etag | string |
Etag subskrypcji. |
|
Typ obiektu
|
items.attributes.objectType | string |
Typ obiektu subskrypcji. |
|
Typ obiektu
|
attributes.objectType | string |
Typ obiektu subskrypcji. |
Pobieranie szczegółów bloku poleceń
Uzyskaj szczegółowe informacje o bloku poleceń. Sprawdzanie poprawności dostawcy i akcji zależy od określonego bloku poleceń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bloku poleceń
|
commandBlockId | True | string |
Format — uuid. Unikatowy identyfikator bloku poleceń. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
wersja
|
version | integer |
Wersja. |
|
Identyfikator kategorii
|
categoryId | string |
Identyfikator kategorii. |
|
Identyfikator techniczny
|
technicalIdentifier | string |
Identyfikator techniczny. |
|
Wymagana akcja odczytu
|
requiredReadAction | string |
Wymagana akcja odczytu. |
|
Wymagana akcja zapisu
|
requiredWriteAction | string |
Wymagana akcja zapisu. |
|
Wymagany dostawca
|
requiredProvider | string |
Wymagany dostawca. |
|
Typ
|
type | string |
Typ. |
|
Id
|
category.id | string |
Id. |
|
Identyfikator techniczny
|
category.technicalIdentifier | string |
Identyfikator techniczny. |
|
Id
|
parentCategory.id | string |
Id. |
|
Identyfikator techniczny
|
parentCategory.technicalIdentifier | string |
Identyfikator techniczny. |
|
Id
|
menuCategory.id | string |
Id. |
|
Identyfikator techniczny
|
menuCategory.technicalIdentifier | string |
Identyfikator techniczny. |
|
Wybór wielokrotny
|
commandInput.multiSelection | string |
Wybór wielokrotny. |
|
layoutGroups
|
commandInput.layoutGroups | array of object |
Grupy układów. |
|
Identyfikator techniczny
|
commandInput.layoutGroups.technicalIdentifier | string |
Identyfikator techniczny. |
|
layoutGroupFormats
|
commandInput.layoutGroups.layoutGroupFormats | array of object |
Formaty grup układów. |
|
typ
|
commandInput.layoutGroups.layoutGroupFormats.type | string |
Typ. |
|
właściwość
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
Własność. |
|
properties
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
Właściwości. |
|
parameters
|
commandInput.parameters | array of object |
Parametry. |
|
Wartość domyślna
|
commandInput.parameters.defaultValue | string |
Wartość domyślna. |
|
Identyfikator techniczny
|
commandInput.parameters.technicalIdentifier | string |
Identyfikator techniczny. |
|
Schema
|
commandInput.parameters.schema | string |
Schemat. |
|
Czuły
|
commandInput.parameters.sensitive | boolean |
Czuły. |
|
Wymagane
|
commandInput.parameters.required | boolean |
To jest wymagane. |
|
Wartość
|
commandInput.parameters.value | string |
Wartość. |
|
Zestaw poleceń
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
Zestaw poleceń. |
|
Blok poleceń
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
Blok poleceń. |
|
linkedCommandBlocks
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Połączone bloki poleceń. |
|
technicalIdentifier
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Identyfikator techniczny. |
|
wersja
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Wersja. |
|
layoutGroups
|
commandOutput.layoutGroups | array of object |
Grupy układów. |
|
Identyfikator techniczny
|
commandOutput.layoutGroups.technicalIdentifier | string |
Identyfikator techniczny. |
|
layoutGroupFormats
|
commandOutput.layoutGroups.layoutGroupFormats | array of object |
Formaty grup układów. |
|
typ
|
commandOutput.layoutGroups.layoutGroupFormats.type | string |
Typ. |
|
właściwość
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
Własność. |
|
properties
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
Właściwości. |
|
parameters
|
commandOutput.parameters | array of object |
Parametry. |
|
Example
|
commandOutput.parameters.example | string |
Przykład. |
|
Identyfikator techniczny
|
commandOutput.parameters.technicalIdentifier | string |
Identyfikator techniczny. |
|
Schema
|
commandOutput.parameters.schema | string |
Schemat. |
|
Czuły
|
commandOutput.parameters.sensitive | boolean |
Czuły. |
|
Wymagane
|
commandOutput.parameters.required | boolean |
To jest wymagane. |
|
Wartość
|
commandOutput.parameters.value | string |
Wartość. |
|
Zestaw poleceń
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
Zestaw poleceń. |
|
Blok poleceń
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
Przecinek i blok. |
Pobieranie szczegółów licencji użytkownika
Pobieranie listy obiektów szczegółów licencji dla użytkowników przedsiębiorstwa.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft użytkownika.
|
microsoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft użytkownika. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | array of object |
Wartość. |
|
Id
|
value.id | string |
Identyfikator licencji użytkownika. |
|
Identyfikator jednostki SKU
|
value.skuId | string |
Identyfikator jednostki SKU licencji firmy Microsoft. |
|
Numer części sku
|
value.skuPartNumber | string |
Numer części sku licencji firmy Microsoft. |
|
servicePlans
|
value.servicePlans | array of object |
Plany usług. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identyfikator planu usługi. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nazwa planu usługi. |
|
provisioningStatus (stan aprowizacji)
|
value.servicePlans.provisioningStatus | string |
Stan aprowizacji. |
|
dotyczy
|
value.servicePlans.appliesTo | string |
Dotyczy. |
Pobieranie szczegółów użytkownika
Pobierz użytkownika według identyfikatora obiektu firmy Microsoft.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft użytkownika.
|
microsoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft użytkownika. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Włączone konto
|
accountEnabled | boolean |
Włączone konto ma wartość true lub false. |
|
Identyfikator pracownika
|
employeeId | string |
Identyfikator pracownika użytkownika. |
|
nazwa wyświetlana
|
displayName | string |
Nazwa wyświetlana użytkownika. |
|
Imię
|
givenName | string |
Podana nazwa użytkownika. |
|
Surname
|
surname | string |
Nazwisko użytkownika. |
|
Główna nazwa użytkownika
|
userPrincipalName | string |
Główna nazwa użytkownika. |
|
Stanowisko
|
jobTitle | string |
Stanowisko użytkownika. |
|
Dział
|
department | string |
Dział użytkownika. |
|
Nazwa firmy
|
companyName | string |
Nazwa firmy użytkownika. |
|
Lokalizacja użycia
|
usageLocation | string |
Lokalizacja użycia użytkownika. |
|
Adres ulicy
|
streetAddress | string |
Adres ulicy użytkownika. |
|
Miejscowość
|
city | string |
Miasto użytkownika. |
|
State
|
state | string |
Stan użytkownika. |
|
Kod pocztowy
|
postalCode | string |
Kod pocztowy użytkownika. |
|
Country
|
country | string |
Kraj użytkownika. |
Pobieranie użytkowników
Pobieranie listy obiektów użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Filtruj użytkowników.
|
$filter | True | string |
Filtruj użytkowników w organizacji. Użyj: organizationId w elemencie ('{organizationId}'). |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba danych OData
|
@odata.count | integer |
Liczba danych OData. |
|
value
|
value | array of object |
Wartość. |
|
Identyfikator organizacji
|
value.organizationId | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft
|
value.microsoftObjectIdentifier | string |
Identyfikator obiektu firmy Microsoft użytkownika. |
|
Główna nazwa użytkownika
|
value.upn | string |
Główna nazwa użytkownika. |
|
Imię
|
value.firstName | string |
Imię użytkownika. |
|
Nazwisko
|
value.lastName | string |
Nazwisko użytkownika. |
|
nazwa wyświetlana
|
value.displayName | string |
Nazwa wyświetlana użytkownika. |
|
Język
|
value.language | string |
Język użytkownika. |
|
Lokalizacja użycia
|
value.usageLocation | string |
Lokalizacja użycia użytkownika. |
|
Id
|
value.id | string |
Identyfikator usługi Cloud User Hub użytkownika. |
|
Utworzono
|
value.createdOn | string |
Utworzono pozycję Włączone. |
|
Data modyfikacji
|
value.modifiedOn | string |
Zmodyfikowano. |
Pobieranie zadań bloku poleceń dla wszystkich autoryzowanych organizacji
Pobierz zadania bloku poleceń dla bloków poleceń, które masz uprawnienia do wyświetlania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Elementy $top
|
$top | string |
Zwróć tylko pierwsze elementy $top. |
|
|
$skip elementów
|
$skip | string |
Liczba stron do pominięcia. |
|
|
Wybierz filtr
|
$select | string |
$select filtru odata. |
|
|
Zamów według
|
$orderby | string |
Określa, jakie wartości są używane do zamawiania kolekcji rekordów. |
|
|
Filter
|
$filter | string |
Funkcja, która musi mieć wartość true dla rekordu, który ma zostać zwrócony. |
|
|
Liczba
|
$count | string |
Określa, czy liczba elementów powinna być uwzględniona w kolekcji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontekst OData
|
@odata.context | string |
Kontekst OData. |
|
Liczba danych OData
|
@odata.count | integer |
Liczba danych OData. |
|
Następny link OData
|
@odata.nextLink | string |
Następny link OData |
|
value
|
value | array of object |
Wartość. |
|
Id
|
value.id | string |
Identyfikator. |
|
Identyfikator bloku poleceń
|
value.commandBlockId | string |
Identyfikator bloku poleceń. |
|
Nazwa zestawu poleceń
|
value.commandSetName | string |
Nazwa zestawu poleceń. |
|
Identyfikator zestawu poleceń
|
value.commandSetId | string |
Identyfikator zestawu poleceń |
|
Identyfikator bloku zestawu poleceń
|
value.commandSetBlockId | string |
Ustaw identyfikator bloku polecenia. |
|
Identyfikator użytkownika
|
value.userId | string |
Identyfikator użytkownika. |
|
Główna nazwa użytkownika
|
value.userUpn | string |
Główna nazwa użytkownika. |
|
Identyfikator grupy
|
value.groupId | string |
Identyfikator grupy. |
|
Nazwa grupy
|
value.groupName | string |
Nazwa grupy. |
|
Identyfikator organizacji
|
value.organizationId | string |
Identyfikator organizacji. |
|
Nazwa organizacji
|
value.organizationName | string |
Nazwa organizacji. |
|
Nazwa upn użytkownika aktora
|
value.actorUserUpn | string |
Główna nazwa użytkownika aktora. |
|
Identyfikator organizacji aktora
|
value.actorOrganizationId | string |
Identyfikator organizacji aktora. |
|
Nazwa organizacji aktora
|
value.actorOrganizationName | string |
Nazwa organizacji aktora. |
|
Status
|
value.status | string |
Stan. |
|
Wykonane w dniu
|
value.executedOn | string |
Wykonane. |
|
Identyfikator techniczny bloku poleceń
|
value.commandBlockTechnicalIdentifier | string |
Identyfikator techniczny bloku poleceń. |
|
Wersja bloku poleceń
|
value.commandBlockVersion | integer |
Wersja bloku poleceń. |
|
Planowane wykonanie
|
value.plannedExecution | string |
Planowane wykonanie. |
|
Identyfikator harmonogramu
|
value.scheduleId | string |
Identyfikator harmonogramu. |
|
Nazwa harmonogramu
|
value.scheduleName | string |
Nazwa harmonogramu. |
Pobieranie zadań bloku poleceń określonej organizacji
Pobierz zadania bloku poleceń dla bloków poleceń, które masz uprawnienia do wyświetlania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji.
|
organizationId | True | string |
Format — uuid. Unikatowy identyfikator organizacji. |
|
Elementy $top
|
$top | string |
Zwróć tylko pierwsze elementy $top. |
|
|
$skip elementów
|
$skip | string |
Liczba stron do pominięcia. |
|
|
Wybierz filtr
|
$select | string |
$select filtru odata. |
|
|
Zamów według
|
$orderby | string |
Określa, jakie wartości są używane do zamawiania kolekcji rekordów. |
|
|
Filter
|
$filter | string |
Funkcja, która musi mieć wartość true dla rekordu, który ma zostać zwrócony. |
|
|
Liczba
|
$count | string |
Określa pogodę lub nie uwzględnia liczby elementów w kolekcji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontekst OData
|
@odata.context | string |
Kontekst OData. |
|
Liczba danych OData
|
@odata.count | integer |
Liczba danych OData. |
|
OData nextlink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Wartość. |
|
Id
|
value.id | string |
Id. |
|
Identyfikator bloku poleceń
|
value.commandBlockId | string |
Identyfikator bloku poleceń. |
|
Nazwa zestawu poleceń
|
value.commandSetName | string |
Nazwa zestawu poleceń. |
|
Identyfikator zestawu poleceń
|
value.commandSetId | string |
Identyfikator zestawu poleceń. |
|
Identyfikator bloku zestawu poleceń
|
value.commandSetBlockId | string |
Ustaw identyfikator bloku polecenia. |
|
Identyfikator użytkownika
|
value.userId | string |
Identyfikator użytkownika. |
|
Nazwa upn użytkownika
|
value.userUpn | string |
Główna nazwa użytkownika. |
|
Identyfikator grupy
|
value.groupId | string |
Identyfikator grupy. |
|
Nazwa grupy
|
value.groupName | string |
Nazwa grupy. |
|
Identyfikator organizacji
|
value.organizationId | string |
Identyfikator organizacji. |
|
Nazwa organizacji
|
value.organizationName | string |
Nazwa organizacji. |
|
Główna nazwa użytkownika aktora
|
value.actorUserUpn | string |
Główna nazwa użytkownika aktora. |
|
Identyfikator organizacji aktora
|
value.actorOrganizationId | string |
Identyfikator organizacji aktora. |
|
Nazwa organizacji aktora
|
value.actorOrganizationName | string |
Nazwa organizacji aktora. |
|
Status
|
value.status | string |
Stan. |
|
Wykonane w dniu
|
value.executedOn | string |
Wykonane. |
|
Identyfikator techniczny bloku poleceń
|
value.commandBlockTechnicalIdentifier | string |
Identyfikator techniczny bloku poleceń. |
|
Wersja bloku poleceń
|
value.commandBlockVersion | integer |
Wersja bloku poleceń. |
|
Planowane wykonanie
|
value.plannedExecution | string |
Planowane wykonanie. |
|
Identyfikator harmonogramu
|
value.scheduleId | string |
Identyfikator harmonogramu. |
|
Nazwa harmonogramu
|
value.scheduleName | string |
Nazwa harmonogramu. |
Przypisywanie licencji do użytkownika
Dodawanie lub usuwanie licencji dla użytkownika. Możesz również włączyć i wyłączyć określone plany skojarzone z licencją.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft użytkownika.
|
microsoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft użytkownika. |
|
disabledPlans
|
disabledPlans | array of |
Wyłączone plany. |
|
|
Identyfikator jednostki SKU
|
skuId | string |
Identyfikator jednostki SKU licencji firmy Microsoft. |
|
|
Usuń licencje
|
removeLicenses | array of |
Kolekcja identyfikatorów GUID identyfikujących licencje do usunięcia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | array of object |
Wartość. |
|
Id
|
value.id | string |
Identyfikator obiektu licencji. |
|
Identyfikator jednostki SKU
|
value.skuId | string |
Identyfikator jednostki SKU firmy Microsoft. |
|
Numer części sku
|
value.skuPartNumber | string |
Numer części sku firmy Microsoft. |
|
servicePlans
|
value.servicePlans | array of object |
Plany usług. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identyfikator planu usługi. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nazwa planu usługi. |
|
provisioningStatus (stan aprowizacji)
|
value.servicePlans.provisioningStatus | string |
Stan aprowizacji. |
|
dotyczy
|
value.servicePlans.appliesTo | string |
Dotyczy. |
Tworzenie grupy usługi Azure AD
Utwórz grupę usługi Azure AD.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Description
|
description | string |
Opis grupy. |
|
|
nazwa wyświetlana
|
displayName | string |
Nazwa wyświetlana grupy. |
|
|
groupTypes
|
groupTypes | array of string |
Typy grup. |
|
|
Włączono pocztę
|
mailEnabled | boolean |
Wskazuje, czy grupa jest włączona. |
|
|
Pseudonim poczty
|
mailNickname | string |
Pseudonim poczty grupy. |
|
|
Włączone zabezpieczenia
|
securityEnabled | boolean |
Wskazuje, czy grupa jest włączona zabezpieczeń. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Identyfikator grupy. |
|
Usunięto
|
deletedDateTime | string |
Usunięto. |
|
Classification
|
classification | string |
Klasyfikacja grupy. |
|
Utworzono:
|
createdDateTime | string |
Utworzono w dniu. |
|
creationOptions
|
creationOptions | array of string |
Opcje tworzenia. |
|
Description
|
description | string |
Description. |
|
nazwa wyświetlana
|
displayName | string |
Nazwa wyświetlana. |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
Poczta
|
string |
Adres e-mail grupy. |
|
|
Włączono pocztę
|
mailEnabled | boolean |
Wskazuje, że grupa jest włączona. |
|
Pseudonim poczty
|
mailNickname | string |
Pseudonim poczty grupy. |
|
Ostatnia synchronizacja lokalna
|
onPremisesLastSyncDateTime | string |
Wskazuje, kiedy grupa została zsynchronizowana ze środowiskiem lokalnym. |
|
Identyfikator zabezpieczeń lokalnych
|
onPremisesSecurityIdentifier | string |
Lokalny identyfikator zabezpieczeń grupy. |
|
Włączono synchronizację lokalną
|
onPremisesSyncEnabled | string |
Wskazuje, czy synchronizacja lokalna jest włączona. |
|
Preferowana lokalizacja danych
|
preferredDataLocation | string |
Preferowana lokalizacja danych grupy. |
|
proxyAddresses
|
proxyAddresses | array of string |
Adresy serwera proxy. |
|
Odnowiona
|
renewedDateTime | string |
Odnowiona data i godzina grupy. |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
Opcje zachowania zasobów. |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
Opcje prowokowania zasobów. |
|
Włączone zabezpieczenia
|
securityEnabled | boolean |
Wskazuje, czy grupa jest włączona zabezpieczeń. |
|
Visbility
|
visibility | string |
Widoczność grupy. |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
Lokalne błędy aprowizacji. |
Usuwanie członka z grupy użytkowników
Usuń członka do grupy użytkowników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator grupy użytkowników usługi Cloud User Hub.
|
userGroupId | True | string |
Identyfikator grupy użytkowników usługi Cloud User Hub. |
|
Identyfikator użytkownika centrum użytkowników w chmurze.
|
userId | True | string |
Identyfikator użytkownika usługi Cloud User Hub. |
Usuwanie grupy użytkowników usługi Cloud User Hub
Usuń grupę użytkowników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator centrum użytkowników w chmurze dla grupy użytkowników.
|
userGroupId | True | string |
Identyfikator centrum użytkowników w chmurze dla grupy użytkowników. |
Usuwanie użytkownika
Usuń użytkownika. Po usunięciu zasoby użytkowników są przenoszone do kontenera tymczasowego i można je przywrócić w ciągu 30 dni. Po tym czasie zostaną one trwale usunięte.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft użytkownika.
|
microsoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft użytkownika. |
Usuń element członkowski
Usuń członka z grupy za pośrednictwem właściwości nawigacji członków.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft grupy.
|
groupMicrosoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft grupy. |
|
Identyfikator obiektu firmy Microsoft użytkownika.
|
userMicrosoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft użytkownika. |
Utwórz użytkownika
Treść żądania zawiera użytkownika do utworzenia. Co najmniej należy określić wymagane właściwości dla użytkownika. Opcjonalnie można określić inne właściwości zapisywalne.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Włączone konto
|
accountEnabled | boolean |
Włączone konto ma wartość true lub false. |
|
|
nazwa wyświetlana
|
displayName | string |
Nazwa wyświetlana użytkownika. |
|
|
Pseudonim poczty
|
mailNickname | string |
Pseudonim e-mail użytkownika. |
|
|
Główna nazwa użytkownika
|
userPrincipalName | string |
Główna nazwa użytkownika. |
|
|
Wymuś zmianę hasła podczas następnego logowania
|
forceChangePasswordNextSignIn | boolean |
Wymuś zmianę hasła podczas następnego logowania. |
|
|
Hasło
|
password | string |
Nowe hasło użytkownika. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontekst OData
|
@odata.context | string |
Kontekst OData. |
|
Id
|
id | string |
Identyfikator centrum użytkowników w chmurze. |
|
telefony biznesowe
|
businessPhones | array of string |
Telefony służbowe użytkownika. |
|
nazwa wyświetlana
|
displayName | string |
Nazwa wyświetlana użytkownika. |
|
Imię
|
givenName | string |
Imię. |
|
Stanowisko
|
jobTitle | string |
Stanowisko użytkownika. |
|
Poczta
|
string |
Adres e-mail użytkownika. |
|
|
Telefon komórkowy
|
mobilePhone | string |
Numer telefonu komórkowego użytkownika. |
|
Lokalizacja pakietu Office
|
officeLocation | string |
Lokalizacja pakietu Office użytkownika. |
|
Preferowany język
|
preferredLanguage | string |
Preferowany język skonfigurowany w usłudze Azure AD. |
|
Surname
|
surname | string |
Nazwisko użytkownika. |
|
Główna nazwa użytkownika
|
userPrincipalName | string |
Główna nazwa użytkownika. |
Uzyskiwanie organizacji
Uzyskaj wszystkie organizacje, które masz uprawnienia do wyświetlania.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba danych OData
|
@odata.count | integer |
Liczba danych OData. |
|
value
|
value | array of object |
Wartość. |
|
Name
|
value.name | string |
Nazwa organizacji usługi Azure AD. |
|
Identyfikator dzierżawy firmy Microsoft
|
value.microsoftTenantId | string |
Identyfikator dzierżawy firmy Microsoft organizacji. |
|
Utworzono:
|
value.createdOn | string |
Utworzono w dniu. |
|
Data modyfikacji
|
value.modifiedOn | string |
Zmodyfikowano. |
|
Id
|
value.id | string |
Identyfikator centrum użytkowników w chmurze. |
Uzyskiwanie szczegółów zadania pojedynczego użytkownika
Uzyskiwanie szczegółów pojedynczego zadania użytkownika, dostawcy i walidacji akcji zależy od określonego bloku poleceń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji
|
organizationId | True | string |
Format — uuid. Unikatowy identyfikator organizacji. |
|
Identyfikator bloku poleceń
|
commandBlockId | True | string |
Format — uuid. Unikatowy identyfikator bloku poleceń. |
|
Identyfikator zadania
|
jobId | True | string |
Format — uuid. Unikatowy identyfikator zadania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Id. |
|
Identyfikator bloku poleceń
|
commandBlockId | string |
Identyfikator bloku poleceń. |
|
Nazwa zestawu poleceń
|
commandSetName | string |
Nazwa zestawu poleceń. |
|
Identyfikator zestawu poleceń
|
commandSetId | string |
Identyfikator zestawu poleceń. |
|
Identyfikator bloku zestawu poleceń
|
commandSetBlockId | string |
Ustaw identyfikator bloku polecenia. |
|
Identyfikator użytkownika
|
userId | string |
Identyfikator użytkownika. |
|
Nazwa upn użytkownika
|
userUpn | string |
Główna nazwa użytkownika. |
|
Identyfikator grupy
|
groupId | string |
Identyfikator grupy. |
|
Nazwa grupy
|
groupName | string |
Nazwa grupy. |
|
Identyfikator organizacji
|
organizationId | string |
Identyfikator organizacji. |
|
Nazwa organizacji
|
organizationName | string |
Nazwa organizacji. |
|
Aktor upn
|
actorUserUpn | string |
Główna nazwa użytkownika aktora. |
|
Identyfikator organizacji aktora
|
actorOrganizationId | string |
Identyfikator organizacji aktora. |
|
Nazwa organizacji aktora
|
actorOrganizationName | string |
Nazwa organizacji aktora. |
|
Status
|
status | string |
Stan. |
|
Wykonane w dniu
|
executedOn | string |
Wykonane. |
|
Identyfikator techniczny bloku poleceń
|
commandBlockTechnicalIdentifier | string |
Identyfikator techniczny bloku poleceń. |
|
Wersja bloku poleceń
|
commandBlockVersion | integer |
Wersja bloku poleceń. |
|
layoutGroups
|
output.body.layoutGroups | array of object |
Formaty grup układów. |
|
layoutGroupFormats
|
output.body.layoutGroups.layoutGroupFormats | array of object |
Formaty grup układów. |
|
typ
|
output.body.layoutGroups.layoutGroupFormats.type | string |
Typ. |
|
właściwość
|
output.body.layoutGroups.layoutGroupFormats.property | string |
Własność. |
|
properties
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
Właściwości. |
|
parameters
|
output.body.parameters | array of object |
Parametry. |
|
Identyfikator techniczny
|
output.body.parameters.technicalIdentifier | string |
Identyfikator techniczny. |
|
Wartość
|
output.body.parameters.value | string |
Wartość. |
|
Schema
|
output.body.parameters.schema | string |
Schemat. |
|
Zestaw poleceń
|
output.body.parameters.placeholderEnabled.commandSet | boolean |
Zestaw poleceń. |
|
Blok poleceń
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
Blok poleceń. |
|
Kod błędu
|
output.errorCode | string |
Kod błędu. |
|
Powodzenie
|
output.isSuccess | boolean |
Udany. |
|
layoutGroups
|
input.layoutGroups | array of object |
Grupy układów. |
|
layoutGroupFormats
|
input.layoutGroups.layoutGroupFormats | array of object |
Formaty grup układów. |
|
typ
|
input.layoutGroups.layoutGroupFormats.type | string |
Typ. |
|
właściwość
|
input.layoutGroups.layoutGroupFormats.property | string |
Własność. |
|
properties
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
Właściwości. |
|
Wiele organizacji
|
input.multiSelection.multipleOrganizations | boolean |
Wiele organizacji. |
|
Wielu użytkowników
|
input.multiSelection.multipleUsers | boolean |
Wielu użytkowników. |
|
parameters
|
input.parameters | array of object |
Parametry. |
|
Identyfikator techniczny
|
input.parameters.technicalIdentifier | string |
Identyfikator techniczny. |
|
Wartość
|
input.parameters.value | string |
Wartość. |
|
Wartość domyślna
|
input.parameters.defaultValue | string |
Wartość domyślna. |
|
Typ
|
input.parameters.schema.type | string |
Typ. |
|
Format
|
input.parameters.schema.format | string |
Format. |
|
Wzór
|
input.parameters.schema.pattern | string |
Deseń. |
|
Minimalna długość
|
input.parameters.schema.minLength | string |
Minimalna długość. |
|
Zestaw poleceń
|
input.parameters.placeholderEnabled.commandSet | boolean |
Zestaw poleceń. |
|
Blok poleceń
|
input.parameters.placeholderEnabled.commandBlock | boolean |
Blok poleceń. |
|
linkedCommandBlocks
|
input.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Połączone bloki poleceń. |
|
technicalIdentifier
|
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Identyfikator techniczny. |
|
wersja
|
input.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Wersja. |
Uzyskiwanie ustawień regionalnych
Pobierz ustawienia regionalne.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontekst OData
|
@odata.context | string |
Kontekst OData. |
|
Liczba
|
@odata.count | integer |
Liczba danych OData. |
|
OData nextLink
|
@odata.nextLink | string |
OData nextlink. |
|
value
|
value | array of object |
Wartość. |
|
Id
|
value.id | string |
Identyfikator ustawień regionalnych. |
|
Kod ustawień regionalnych
|
value.localeCode | string |
Kody języków ISO-639. |
|
Kod kraju
|
value.countryCode | string |
Kody krajów ISO-3166. |
|
Nazwa kraju
|
value.countryName | string |
Nazwa kraju. |
Wyświetlanie listy domen organizacji
Pobieranie listy obiektów domeny.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | array of object |
Wartość. |
|
Typ uwierzytelniania
|
value.authenticationType | string |
Typ uwierzytelniania domeny. |
|
Stan dostępności
|
value.availabilityStatus | string |
Stan dostępności domeny. |
|
Id
|
value.id | string |
Identyfikator domeny. |
|
Zarządzane przez administratora
|
value.isAdminManaged | boolean |
Wskazuje, czy domena jest zarządzana przez administratora. |
|
Default
|
value.isDefault | boolean |
Wskazuje, czy jest to domena domyślna. |
|
Inicjał
|
value.isInitial | boolean |
Wskazuje, czy jest to domena początkowa. |
|
Korzeń
|
value.isRoot | boolean |
Wskazuje, czy jest to domena główna. |
|
Sprawdzonych
|
value.isVerified | boolean |
Wskazuje, czy domena jest zweryfikowana. |
|
supportedServices
|
value.supportedServices | array of string |
Obsługiwane usługi. |
|
Ważność hasła
|
value.passwordValidityPeriodInDays | integer |
Wskazuje ważność hasła w dniach. |
|
Okna powiadomień o hasłach
|
value.passwordNotificationWindowInDays | integer |
Wskazuje okno notifcation haseł w dniach. |
|
State
|
value.state | string |
Stan domeny. |
Zmiana hasła przez użytkownika
Zaktualizuj profil hasła użytkownika, aby zresetować swoje hasło.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator organizacji usługi Cloud User Hub.
|
organizationId | True | string |
Identyfikator organizacji usługi Cloud User Hub. |
|
Identyfikator obiektu firmy Microsoft użytkownika.
|
microsoftObjectId | True | string |
Identyfikator obiektu firmy Microsoft użytkownika. |
|
Wymuś zmianę hasła podczas logowania
|
forceChangePasswordNextSignIn | boolean |
Wymuś zmianę hasła przez użytkownika podczas następnego logowania. |
|
|
Hasło
|
password | string |
Nowe hasło do ustawienia. |