Sdílet prostřednictvím


N-able Cloud User Hub (Preview)

Cloudové uživatelské centrum je jednotný portál Microsoft CSP, který umožňuje automatizovat běžné úlohy ve všech aplikacích Microsoftu 365 bez přepínání konzol nebo zákazníků.

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure Government
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Premium Všechny oblasti Power Apps s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Power Automate Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Kontakt
Název Podpora cloudového uživatelského centra
URL https://documentation.clouduserhub.management/kb/en
Email technicalsupport@n-able.com
Metadata konektoru
Vydavatel N-able Cloud User Hub B.V.
Internetová stránka https://www.n-able.com
Zásady ochrany osobních údajů https://www.n-able.com/legal/privacy
Kategorie správa podniku, provoz IT

Cloudové uživatelské centrum je jednotný portál Microsoft CSP, který umožňuje automatizovat běžné úlohy ve všech aplikacích Microsoftu 365 bez přepínání konzol nebo zákazníků.

Požadavky

Abyste mohli pokračovat, budete potřebovat následující:

  • Předplatné cloudového uživatelského centra
  • Nakonfigurovaná řešení v cloudovém uživatelském centru pro konkrétní operace, které chcete použít
  • Konfigurované role v Cloudovém uživatelském centru pro konkrétní operace, které chcete použít .

Jak získat přihlašovací údaje

Můžete se přihlásit pomocí libovolného účtu, který je nakonfigurovaný pro přístup ke cloudovému uživatelskému centru. Pro scénáře automatizace doporučujeme použít vyhrazený účet služby.

Začínáme s konektorem

Začněte se získáním organizací a získejte seznam organizací, které můžete spravovat (včetně vlastních). Organizace se vrátí podle nakonfigurovaných oborů rolí v cloudovém uživatelském centru. Id použijte pro po sobě jdoucí volání. Pro operace, které vyžadovaly ID partnera, použijte ID z vaší vlastní organizace. U některých operací budete místo interního ID cloudového centra uživatelů nebo obojí vyžadovat ID tenanta.

Známé problémy a omezení

Některé operace vyžadují, aby cílová organizace měla odpovídající licenci Microsoftu 365 nebo aktivní předplatné Azure. Například: Konfigurace podmíněného přístupu vyžaduje licenci Microsoft Entra ID Premium.

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 100 60 sekund

Akce

Aktualizace množství předplatného

Aktualizujte množství předplatného.

Odebrat člena

Odeberte člena ze skupiny prostřednictvím navigační vlastnosti členů.

Odebrání člena ze skupiny uživatelů

Odeberte člena do skupiny uživatelů.

Odstranit uživatele

Odstranění uživatele Po odstranění se uživatelské prostředky přesunou do dočasného kontejneru a dají se obnovit do 30 dnů. Po uplynutí této doby se trvale odstraní.

Odstranění skupiny uživatelů cloudového uživatelského centra

Odstraňte skupinu uživatelů.

Přidání úlohy bloku příkazů pro organizaci

Přidejte úlohu bloku příkazů. Zprostředkovatel a ověření akce je založené na konkrétním bloku příkazů.

Přidání úlohy bloku příkazů pro skupinu

Přidejte úlohu bloku příkazů. Zprostředkovatel a ověření akce je založené na konkrétním bloku příkazů.

Přidání úlohy bloku příkazů pro uživatele

Přidejte úlohu bloku příkazů. Zprostředkovatel a ověření akce je založené na konkrétním bloku příkazů.

Přidání člena do skupiny

Přidejte člena do skupiny Microsoftu 365 nebo skupiny zabezpečení prostřednictvím navigační vlastnosti členů.

Přidání člena do skupiny uživatelů

Přidejte člena do skupiny uživatelů, člen by měl patřit do stejné organizace jako skupina.

Přiřazení licence uživateli

Přidejte nebo odeberte licence pro uživatele. Můžete také povolit a zakázat konkrétní plány přidružené k licenci.

Vytvoření skupiny Azure AD

Vytvořte skupinu Azure AD.

Vytvoření uživatele

Text požadavku obsahuje uživatele, který se má vytvořit. Minimálně je nutné zadat požadované vlastnosti uživatele. Volitelně můžete zadat jakékoli další zapisovatelné vlastnosti.

Výpis bloků příkazů

Načte seznam dostupných bloků příkazů.

Výpis domén organizace

Načte seznam objektů domény.

Změna hesla uživatele

Aktualizujte profil hesla uživatele, aby si resetovali heslo.

Získání kategorií příkazů

Získejte všechny dostupné kategorie a podkategorie.

Získání národních prostředí

Získejte národní prostředí.

Získání organizací

Získejte všechny organizace, které máte oprávnění k zobrazení.

Získání podrobností o bloku příkazů

Získejte podrobnosti o bloku příkazů. Ověření zprostředkovatele a akce závisí na konkrétním bloku příkazů.

Získání podrobností o uživateli

Získejte uživatele podle identifikátoru objektu Microsoftu.

Získání podrobností o uživatelské licenci

Načtěte seznam objektů podrobností o licencích pro podnikové uživatele.

Získání podrobností o úloze jednoho uživatele

Získání podrobností o jedné úloze uživatele, poskytovateli a ověření akce závisí na konkrétním bloku příkazu.

Získání předplacených skladových položek organizace

Získejte seznam komerčních předplatných, která organizace získala.

Získání předplatných

Načte všechna předplatná pro zákazníka partnera pomocí identifikátoru tenanta služby Active Directory.

Získání seznamu členů skupiny uživatelů cloudového uživatelského centra

Získejte seznam členů skupiny uživatelů konkrétní skupiny.

Získání skupin uživatelů v Cloudovém uživatelském centru

Získejte seznam skupin všech organizací, které máte oprávnění k zobrazení.

Získání skupin zabezpečení Azure AD

Získejte seznam skupin zabezpečení Azure AD všech organizací, které máte oprávnění k zobrazení.

Získání statistik o úlohách bloku příkazů pro všechny autorizované organizace

Získejte statistiky úloh bloku příkazů pro bloky příkazů, které máte oprávnění k zobrazení.

Získání uživatelů

Načte seznam uživatelských objektů.

Získání úloh bloku příkazů konkrétní organizace

Získejte úlohy bloku příkazů pro bloky příkazů, které máte oprávnění k zobrazení.

Získání úloh bloku příkazů pro všechny autorizované organizace

Získejte úlohy bloku příkazů pro bloky příkazů, které máte oprávnění k zobrazení.

Aktualizace množství předplatného

Aktualizujte množství předplatného.

Parametry

Name Klíč Vyžadováno Typ Description
ID partnera v cloudovém uživatelském centru
partnerId True string

Identifikátor partnera cloudového uživatelského centra.

ID zákazníka v Cloudovém uživatelském centru
customerId True string

Identifikátor zákazníka v Cloudovém uživatelském centru

ID tenanta Microsoftu zákazníka
tenantId True string

Identifikátor tenanta Microsoftu zákazníka.

ID odběru.
subscriptionId True string

Identifikátor předplatného zákazníka.

Množství
quantity integer

Množství předplatného.

Odebrat člena

Odeberte člena ze skupiny prostřednictvím navigační vlastnosti členů.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID objektu microsoftu skupiny.
groupMicrosoftObjectId True string

Identifikátor objektu společnosti Microsoft skupiny.

ID objektu microsoftu uživatele.
userMicrosoftObjectId True string

Identifikátor objektu microsoftu uživatele.

Odebrání člena ze skupiny uživatelů

Odeberte člena do skupiny uživatelů.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID skupiny uživatelů v cloudovém uživatelském centru
userGroupId True string

Identifikátor skupiny uživatelů v cloudovém uživatelském centru

ID uživatele v cloudovém uživatelském centru
userId True string

Identifikátor uživatele cloudového uživatelského centra.

Odstranit uživatele

Odstranění uživatele Po odstranění se uživatelské prostředky přesunou do dočasného kontejneru a dají se obnovit do 30 dnů. Po uplynutí této doby se trvale odstraní.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID objektu microsoftu uživatele.
microsoftObjectId True string

Identifikátor objektu microsoftu uživatele.

Odstranění skupiny uživatelů cloudového uživatelského centra

Odstraňte skupinu uživatelů.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

Identifikátor cloudového uživatelského centra pro skupinu uživatelů
userGroupId True string

Identifikátor cloudového uživatelského centra pro skupinu uživatelů

Přidání úlohy bloku příkazů pro organizaci

Přidejte úlohu bloku příkazů. Zprostředkovatel a ověření akce je založené na konkrétním bloku příkazů.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace
organizationId True string

Formát – uuid. Jedinečný identifikátor organizace.

ID bloku příkazu
commandBlockId True string

Formát – uuid. Jedinečný identifikátor bloku příkazů.

ID cílové organizace
targetOrganizationId True string

Formát – uuid. Jedinečný identifikátor cílové organizace

Technické ID
technicalIdentifier string

Technický identifikátor

Hodnota
value string

Hodnota.

ID plánu
scheduleId string

Identifikátor plánu

Návraty

Name Cesta Typ Description
Hodnota
value string

Hodnota.

Přidání úlohy bloku příkazů pro skupinu

Přidejte úlohu bloku příkazů. Zprostředkovatel a ověření akce je založené na konkrétním bloku příkazů.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace
organizationId True string

Formát – uuid. Jedinečný identifikátor organizace.

ID bloku příkazu
commandBlockId True string

Formát – uuid. Jedinečný identifikátor bloku příkazů.

ID cílové skupiny
targetGroupId True string

Formát – uuid. Jedinečný identifikátor cílové skupiny.

Technické ID
technicalIdentifier string

Technický identifikátor.

Hodnota
value string

Hodnota.

ID plánu
scheduleId string

Identifikátor plánu

Návraty

Name Cesta Typ Description
Hodnota
value string

Hodnota.

Přidání úlohy bloku příkazů pro uživatele

Přidejte úlohu bloku příkazů. Zprostředkovatel a ověření akce je založené na konkrétním bloku příkazů.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace
organizationId True string

Formát – uuid. Jedinečný identifikátor organizace.

ID bloku příkazu
commandBlockId True string

Formát – uuid. Jedinečný identifikátor bloku příkazů.

ID cílového uživatele
targetUserId True string

Formát – uuid. Jedinečný identifikátor cílového uživatele

Technické ID
technicalIdentifier string

Technický identifikátor.

Hodnota
value string

Hodnota.

ID plánu
scheduleId string

Identifikátor plánu

Návraty

Name Cesta Typ Description
Hodnota
value string

Hodnota.

Přidání člena do skupiny

Přidejte člena do skupiny Microsoftu 365 nebo skupiny zabezpečení prostřednictvím navigační vlastnosti členů.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID objektu microsoftu skupiny.
microsoftObjectId True string

Identifikátor objektu společnosti Microsoft skupiny.

Člen
@odata.id True string

Identifikátor URI adresáře, uživatele, skupiny nebo objektu kontaktu organizace, který se má přidat.

Přidání člena do skupiny uživatelů

Přidejte člena do skupiny uživatelů, člen by měl patřit do stejné organizace jako skupina.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID skupiny uživatelů v cloudovém uživatelském centru
userGroupId True string

Identifikátor skupiny uživatelů v cloudovém uživatelském centru

ID uživatele v cloudovém uživatelském centru
userId True string

Identifikátor uživatele cloudového uživatelského centra.

Přiřazení licence uživateli

Přidejte nebo odeberte licence pro uživatele. Můžete také povolit a zakázat konkrétní plány přidružené k licenci.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID objektu microsoftu uživatele.
microsoftObjectId True string

Identifikátor objektu microsoftu uživatele.

disabledPlans
disabledPlans array of

Zakázané plány.

ID SKU
skuId string

Identifikátor skladové položky licence Microsoftu.

Odebrání licencí
removeLicenses array of

Kolekce identifikátorů GUID, které identifikují licence k odebrání.

Návraty

Name Cesta Typ Description
value
value array of object

Hodnota.

identifikační číslo
value.id string

Identifikátor objektu licence.

ID SKU
value.skuId string

Identifikátor skladové položky Microsoftu.

Sku partnumber
value.skuPartNumber string

Microsoft Sku partnumber.

servicePlans
value.servicePlans array of object

Plány služeb.

servicePlanId
value.servicePlans.servicePlanId string

Identifikátor plánu služby.

servicePlanName
value.servicePlans.servicePlanName string

Název plánu služby.

provisioningStatus
value.servicePlans.provisioningStatus string

Stav zřizování

platí pro
value.servicePlans.appliesTo string

Platí pro.

Vytvoření skupiny Azure AD

Vytvořte skupinu Azure AD.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

Description
description string

Popis skupiny

Zobrazované jméno
displayName string

Zobrazovaný název skupiny.

groupTypes
groupTypes array of string

Typy skupin

Pošta povolena
mailEnabled boolean

Označuje, jestli je skupina povolená pošta.

Přezdívka
mailNickname string

Poštovní přezdívka skupiny.

Povolené zabezpečení
securityEnabled boolean

Označuje, jestli je skupina povolená zabezpečení.

Návraty

Name Cesta Typ Description
identifikační číslo
id string

Identifikátor skupiny.

Odstraněno dne
deletedDateTime string

Odstraněno dne.

Classification
classification string

Klasifikace skupiny

Datum vytvoření
createdDateTime string

Vytvořeno dne.

creationOptions
creationOptions array of string

Možnosti vytváření

Description
description string

Description.

Zobrazované jméno
displayName string

Zobrazovaný název.

groupTypes
groupTypes array of string

groupTypes

Pošta
mail string

E-mailová adresa skupiny.

Pošta povolena
mailEnabled boolean

Označuje, že skupina je povolená pošta.

Přezdívka
mailNickname string

Poštovní přezdívka skupiny.

Místní poslední synchronizace
onPremisesLastSyncDateTime string

Označuje, kdy se skupina synchronizovala do místního prostředí.

Místní identifikátor zabezpečení
onPremisesSecurityIdentifier string

Místní identifikátor zabezpečení skupiny.

Povolená místní synchronizace
onPremisesSyncEnabled string

Označuje, jestli je povolená místní synchronizace.

Upřednostňované umístění dat
preferredDataLocation string

Upřednostňované umístění dat skupiny

proxyAddresses
proxyAddresses array of string

Proxy adresy.

Obnovený
renewedDateTime string

Prodloužili jsme datum a čas skupiny.

resourceBehaviorOptions
resourceBehaviorOptions array of string

Možnosti chování prostředků

resourceProvisioningOptions
resourceProvisioningOptions array of string

Možnosti prozeze prostředků

Povolené zabezpečení
securityEnabled boolean

Označuje, jestli je skupina povolená zabezpečení.

Visbility
visibility string

Viditelnost skupiny

onPremisesProvisioningErrors
onPremisesProvisioningErrors array of string

Místní chyby zřizování

Vytvoření uživatele

Text požadavku obsahuje uživatele, který se má vytvořit. Minimálně je nutné zadat požadované vlastnosti uživatele. Volitelně můžete zadat jakékoli další zapisovatelné vlastnosti.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

Účet je povolený
accountEnabled boolean

Účet povolil hodnotu true nebo false.

Zobrazované jméno
displayName string

Zobrazované jméno uživatele.

Přezdívka
mailNickname string

Poštovní přezdívka uživatele.

Hlavní název uživatele
userPrincipalName string

Hlavní název uživatele.

Vynucení dalšího přihlášení ke změně hesla
forceChangePasswordNextSignIn boolean

Vynuťte uživateli, aby při příštím přihlášení změnil heslo.

Heslo
password string

Nové heslo pro uživatele

Návraty

Name Cesta Typ Description
Kontext OData
@odata.context string

Kontext OData

identifikační číslo
id string

Identifikátor cloudového centra uživatelů.

businessPhones
businessPhones array of string

Firemní telefony uživatele.

Zobrazované jméno
displayName string

Zobrazované jméno uživatele.

Křestní jméno
givenName string

Křestní jméno.

Pracovní pozice
jobTitle string

Pracovní pozice uživatele.

Pošta
mail string

E-mailová adresa uživatele.

Mobilní telefon
mobilePhone string

Číslo mobilního telefonu uživatele

Umístění Office
officeLocation string

Umístění Office uživatele

Upřednostňovaný jazyk
preferredLanguage string

Upřednostňovaný jazyk nakonfigurovaný v Azure AD

Surname
surname string

Příjmení uživatele.

Hlavní název uživatele
userPrincipalName string

Hlavní název uživatele.

Výpis bloků příkazů

Načte seznam dostupných bloků příkazů.

Parametry

Name Klíč Vyžadováno Typ Description
položky $top
$top string

Vrátí pouze první $top položky.

položky $skip
$skip string

Počet položek, které se mají přeskočit.

Výběr filtru
$select string

$select filtru odata.

Order by
$orderby string

Určuje, jaké hodnoty se použijí k seřazení kolekce záznamů.

Filter
$filter string

Funkce, která musí být vyhodnocena jako true, aby se vrátil záznam.

Počet
$count string

Určuje, že nezahrnuje počet položek v kolekci.

Návraty

Name Cesta Typ Description
Kontext OData
@odata.context string

Kontext OData

Počet OData
@odata.count integer

Počet OData.

Další odkaz OData
@odata.nextLink string

Další odkaz OData

value
value array of object

Hodnota.

identifikační číslo
value.id string

Identifikátor.

Technické ID
value.technicalIdentifier string

Technický identifikátor.

Typ
value.type string

Typ:

Version
value.version integer

Verze.

ID kategorie
value.categoryId string

Identifikátor kategorie.

Požadovaná akce čtení
value.requiredReadAction string

Požadovaná akce čtení

Požadovaná akce zápisu
value.requiredWriteAction string

Požadovaná akce zápisu

Požadovaný zprostředkovatel
value.requiredProvider string

Požadovaný zprostředkovatel.

ID kategorie nabídky
value.menuCategory.id string

Identifikátor kategorie nabídky.

Technické ID
value.menuCategory.technicalIdentifier string

Technický identifikátor.

ID nadřazené kategorie
value.parentCategory.id string

Identifikátor nadřazené kategorie.

Technické ID
value.parentCategory.technicalIdentifier string

Technický identifikátor.

identifikační číslo
value.category.id string

ID kategorie.

Technický identifikátor
value.category.technicalIdentifier string

Technický identifikátor.

Výpis domén organizace

Načte seznam objektů domény.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

Návraty

Name Cesta Typ Description
value
value array of object

Hodnota.

Typ autentizace
value.authenticationType string

Typ ověřování domény.

Stav dostupnosti
value.availabilityStatus string

Stav dostupnosti domény

identifikační číslo
value.id string

Identifikátor domény.

Spravováno správcem
value.isAdminManaged boolean

Označuje, jestli je doména spravovaná správcem.

Výchozí
value.isDefault boolean

Označuje, jestli se jedná o výchozí doménu.

Počáteční
value.isInitial boolean

Označuje, jestli se jedná o počáteční doménu.

Kořen
value.isRoot boolean

Označuje, jestli se jedná o kořenovou doménu.

Ověřený
value.isVerified boolean

Označuje, jestli je doména ověřená.

supportedServices
value.supportedServices array of string

Podporované služby.

Platnost hesla
value.passwordValidityPeriodInDays integer

Označuje platnost hesla ve dnech.

Okna s oznámením hesla
value.passwordNotificationWindowInDays integer

Označuje okno notiface hesla ve dnech.

Stát
value.state string

Stav domény.

Změna hesla uživatele

Aktualizujte profil hesla uživatele, aby si resetovali heslo.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID objektu microsoftu uživatele.
microsoftObjectId True string

Identifikátor objektu microsoftu uživatele.

Vynucení změny hesla při přihlášení
forceChangePasswordNextSignIn boolean

Vynuťte uživateli, aby při příštím přihlášení změnil heslo.

Heslo
password string

Nové heslo, které chcete nastavit.

Získání kategorií příkazů

Získejte všechny dostupné kategorie a podkategorie.

Parametry

Name Klíč Vyžadováno Typ Description
položky $top
$top string

Vrátí pouze první $top položky.

položky $skip
$skip string

Počet položek, které se mají přeskočit.

Výběr filtru
$select string

$select filtru odata.

Order by
$orderby string

Určuje, jaké hodnoty se použijí k seřazení kolekce záznamů.

Filter
$filter string

Funkce, která musí být vyhodnocena jako true, aby se vrátil záznam.

Počet
$count string

Určuje počasí nebo nezahrnuje počet položek v kolekci.

Návraty

Name Cesta Typ Description
Kontext OData
@odata.context string

Kontext OData

Počet OData
@odata.count integer

Počet OData.

Další odkaz OData
@odata.nextLink string

Další odkaz OData

value
value array of object

Hodnota.

identifikační číslo
value.id string

Id.

Technické ID
value.technicalIdentifier string

Technický identifikátor.

ID nadřazené kategorie
value.parentCategoryId string

Identifikátor nadřazené kategorie.

Získání národních prostředí

Získejte národní prostředí.

Návraty

Name Cesta Typ Description
Kontext OData
@odata.context string

Kontext OData

Počet
@odata.count integer

Počet OData.

OData nextLink
@odata.nextLink string

OData nextlink.

value
value array of object

Hodnota.

identifikační číslo
value.id string

Identifikátor národního prostředí.

Kód národní prostředí
value.localeCode string

Kódy jazyka ISO-639.

Kód země
value.countryCode string

Kódy zemí ISO-3166.

Název země
value.countryName string

Název země.

Získání organizací

Získejte všechny organizace, které máte oprávnění k zobrazení.

Návraty

Name Cesta Typ Description
Počet OData
@odata.count integer

Počet OData.

value
value array of object

Hodnota.

Název
value.name string

Název organizace Azure AD.

Id tenanta Microsoftu
value.microsoftTenantId string

Identifikátor tenanta Microsoftu organizace.

Datum vytvoření
value.createdOn string

Vytvořeno dne.

Datum úpravy
value.modifiedOn string

Změněno dne.

identifikační číslo
value.id string

Identifikátor cloudového uživatelského centra

Získání podrobností o bloku příkazů

Získejte podrobnosti o bloku příkazů. Ověření zprostředkovatele a akce závisí na konkrétním bloku příkazů.

Parametry

Name Klíč Vyžadováno Typ Description
ID bloku příkazu
commandBlockId True string

Formát – uuid. Jedinečný identifikátor bloku příkazů.

Návraty

Name Cesta Typ Description
identifikační číslo
id string

Id.

Version
version integer

Verze.

ID kategorie
categoryId string

ID kategorie.

Technické ID
technicalIdentifier string

Technický identifikátor.

Požadovaná akce čtení
requiredReadAction string

Požadovaná akce čtení

Požadovaná akce zápisu
requiredWriteAction string

Požadovaná akce zápisu

Požadovaný zprostředkovatel
requiredProvider string

Požadovaný zprostředkovatel.

Typ
type string

Typ:

identifikační číslo
category.id string

Id.

Technické ID
category.technicalIdentifier string

Technický identifikátor.

identifikační číslo
parentCategory.id string

Id.

Technické ID
parentCategory.technicalIdentifier string

Technický identifikátor.

identifikační číslo
menuCategory.id string

Id.

Technické ID
menuCategory.technicalIdentifier string

Technický identifikátor.

Vícenásobný výběr
commandInput.multiSelection string

Vícenásobný výběr.

layoutGroups
commandInput.layoutGroups array of object

Skupiny rozložení

Technické ID
commandInput.layoutGroups.technicalIdentifier string

Technický identifikátor.

layoutGroupFormats
commandInput.layoutGroups.layoutGroupFormats array of object

Formáty skupin rozložení

typ
commandInput.layoutGroups.layoutGroupFormats.type string

Typ:

vlastnost
commandInput.layoutGroups.layoutGroupFormats.property string

Vlastnost.

vlastnosti
commandInput.layoutGroups.layoutGroupFormats.properties array of

Vlastnosti.

parameters
commandInput.parameters array of object

Parametry.

Výchozí hodnota
commandInput.parameters.defaultValue string

Výchozí hodnota.

Technické ID
commandInput.parameters.technicalIdentifier string

Technický identifikátor.

Schema
commandInput.parameters.schema string

Schéma.

Citlivé
commandInput.parameters.sensitive boolean

Citlivý.

Povinné
commandInput.parameters.required boolean

Povinné.

Hodnota
commandInput.parameters.value string

Hodnota.

Sada příkazů
commandInput.parameters.placeholderEnabled.commandSet boolean

Sada příkazů.

Blok příkazů
commandInput.parameters.placeholderEnabled.commandBlock boolean

Blok příkazů

linkedCommandBlocks
commandInput.parameters.placeholderEnabled.linkedCommandBlocks array of object

Propojené bloky příkazů

technicalIdentifier
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

Technický identifikátor.

verze
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version integer

Verze.

layoutGroups
commandOutput.layoutGroups array of object

Skupiny rozložení

Technické ID
commandOutput.layoutGroups.technicalIdentifier string

Technický identifikátor.

layoutGroupFormats
commandOutput.layoutGroups.layoutGroupFormats array of object

Formáty skupin rozložení

typ
commandOutput.layoutGroups.layoutGroupFormats.type string

Typ:

vlastnost
commandOutput.layoutGroups.layoutGroupFormats.property string

Vlastnost.

vlastnosti
commandOutput.layoutGroups.layoutGroupFormats.properties array of

Vlastnosti.

parameters
commandOutput.parameters array of object

Parametry.

Example
commandOutput.parameters.example string

Příklad:

Technické ID
commandOutput.parameters.technicalIdentifier string

Technický identifikátor.

Schema
commandOutput.parameters.schema string

Schéma.

Citlivé
commandOutput.parameters.sensitive boolean

Citlivý.

Povinné
commandOutput.parameters.required boolean

Povinné.

Hodnota
commandOutput.parameters.value string

Hodnota.

Sada příkazů
commandOutput.parameters.placeholderEnabled.commandSet boolean

Sada příkazů.

Blok příkazů
commandOutput.parameters.placeholderEnabled.commandBlock boolean

Čárkovaný blok.

Získání podrobností o uživateli

Získejte uživatele podle identifikátoru objektu Microsoftu.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID objektu microsoftu uživatele.
microsoftObjectId True string

Identifikátor objektu microsoftu uživatele.

Návraty

Name Cesta Typ Description
Účet je povolený
accountEnabled boolean

Účet povolil hodnotu true nebo false.

ID zaměstnance
employeeId string

Identifikátor zaměstnance uživatele.

Zobrazované jméno
displayName string

Zobrazované jméno uživatele.

Křestní jméno
givenName string

Jméno uživatele.

Surname
surname string

Příjmení uživatele.

Hlavní název uživatele
userPrincipalName string

Hlavní název uživatele.

Pracovní pozice
jobTitle string

Pracovní pozice uživatele.

Oddělení
department string

Oddělení uživatele.

Název společnosti
companyName string

Název společnosti uživatele.

Usagelocation
usageLocation string

Umístění použití uživatele.

Adresa ulice
streetAddress string

Adresa uživatele.

City
city string

Město uživatele.

Stát
state string

Stav uživatele

PSČ
postalCode string

PSČ uživatele.

Country
country string

Země uživatele

Získání podrobností o uživatelské licenci

Načtěte seznam objektů podrobností o licencích pro podnikové uživatele.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

ID objektu microsoftu uživatele.
microsoftObjectId True string

Identifikátor objektu microsoftu uživatele.

Návraty

Name Cesta Typ Description
value
value array of object

Hodnota.

identifikační číslo
value.id string

Identifikátor licence uživatele.

ID SKU
value.skuId string

Identifikátor skladové položky licence Microsoftu.

Sku partnumber
value.skuPartNumber string

Sku partnumber licence Microsoftu.

servicePlans
value.servicePlans array of object

Plány služeb.

servicePlanId
value.servicePlans.servicePlanId string

Identifikátor plánu služby.

servicePlanName
value.servicePlans.servicePlanName string

Název plánu služby.

provisioningStatus
value.servicePlans.provisioningStatus string

Stav zřizování

platí pro
value.servicePlans.appliesTo string

Platí pro.

Získání podrobností o úloze jednoho uživatele

Získání podrobností o jedné úloze uživatele, poskytovateli a ověření akce závisí na konkrétním bloku příkazu.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace
organizationId True string

Formát – uuid. Jedinečný identifikátor organizace.

ID bloku příkazu
commandBlockId True string

Formát – uuid. Jedinečný identifikátor bloku příkazu.

ID úlohy
jobId True string

Formát – uuid. Jedinečný identifikátor úlohy.

Návraty

Name Cesta Typ Description
identifikační číslo
id string

Id.

ID bloku příkazu
commandBlockId string

Identifikátor bloku příkazu

Název sady příkazů
commandSetName string

Název sady příkazů

ID sady příkazů
commandSetId string

Identifikátor sady příkazů.

ID bloku sady příkazů
commandSetBlockId string

Identifikátor bloku sady příkazů

ID uživatele
userId string

Identifikátor uživatele.

Hlavní uživatel (UPN)
userUpn string

Hlavní název uživatele.

ID skupiny
groupId string

Identifikátor skupiny.

Název skupiny
groupName string

Název skupiny

ID organizace
organizationId string

Identifikátor organizace.

Název organizace
organizationName string

Název organizace.

Objekt upn objektu actor
actorUserUpn string

Hlavní název uživatele objektu actor.

ID organizace objektu actor
actorOrganizationId string

Identifikátor organizace objektu actor.

Název organizace objektu actor
actorOrganizationName string

Název organizace objektu actor.

Stav
status string

Stav.

Spuštěno dne
executedOn string

Spuštěno.

Technické ID bloku příkazů
commandBlockTechnicalIdentifier string

Technický identifikátor bloku příkazu

Verze bloku příkazů
commandBlockVersion integer

Verze bloku příkazu

layoutGroups
output.body.layoutGroups array of object

Formáty skupin rozložení

layoutGroupFormats
output.body.layoutGroups.layoutGroupFormats array of object

Formáty skupin rozložení

typ
output.body.layoutGroups.layoutGroupFormats.type string

Typ:

vlastnost
output.body.layoutGroups.layoutGroupFormats.property string

Vlastnost.

vlastnosti
output.body.layoutGroups.layoutGroupFormats.properties array of string

Vlastnosti.

parameters
output.body.parameters array of object

Parametry.

Technické ID
output.body.parameters.technicalIdentifier string

Technický identifikátor.

Hodnota
output.body.parameters.value string

Hodnota.

Schema
output.body.parameters.schema string

Schéma.

Sada příkazů
output.body.parameters.placeholderEnabled.commandSet boolean

Sada příkazů.

Blok příkazů
output.body.parameters.placeholderEnabled.commandBlock boolean

Blok příkazů

Kód chyby
output.errorCode string

Kód chyby

Success
output.isSuccess boolean

Úspěšný.

layoutGroups
input.layoutGroups array of object

Skupiny rozložení

layoutGroupFormats
input.layoutGroups.layoutGroupFormats array of object

Formáty skupin rozložení

typ
input.layoutGroups.layoutGroupFormats.type string

Typ:

vlastnost
input.layoutGroups.layoutGroupFormats.property string

Vlastnost.

vlastnosti
input.layoutGroups.layoutGroupFormats.properties array of string

Vlastnosti.

Více organizací
input.multiSelection.multipleOrganizations boolean

Více organizací.

Více uživatelů
input.multiSelection.multipleUsers boolean

Více uživatelů.

parameters
input.parameters array of object

Parametry.

Technické ID
input.parameters.technicalIdentifier string

Technický identifikátor.

Hodnota
input.parameters.value string

Hodnota.

Výchozí hodnota
input.parameters.defaultValue string

Výchozí hodnota.

Typ
input.parameters.schema.type string

Typ:

Formát
input.parameters.schema.format string

Formát.

Vzor
input.parameters.schema.pattern string

Vzor.

Minimální délka
input.parameters.schema.minLength string

Minimální délka.

Sada příkazů
input.parameters.placeholderEnabled.commandSet boolean

Sada příkazů.

Blok příkazů
input.parameters.placeholderEnabled.commandBlock boolean

Blok příkazů

linkedCommandBlocks
input.parameters.placeholderEnabled.linkedCommandBlocks array of object

Propojené bloky příkazů

technicalIdentifier
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

Technický identifikátor.

verze
input.parameters.placeholderEnabled.linkedCommandBlocks.version integer

Verze.

Získání předplacených skladových položek organizace

Získejte seznam komerčních předplatných, která organizace získala.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

Návraty

Name Cesta Typ Description
value
value array of object

Hodnota.

Stav schopností
value.capabilityStatus string

Stav schopností skladové položky Microsoftu

Spotřebované jednotky
value.consumedUnits integer

Spotřebované jednotky pro tuto skladovou položku.

identifikační číslo
value.id string

Identifikátor odebíraného objektu skladové položky.

ID SKU
value.skuId string

Identifikátor skladové položky licence Microsoftu.

Sku partnumber
value.skuPartNumber string

Sku partnumber licence Microsoftu.

Vztahuje se na
value.appliesTo string

Platí pro uživatele nebo organizaci.

Enabled
value.prepaidUnits.enabled integer

Povolené předplacené skladové položky.

Dočasně blokován.
value.prepaidUnits.suspended integer

Pozastavené předplacené skladové položky.

Výstraha
value.prepaidUnits.warning integer

Předplacené skladové položky s upozorněním

servicePlans
value.servicePlans array of object

Plány služeb.

servicePlanId
value.servicePlans.servicePlanId string

Identifikátor plánu služby.

servicePlanName
value.servicePlans.servicePlanName string

Název plánu služby.

provisioningStatus
value.servicePlans.provisioningStatus string

Stav zřizování

platí pro
value.servicePlans.appliesTo string

Platí pro.

Získání předplatných

Načte všechna předplatná pro zákazníka partnera pomocí identifikátoru tenanta služby Active Directory.

Parametry

Name Klíč Vyžadováno Typ Description
Identifikátor partnera cloudového uživatelského centra.
partnerId True string

Identifikátor partnera cloudového uživatelského centra.

Identifikátor zákazníka v Cloudovém uživatelském centru
customerId True string

Identifikátor zákazníka v Cloudovém uživatelském centru

ID tenanta Microsoftu zákazníka
tenantId True string

Identifikátor tenanta Microsoftu zákazníka.

Návraty

Name Cesta Typ Description
Celkový počet
totalCount integer

Celkový počet objektu předplatného

items
items array of object

Položky.

identifikační číslo
items.id string

Identifikátor předplatného.

ID nároku
items.entitlementId string

Identifikátor nároku předplatného.

Přátelský název
items.friendlyName string

Popisný název předplatného

Množství
items.quantity integer

Množství předplatného.

Typ jednotky
items.unitType string

Typ jednotky předplatného

Datum vytvoření
items.creationDate string

Vytvořeno k datu předplatného.

Počáteční datum platnosti
items.effectiveStartDate string

Platné počáteční datum předplatného.

Koncové datum závazku
items.commitmentEndDate string

Koncové datum závazku předplatného

Stav
items.status string

Stav předplatného

Automatické prodlužování platnosti
items.autoRenewEnabled boolean

Označuje, jestli je pro předplatné povolené automatické prodlužování.

Typ fakturace
items.billingType string

Typ fakturace předplatného

Typ kontraktu
items.contractType string

Typ smlouvy předplatného.

URI
items.links.offer.uri string

Identifikátor URI předplatného

Metoda
items.links.offer.method string

Metoda předplatného

headers
items.links.offer.headers array of

Hlavičky.

URI
items.links.self.uri string

Identifikátor URI předplatného

Metoda
items.links.self.method string

Metoda předplatného

headers
items.links.self.headers array of

Hlavičky.

ID objednávky
items.orderId string

Identifikátor objednávky předplatného.

Etag
items.attributes.etag string

Etag předplatného.

Typ objektu
items.attributes.objectType string

Typ objektu předplatného

Typ objektu
attributes.objectType string

Typ objektu předplatného

Získání seznamu členů skupiny uživatelů cloudového uživatelského centra

Získejte seznam členů skupiny uživatelů konkrétní skupiny.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

Identifikátor cloudového centra uživatelů skupiny
userGroupId True string

Identifikátor cloudového centra uživatelů skupiny

Návraty

Name Cesta Typ Description
Počet
@odata.count integer

Počet OData.

value
value array of object

Hodnota.

Název
value.name string

Název.

Hlavní název uživatele
value.upn string

Hlavní název uživatele skupiny.

identifikační číslo
value.id string

Identifikátor objektu člena skupiny.

ID skupiny
value.groupId string

Identifikátor cloudového centra uživatelů skupiny

Datum vytvoření
value.createdOn string

Vytvořeno dne.

Datum úpravy
value.modifiedOn string

Změněno dne.

Získání skupin uživatelů v Cloudovém uživatelském centru

Získejte seznam skupin všech organizací, které máte oprávnění k zobrazení.

Parametry

Name Klíč Vyžadováno Typ Description
Filtrování skupin.
$filter True string

Filtrování skupin v organizaci Použijte: organizationId in ({organizationId}).

Návraty

Name Cesta Typ Description
Počet
@odata.count integer

Počet OData.

value
value array of object

Hodnota.

ID organizace
value.organizationId string

Identifikátor organizace v cloudovém uživatelském centru

Název
value.name string

Název skupiny.

Description
value.description string

Popis skupiny

identifikační číslo
value.id string

Identifikátor skupiny.

Datum vytvoření
value.createdOn string

Vytvořeno dne.

Datum úpravy
value.modifiedOn string

Změněno dne.

Získání skupin zabezpečení Azure AD

Získejte seznam skupin zabezpečení Azure AD všech organizací, které máte oprávnění k zobrazení.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace v cloudovém uživatelském centru
organizationId True string

Identifikátor organizace v cloudovém uživatelském centru

Návraty

Name Cesta Typ Description
value
value array of object

Hodnota.

Datum vytvoření
value.createdDateTime string

Vytvořeno dne.

Zobrazované jméno
value.displayName string

Zobrazovaný název.

groupTypes
value.groupTypes array of string

Typy skupin

identifikační číslo
value.id string

Identifikátor objektu společnosti Microsoft skupiny.

Povolené zabezpečení
value.securityEnabled boolean

Označuje, jestli je skupina povolená zabezpečení.

Pošta
value.mail string

E-mailová adresa skupiny.

Získání statistik o úlohách bloku příkazů pro všechny autorizované organizace

Získejte statistiky úloh bloku příkazů pro bloky příkazů, které máte oprávnění k zobrazení.

Parametry

Name Klíč Vyžadováno Typ Description
ID kategorie
categoryId True string

Formát – uuid. Jedinečný identifikátor kategorie.

Výběr filtru
$select string

$select filtru odata.

Návraty

Name Cesta Typ Description
Kontext OData
@odata.context string

Kontext OData

Typ
type string

Typ:

Kategorie
category string

Kategorie.

Období
period string

Perioda.

Dokončeno
completed integer

Hotový.

Zařazeno do fronty
queued integer

Zařazený do fronty.

Neúspěšné
failed integer

Neúspěšný.

Získání uživatelů

Načte seznam uživatelských objektů.

Parametry

Name Klíč Vyžadováno Typ Description
Filtrovat uživatele.
$filter True string

Filtrujte uživatele v organizaci. Použijte: organizationId in ({organizationId}).

Návraty

Name Cesta Typ Description
Počet OData
@odata.count integer

Počet OData.

value
value array of object

Hodnota.

ID organizace
value.organizationId string

Identifikátor organizace v cloudovém uživatelském centru

Identifikátor objektu Microsoftu
value.microsoftObjectIdentifier string

Identifikátor objektu microsoftu uživatele.

Hlavní název uživatele
value.upn string

Hlavní název uživatele.

Křestní jméno
value.firstName string

Jméno uživatele.

Příjmení
value.lastName string

Příjmení uživatele.

Zobrazované jméno
value.displayName string

Zobrazované jméno uživatele.

Jazyk
value.language string

Jazyk uživatele

Místo použití
value.usageLocation string

Umístění použití uživatele.

identifikační číslo
value.id string

Identifikátor cloudového uživatelského centra uživatele

Vytvořeno dne
value.createdOn string

Vytvořeno dne.

Datum úpravy
value.modifiedOn string

Změněno dne.

Získání úloh bloku příkazů konkrétní organizace

Získejte úlohy bloku příkazů pro bloky příkazů, které máte oprávnění k zobrazení.

Parametry

Name Klíč Vyžadováno Typ Description
ID organizace.
organizationId True string

Formát – uuid. Jedinečný identifikátor organizace.

položky $top
$top string

Vrátí pouze první $top položky.

položky $skip
$skip string

Počet položek, které se mají přeskočit.

Výběr filtru
$select string

$select filtru odata.

Order by
$orderby string

Určuje, jaké hodnoty se použijí k seřazení kolekce záznamů.

Filter
$filter string

Funkce, která musí být vyhodnocena jako true, aby se vrátil záznam.

Počet
$count string

Určuje počasí nebo nezahrnuje počet položek v kolekci.

Návraty

Name Cesta Typ Description
Kontext OData
@odata.context string

Kontext OData

Počet OData
@odata.count integer

Počet OData.

OData nextlink
@odata.nextLink string

OData nextlink.

value
value array of object

Hodnota.

identifikační číslo
value.id string

Id.

ID bloku příkazu
value.commandBlockId string

Identifikátor bloku příkazu

Název sady příkazů
value.commandSetName string

Název sady příkazů

ID sady příkazů
value.commandSetId string

Identifikátor sady příkazů.

ID bloku sady příkazů
value.commandSetBlockId string

Identifikátor bloku sady příkazů

ID uživatele
value.userId string

Identifikátor uživatele.

Hlavní uživatel (UPN)
value.userUpn string

Hlavní název uživatele

ID skupiny
value.groupId string

Identifikátor skupiny.

Název skupiny
value.groupName string

Název skupiny

ID organizace
value.organizationId string

Identifikátor organizace.

Název organizace
value.organizationName string

Název organizace.

Hlavní název uživatele objektu actor
value.actorUserUpn string

Hlavní název uživatele objektu actor.

ID organizace objektu actor
value.actorOrganizationId string

Identifikátor organizace objektu actor.

Název organizace objektu actor
value.actorOrganizationName string

Název organizace objektu actor.

Stav
value.status string

Stav.

Spuštěno dne
value.executedOn string

Spuštěno.

Technické ID bloku příkazů
value.commandBlockTechnicalIdentifier string

Technický identifikátor bloku příkazu

Verze bloku příkazů
value.commandBlockVersion integer

Verze bloku příkazu

Plánované spuštění
value.plannedExecution string

Plánované spuštění.

ID plánu
value.scheduleId string

Identifikátor plánu

Název plánu
value.scheduleName string

Název plánu.

Získání úloh bloku příkazů pro všechny autorizované organizace

Získejte úlohy bloku příkazů pro bloky příkazů, které máte oprávnění k zobrazení.

Parametry

Name Klíč Vyžadováno Typ Description
položky $top
$top string

Vrátí pouze první $top položky.

položky $skip
$skip string

Počet položek, které se mají přeskočit.

Výběr filtru
$select string

$select filtru odata.

Order by
$orderby string

Určuje, jaké hodnoty se použijí k seřazení kolekce záznamů.

Filter
$filter string

Funkce, která musí být vyhodnocena jako true, aby se vrátil záznam.

Počet
$count string

Určuje, jestli se má počet položek zahrnout do kolekce.

Návraty

Name Cesta Typ Description
Kontext OData
@odata.context string

Kontext OData

Počet OData
@odata.count integer

Počet OData.

Další odkaz OData
@odata.nextLink string

Další odkaz OData

value
value array of object

Hodnota.

identifikační číslo
value.id string

Identifikátor.

ID bloku příkazu
value.commandBlockId string

Identifikátor bloku příkazu

Název sady příkazů
value.commandSetName string

Název sady příkazů

ID sady příkazů
value.commandSetId string

Identifikátor sady příkazů

ID bloku sady příkazů
value.commandSetBlockId string

Identifikátor bloku sady příkazů

ID uživatele
value.userId string

Identifikátor uživatele.

Hlavní název uživatele
value.userUpn string

Hlavní název uživatele

ID skupiny
value.groupId string

Identifikátor skupiny.

Název skupiny
value.groupName string

Název skupiny

ID organizace
value.organizationId string

Identifikátor organizace.

Název organizace
value.organizationName string

Název organizace.

Hlavní uživatel objektu actor
value.actorUserUpn string

Hlavní název uživatele objektu actor.

ID organizace objektu actor
value.actorOrganizationId string

Identifikátor organizace objektu actor.

Název organizace objektu actor
value.actorOrganizationName string

Název organizace objektu actor.

Stav
value.status string

Stav.

Spuštěno dne
value.executedOn string

Spuštěno.

Technické ID bloku příkazů
value.commandBlockTechnicalIdentifier string

Technický identifikátor bloku příkazu

Verze bloku příkazů
value.commandBlockVersion integer

Verze bloku příkazu

Plánované spuštění
value.plannedExecution string

Plánované spuštění.

ID plánu
value.scheduleId string

Identifikátor plánu

Název plánu
value.scheduleName string

Název plánu.