Dela via


N-able Cloud User Hub (förhandsversion)

Cloud User Hub är en enhetlig Microsoft CSP-portal där du kan automatisera vanliga uppgifter i alla Microsoft 365-appar utan att byta konsol eller kunder.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster Class Regioner
Copilot Studio Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Norm Alla Logic Apps-regioner utom följande:
     – Azure Government-regioner
     – Regioner i Azure Kina
     - US Department of Defense (DoD)
Power Apps Premie Alla Power Apps-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Kontakt
Namn Stöd för molnanvändarhubben
URL https://documentation.clouduserhub.management/kb/en
E-postmeddelande technicalsupport@n-able.com
Metadata för anslutningsprogram
Utgivare N-able Cloud User Hub B.V.
Webbplats https://www.n-able.com
Sekretesspolicy https://www.n-able.com/legal/privacy
Kategorier Business Management;IT Operations

Cloud User Hub är en enhetlig Microsoft CSP-portal där du kan automatisera vanliga uppgifter i alla Microsoft 365-appar utan att byta konsol eller kunder.

Förutsättningar

Du behöver följande för att fortsätta:

  • En prenumeration på molnanvändarhubben
  • Konfigurerade lösningar i Cloud User Hub för de specifika åtgärder som du tänker använda
  • Konfigurerade roller i Cloud User Hub för de specifika åtgärder som du tänker använda .

Hämta autentiseringsuppgifter

Du kan logga in med alla konton som har konfigurerats för åtkomst till Cloud User Hub. För automatiseringsscenarier rekommenderar vi att du använder ett dedikerat tjänstkonto.

Kom igång med anslutningsappen

Börja med Hämta organisationer för att hämta en lista över organisationer som du får hantera (inklusive dina egna). Organisationer returneras enligt de konfigurerade rollomfattningarna i Cloud User Hub. Använd ID:erna för efterföljande anrop. För åtgärder som krävde ett partner-ID använder du ID:t från din egen organisation. För vissa åtgärder behöver du ett klient-ID i stället för det interna Cloud User Hub-ID:t eller båda.

Kända problem och begränsningar

Vissa åtgärder kräver att målorganisationen har en matchande Microsoft 365-licens och/eller en aktiv Azure-prenumeration. Till exempel: konfigurera villkorlig åtkomst, kräver en Microsoft Entra ID Premium-licens.

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Få information om ett jobb med en enda användare

Hämta information om ett jobb, provider och åtgärdsvalidering för en enskild användare beror på det specifika kommandoblocket.

Hämta användare

Hämta en lista över användarobjekt.

Hämta användargrupper för molnanvändarhubben

Hämta en lista över grupper av alla organisationer som du har behörighet att visa.

Hämta användarinformation

Hämta en användare efter Microsoft-objektidentifierare.

Hämta Azure AD-säkerhetsgrupper

Hämta en lista över Azure AD-säkerhetsgrupper för alla organisationer som du har behörighet att visa.

Hämta en lista över cloud user hub-användargruppmedlemmar

Hämta en lista över användargruppsmedlemmar i en specifik grupp.

Hämta information om användarlicenser

Hämta en lista över licensinformationsobjekt för företagsanvändare.

Hämta information om kommandoblock

Hämta information om ett kommandoblock. Provider och åtgärdsverifiering beror på det specifika kommandoblocket.

Hämta kommandoblocksjobb för alla auktoriserade organisationer

Hämta kommandoblocksjobb för kommandoblock som du har behörighet att visa.

Hämta kommandoblocksjobb för en viss organisation

Hämta kommandoblocksjobb för kommandoblock som du har behörighet att visa.

Hämta kommandokategorier

Hämta alla tillgängliga kategorier och underkategorier.

Hämta nationella inställningar

Hämta nationella inställningar.

Hämta organisationer

Hämta alla organisationer som du har behörighet att visa.

Hämta organisationsprenumererade SKU:er

Hämta listan över kommersiella prenumerationer som en organisation har köpt.

Hämta prenumerationer

Hämtar alla prenumerationer för en partners kund via deras active directory-klientidentifierare.

Hämta statistik om kommandoblockeringsjobb för alla auktoriserade organisationer

Hämta statistik om de kommandoblocksjobb för kommandoblock som du har behörighet att visa.

Lista organisationsdomäner

Hämta en lista över domänobjekt.

Listkommandoblock

Hämta en lista över tillgängliga kommandoblock.

Lägga till en medlem i en användargrupp

Lägg till en medlem i en användargrupp. Medlemmen ska tillhöra samma organisation som gruppen.

Lägga till en medlem i en grupp

Lägg till en medlem i en Microsoft 365-grupp eller en säkerhetsgrupp via navigeringsegenskapen medlemmar.

Lägga till ett kommandoblocksjobb för en användare

Lägg till ett kommandoblocksjobb. Providern och åtgärdsverifieringen baseras på det specifika kommandoblocket.

Lägga till ett kommandoblocksjobb för en grupp

Lägg till ett kommandoblocksjobb. Providern och åtgärdsverifieringen baseras på det specifika kommandoblocket.

Lägga till ett kommandoblocksjobb för en organisation

Lägg till ett kommandoblocksjobb. Providern och åtgärdsverifieringen baseras på det specifika kommandoblocket.

Skapa användare

Begärandetexten innehåller användaren som ska skapas. Du måste minst ange de egenskaper som krävs för användaren. Du kan också ange andra skrivbara egenskaper.

Skapa Azure AD-grupp

Skapa azure AD-grupp.

Ta bort användare

Ta bort en användare. När de tas bort flyttas användarresurser till en tillfällig container och kan återställas inom 30 dagar. Efter den tiden tas de bort permanent.

Ta bort användargrupp för molnanvändarhubben

Ta bort en användargrupp.

Ta bort en medlem från en användargrupp

Ta bort en medlem till en användargrupp.

Ta bort medlem

Ta bort en medlem från en grupp via navigeringsegenskapen medlemmar.

Tilldela en licens till en användare

Lägga till eller ta bort licenser för användaren. Du kan också aktivera och inaktivera specifika planer som är associerade med en licens.

Uppdatera prenumerationskvantitet

Uppdatera kvantiteten för en prenumeration.

Ändra lösenord för användare

Uppdatera lösenordsprofilen för en användare för att återställa lösenordet.

Få information om ett jobb med en enda användare

Hämta information om ett jobb, provider och åtgärdsvalidering för en enskild användare beror på det specifika kommandoblocket.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID
organizationId True string

Format – uuid. Unik identifierare för organisationen.

Kommandoblocks-ID
commandBlockId True string

Format – uuid. Unik identifierare för kommandoblocket.

Jobb-ID
jobId True string

Format – uuid. Unik identifierare för jobbet.

Returer

Name Sökväg Typ Description
Id
id string

Id.

Kommandoblocks-ID
commandBlockId string

Kommandoblocksidentifierare.

Namn på kommandouppsättning
commandSetName string

Namn på kommandouppsättning.

Kommandouppsättnings-ID
commandSetId string

Kommandouppsättningsidentifierare.

Block-ID för kommandouppsättning
commandSetBlockId string

Blockidentifierare för kommandouppsättning.

Användar-ID
userId string

Identifierare för användare.

Användar-upn
userUpn string

Användarens huvudnamn.

Grupp-ID
groupId string

Gruppidentifierare.

Gruppnamn
groupName string

Gruppnamn.

Organisations-ID
organizationId string

Organisationsidentifierare.

Organisationsnamn
organizationName string

Organisationsnamn.

Skådespelare upn
actorUserUpn string

Aktörens huvudnamn.

Aktörens organisations-ID
actorOrganizationId string

Aktörens organisationsidentifierare.

Namn på aktörsorganisation
actorOrganizationName string

Aktörens organisationsnamn.

Läge
status string

Status.

Körs på
executedOn string

Körs på.

Tekniskt ID för Kommandoblock
commandBlockTechnicalIdentifier string

Teknisk identifierare för kommandoblock.

Kommandoblocksversion
commandBlockVersion integer

Kommandoblocksversion.

layoutGroups
output.body.layoutGroups array of object

Layoutgruppformat.

layoutGroupFormats
output.body.layoutGroups.layoutGroupFormats array of object

Layoutgruppformat.

type
output.body.layoutGroups.layoutGroupFormats.type string

Typ.

fastighet / egendom
output.body.layoutGroups.layoutGroupFormats.property string

Egenskap.

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

Egenskaper.

parameters
output.body.parameters array of object

Parametrar.

Tekniskt ID
output.body.parameters.technicalIdentifier string

Teknisk identifierare.

Värde
output.body.parameters.value string

Värde.

Schema
output.body.parameters.schema string

Schemat.

Kommandouppsättning
output.body.parameters.placeholderEnabled.commandSet boolean

Kommandouppsättning.

Kommandoblock
output.body.parameters.placeholderEnabled.commandBlock boolean

Kommandoblock.

Felkod
output.errorCode string

Felkod.

Success
output.isSuccess boolean

Framgångsrik.

layoutGroups
input.layoutGroups array of object

Layoutgrupper.

layoutGroupFormats
input.layoutGroups.layoutGroupFormats array of object

Layoutgruppformat.

type
input.layoutGroups.layoutGroupFormats.type string

Typ.

fastighet / egendom
input.layoutGroups.layoutGroupFormats.property string

Egenskap.

egenskaper
input.layoutGroups.layoutGroupFormats.properties array of string

Egenskaper.

Flera organisationer
input.multiSelection.multipleOrganizations boolean

Flera organisationer.

Flera användare
input.multiSelection.multipleUsers boolean

Flera användare.

parameters
input.parameters array of object

Parametrar.

Tekniskt ID
input.parameters.technicalIdentifier string

Teknisk identifierare.

Värde
input.parameters.value string

Värde.

Standardvärde
input.parameters.defaultValue string

Standardvärde.

Typ
input.parameters.schema.type string

Typ.

Format
input.parameters.schema.format string

Format.

Mönster
input.parameters.schema.pattern string

Mönster.

Minimal längd
input.parameters.schema.minLength string

Minimal längd.

Kommandouppsättning
input.parameters.placeholderEnabled.commandSet boolean

Kommandouppsättning.

Kommandoblock
input.parameters.placeholderEnabled.commandBlock boolean

Kommandoblock.

linkedCommandBlocks
input.parameters.placeholderEnabled.linkedCommandBlocks array of object

Länkade kommandoblock.

technicalIdentifier
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

Teknisk identifierare.

version
input.parameters.placeholderEnabled.linkedCommandBlocks.version integer

Version.

Hämta användare

Hämta en lista över användarobjekt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Filtrera användare.
$filter True string

Filtrera på användare i en organisation. Använd: organizationId i ({organizationId}).

Returer

Name Sökväg Typ Description
Antal OData
@odata.count integer

Antal OData.

värde
value array of object

Värde.

Organisations-ID
value.organizationId string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objektidentifierare
value.microsoftObjectIdentifier string

Microsoft-objektidentifierare för användaren.

Användarens huvudnamn
value.upn string

Användarens huvudnamn.

Förnamn
value.firstName string

Användarens förnamn.

Efternamn
value.lastName string

Användarens efternamn.

Visningsnamn
value.displayName string

Visningsnamn är användarens fullständiga namn.

Language
value.language string

Användarens språk.

Användningsplats
value.usageLocation string

Användarens användningsplats.

Id
value.id string

Cloud User Hub-identifierare för användaren.

Skapad på
value.createdOn string

Skapad på.

Ändrades
value.modifiedOn string

Ändrad den.

Hämta användargrupper för molnanvändarhubben

Hämta en lista över grupper av alla organisationer som du har behörighet att visa.

Parametrar

Name Nyckel Obligatorisk Typ Description
Filtrera grupper.
$filter True string

Filtrera på grupper i en organisation. Använd: organizationId i ({organizationId}).

Returer

Name Sökväg Typ Description
Räkna
@odata.count integer

Antal OData.

värde
value array of object

Värde.

Organisations-ID
value.organizationId string

Molnanvändarhubbens organisationsidentifierare.

Namn
value.name string

Gruppens namn.

Description
value.description string

Beskrivning för gruppen.

Id
value.id string

Identifierare för gruppen.

Skapades den
value.createdOn string

Skapad på.

Ändrades
value.modifiedOn string

Ändrad den.

Hämta användarinformation

Hämta en användare efter Microsoft-objektidentifierare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objekt-ID för användaren.
microsoftObjectId True string

Microsoft-objektidentifierare för användaren.

Returer

Name Sökväg Typ Description
Konto aktiverat
accountEnabled boolean

Kontot har aktiverat sant eller falskt.

Medarbetar-ID
employeeId string

Användarens medarbetaridentifierare.

Visningsnamn
displayName string

Visningsnamn är användarens fullständiga namn.

Förnamn
givenName string

Användarens förnamn.

Surname
surname string

Användarens efternamn.

Användarens huvudnamn
userPrincipalName string

Användarens huvudnamn.

Befattning
jobTitle string

Användarens befattning.

Avdelning
department string

Användarens avdelning.

Företagsnamn
companyName string

Användarens företagsnamn.

Användningslokalisering
usageLocation string

Användarens användningsplats.

Gatuadress
streetAddress string

Användarens gatuadress.

City
city string

Användarens stad.

Stat/län
state string

Användarens tillstånd.

Postnummer
postalCode string

Postnummer för användaren.

Country
country string

Användarens land.

Hämta Azure AD-säkerhetsgrupper

Hämta en lista över Azure AD-säkerhetsgrupper för alla organisationer som du har behörighet att visa.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Returer

Name Sökväg Typ Description
värde
value array of object

Värde.

Skapades den
value.createdDateTime string

Skapad på.

Visningsnamn
value.displayName string

Visningsnamn.

groupTypes
value.groupTypes array of string

Grupptyper.

Id
value.id string

Microsoft-objektidentifierare för gruppen.

Säkerhet aktiverad
value.securityEnabled boolean

Anger om gruppen är säkerhetsaktiverad.

Postadress
value.mail string

E-postadress till gruppen.

Hämta en lista över cloud user hub-användargruppmedlemmar

Hämta en lista över användargruppsmedlemmar i en specifik grupp.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Cloud User Hub-identifierare för gruppen.
userGroupId True string

Cloud User Hub-identifierare för gruppen.

Returer

Name Sökväg Typ Description
Räkna
@odata.count integer

Antal OData.

värde
value array of object

Värde.

Namn
value.name string

Namn.

Användarens huvudnamn
value.upn string

Användarens huvudnamn för gruppen.

Id
value.id string

Identifierare för gruppmedlemsobjektet.

Grupp-ID
value.groupId string

Cloud User Hub-identifierare för gruppen.

Skapades den
value.createdOn string

Skapad på.

Ändrades
value.modifiedOn string

Ändrad den.

Hämta information om användarlicenser

Hämta en lista över licensinformationsobjekt för företagsanvändare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objekt-ID för användaren.
microsoftObjectId True string

Microsoft-objektidentifierare för användaren.

Returer

Name Sökväg Typ Description
värde
value array of object

Värde.

Id
value.id string

Identifierare för användarens licens.

Sku-ID
value.skuId string

SKU-identifierare för Microsoft-licensen.

Sku-delnummer
value.skuPartNumber string

Sku-delnummer för Microsoft-licensen.

servicePlans
value.servicePlans array of object

Tjänstplaner.

servicePlanId
value.servicePlans.servicePlanId string

Serviceplan-identifierare.

servicePlanName
value.servicePlans.servicePlanName string

Serviceplansnamn.

Provisioneringsstatus
value.servicePlans.provisioningStatus string

Etableringsstatus.

gällerTill
value.servicePlans.appliesTo string

Gäller för.

Hämta information om kommandoblock

Hämta information om ett kommandoblock. Provider och åtgärdsverifiering beror på det specifika kommandoblocket.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kommandoblocks-ID
commandBlockId True string

Format – uuid. Unik identifierare för kommandoblocket.

Returer

Name Sökväg Typ Description
Id
id string

Id.

Utgåva
version integer

Version.

Kategori-ID
categoryId string

Kategori-ID.

Tekniskt ID
technicalIdentifier string

Teknisk identifierare.

Nödvändig läsåtgärd
requiredReadAction string

Nödvändig läsåtgärd.

Nödvändig skrivåtgärd
requiredWriteAction string

Nödvändig skrivåtgärd.

Obligatorisk provider
requiredProvider string

Obligatorisk provider.

Typ
type string

Typ.

Id
category.id string

Id.

Tekniskt ID
category.technicalIdentifier string

Teknisk identifierare.

Id
parentCategory.id string

Id.

Tekniskt ID
parentCategory.technicalIdentifier string

Teknisk identifierare.

Id
menuCategory.id string

Id.

Tekniskt ID
menuCategory.technicalIdentifier string

Teknisk identifierare.

Flera val
commandInput.multiSelection string

Flera val.

layoutGroups
commandInput.layoutGroups array of object

Layoutgrupper.

Tekniskt ID
commandInput.layoutGroups.technicalIdentifier string

Teknisk identifierare.

layoutGroupFormats
commandInput.layoutGroups.layoutGroupFormats array of object

Layoutgruppformat.

type
commandInput.layoutGroups.layoutGroupFormats.type string

Typ.

fastighet / egendom
commandInput.layoutGroups.layoutGroupFormats.property string

Egenskap.

egenskaper
commandInput.layoutGroups.layoutGroupFormats.properties array of

Egenskaper.

parameters
commandInput.parameters array of object

Parametrar.

Standardvärde
commandInput.parameters.defaultValue string

Standardvärde.

Tekniskt ID
commandInput.parameters.technicalIdentifier string

Teknisk identifierare.

Schema
commandInput.parameters.schema string

Schemat.

Känslig
commandInput.parameters.sensitive boolean

Känslig.

Krävs
commandInput.parameters.required boolean

Obligatoriskt.

Värde
commandInput.parameters.value string

Värde.

Kommandouppsättning
commandInput.parameters.placeholderEnabled.commandSet boolean

Kommandouppsättning.

Kommandoblock
commandInput.parameters.placeholderEnabled.commandBlock boolean

Kommandoblock.

linkedCommandBlocks
commandInput.parameters.placeholderEnabled.linkedCommandBlocks array of object

Länkade kommandoblock.

technicalIdentifier
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

Teknisk identifierare.

version
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version integer

Version.

layoutGroups
commandOutput.layoutGroups array of object

Layoutgrupper.

Tekniskt ID
commandOutput.layoutGroups.technicalIdentifier string

Teknisk identifierare.

layoutGroupFormats
commandOutput.layoutGroups.layoutGroupFormats array of object

Layoutgruppformat.

type
commandOutput.layoutGroups.layoutGroupFormats.type string

Typ.

fastighet / egendom
commandOutput.layoutGroups.layoutGroupFormats.property string

Egenskap.

egenskaper
commandOutput.layoutGroups.layoutGroupFormats.properties array of

Egenskaper.

parameters
commandOutput.parameters array of object

Parametrar.

Example
commandOutput.parameters.example string

Exempel.

Tekniskt ID
commandOutput.parameters.technicalIdentifier string

Teknisk identifierare.

Schema
commandOutput.parameters.schema string

Schemat.

Känslig
commandOutput.parameters.sensitive boolean

Känslig.

Krävs
commandOutput.parameters.required boolean

Obligatoriskt.

Värde
commandOutput.parameters.value string

Värde.

Kommandouppsättning
commandOutput.parameters.placeholderEnabled.commandSet boolean

Kommandouppsättning.

Kommandoblock
commandOutput.parameters.placeholderEnabled.commandBlock boolean

Commmand Block.

Hämta kommandoblocksjobb för alla auktoriserade organisationer

Hämta kommandoblocksjobb för kommandoblock som du har behörighet att visa.

Parametrar

Name Nyckel Obligatorisk Typ Description
$top objekt
$top string

Returnera endast de första $top objekten.

$skip objekt
$skip string

Antalet objekt att hoppa över.

Välj filter
$select string

$select odatafilter.

Sortera efter
$orderby string

Avgör vilka värden som används för att beställa en samling poster.

Filter
$filter string

En funktion som måste utvärderas till true för att en post ska returneras.

Räkna
$count string

Avgör om antalet objekt ska ingå i en samling.

Returer

Name Sökväg Typ Description
OData-kontext
@odata.context string

OData-kontext.

Antal OData
@odata.count integer

Antal OData.

OData nästa länk
@odata.nextLink string

OData nästa länk

värde
value array of object

Värde.

Id
value.id string

Identifierare.

Kommandoblocks-ID
value.commandBlockId string

Kommandoblocksidentifierare.

Namn på kommandouppsättning
value.commandSetName string

Kommandouppsättningens namn.

Kommandouppsättnings-ID
value.commandSetId string

Kommandouppsättningsidentifierare

Block-ID för kommandouppsättning
value.commandSetBlockId string

Blockidentifierare för kommandouppsättning.

Användar-ID
value.userId string

Identifierare för användare.

Användarens huvudnamn
value.userUpn string

Användarens huvudnamn.

Grupp-ID
value.groupId string

Gruppidentifierare.

Gruppnamn
value.groupName string

Gruppnamn.

Organisations-ID
value.organizationId string

Organisationsidentifierare.

Organisationsnamn
value.organizationName string

Organisationsnamn.

Användaruppnåe för skådespelare
value.actorUserUpn string

Aktörens huvudnamn.

Aktörens organisations-ID
value.actorOrganizationId string

Aktörens organisationsidentifierare.

Namn på aktörsorganisation
value.actorOrganizationName string

Aktörens organisationsnamn.

Läge
value.status string

Status.

Körs på
value.executedOn string

Körs på.

Tekniskt ID för Kommandoblock
value.commandBlockTechnicalIdentifier string

Teknisk identifierare för kommandoblock.

Kommandoblocksversion
value.commandBlockVersion integer

Kommandoblocksversion.

Planerad körning
value.plannedExecution string

Planerad körning.

Schema-ID
value.scheduleId string

Schemaidentifierare.

Schemanamn
value.scheduleName string

Schemats namn.

Hämta kommandoblocksjobb för en viss organisation

Hämta kommandoblocksjobb för kommandoblock som du har behörighet att visa.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID.
organizationId True string

Format – uuid. Unik identifierare för organisationen.

$top objekt
$top string

Returnera endast de första $top objekten.

$skip objekt
$skip string

Antalet objekt att hoppa över.

Välj filter
$select string

$select odatafilter.

Sortera efter
$orderby string

Avgör vilka värden som används för att beställa en samling poster.

Filter
$filter string

En funktion som måste utvärderas till true för att en post ska returneras.

Räkna
$count string

Avgör väder eller inte för att inkludera antalet objekt i en samling.

Returer

Name Sökväg Typ Description
OData-kontext
@odata.context string

OData-kontext.

Antal OData
@odata.count integer

Antal OData.

OData-nästa länk
@odata.nextLink string

OData-nästa länk.

värde
value array of object

Värde.

Id
value.id string

Id.

Kommandoblocks-ID
value.commandBlockId string

Kommandoblocksidentifierare.

Namn på kommandouppsättning
value.commandSetName string

Namn på kommandouppsättning.

Kommandouppsättnings-ID
value.commandSetId string

Kommandouppsättningsidentifierare.

Block-ID för kommandouppsättning
value.commandSetBlockId string

Blockidentifierare för kommandouppsättning.

Användar-ID
value.userId string

Identifierare för användare.

Användar-upn
value.userUpn string

Användarens huvudnamn.

Grupp-ID
value.groupId string

Gruppidentifierare.

Gruppnamn
value.groupName string

Gruppnamn.

Organisations-ID
value.organizationId string

Organisationsidentifierare.

Organisationsnamn
value.organizationName string

Organisationsnamn.

Aktörens huvudnamn
value.actorUserUpn string

Aktörens huvudnamn.

Aktörens organisations-ID
value.actorOrganizationId string

Aktörens organisationsidentifierare.

Namn på aktörsorganisation
value.actorOrganizationName string

Aktörens organisationsnamn.

Läge
value.status string

Status.

Körs på
value.executedOn string

Körs på.

Tekniskt ID för Kommandoblock
value.commandBlockTechnicalIdentifier string

Teknisk identifierare för kommandoblock.

Kommandoblocksversion
value.commandBlockVersion integer

Kommandoblocksversion.

Planerad körning
value.plannedExecution string

Planerad körning.

Schema-ID
value.scheduleId string

Schemaidentifierare.

Schemanamn
value.scheduleName string

Schemats namn.

Hämta kommandokategorier

Hämta alla tillgängliga kategorier och underkategorier.

Parametrar

Name Nyckel Obligatorisk Typ Description
$top objekt
$top string

Returnera endast de första $top objekten.

$skip objekt
$skip string

Antalet objekt att hoppa över.

Välj filter
$select string

$select odatafilter.

Sortera efter
$orderby string

Avgör vilka värden som används för att beställa en samling poster.

Filter
$filter string

En funktion som måste utvärderas till true för att en post ska returneras.

Räkna
$count string

Avgör väder eller inte för att inkludera antalet objekt i en samling.

Returer

Name Sökväg Typ Description
OData-kontext
@odata.context string

OData-kontext.

Antal OData
@odata.count integer

Antal OData.

OData nästa länk
@odata.nextLink string

OData nästa länk.

värde
value array of object

Värde.

Id
value.id string

Id.

Tekniskt ID
value.technicalIdentifier string

Teknisk identifierare.

Överordnat kategori-ID
value.parentCategoryId string

Överordnad kategoriidentifierare.

Hämta nationella inställningar

Hämta nationella inställningar.

Returer

Name Sökväg Typ Description
OData-kontext
@odata.context string

OData-kontext.

Räkna
@odata.count integer

Antal OData.

OData nextLink
@odata.nextLink string

OData-nästa länk.

värde
value array of object

Värde.

Id
value.id string

Språkidentifierare.

Språkkod
value.localeCode string

ISO-639-språkkoder.

Landskod
value.countryCode string

ISO-3166 Landskoder.

Namn på land
value.countryName string

Landsnamn

Hämta organisationer

Hämta alla organisationer som du har behörighet att visa.

Returer

Name Sökväg Typ Description
Antal OData
@odata.count integer

Antal OData.

värde
value array of object

Värde.

Namn
value.name string

Namnet på Azure AD-organisationen.

Microsoft tenantId
value.microsoftTenantId string

Microsofts klient-ID för organisationen.

Skapades den
value.createdOn string

Skapad på.

Ändrades
value.modifiedOn string

Ändrad den.

Id
value.id string

Cloud User Hub-identifierare.

Hämta organisationsprenumererade SKU:er

Hämta listan över kommersiella prenumerationer som en organisation har köpt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Returer

Name Sökväg Typ Description
värde
value array of object

Värde.

Kapacitetsstatus
value.capabilityStatus string

Kapacitetsstatus för Microsoft-sku:n.

Förbrukade enheter
value.consumedUnits integer

Förbrukade enheter för den här sku:n.

Id
value.id string

Identifierare för det prenumererade sku-objektet.

Sku-ID
value.skuId string

SKU-identifierare för Microsoft-licensen.

Sku-delnummer
value.skuPartNumber string

Sku-delnummer för Microsoft-licensen.

Gäller för
value.appliesTo string

Gäller för användare eller organisation.

Enabled
value.prepaidUnits.enabled integer

Aktiverade prenumerations-sku:er.

Upphängd
value.prepaidUnits.suspended integer

Inaktiverade prenumerations-sku:er.

Varning
value.prepaidUnits.warning integer

Prenumererade på sku:er med varning.

servicePlans
value.servicePlans array of object

Tjänstplaner.

servicePlanId
value.servicePlans.servicePlanId string

Serviceplan-identifierare.

servicePlanName
value.servicePlans.servicePlanName string

Serviceplansnamn.

Provisioneringsstatus
value.servicePlans.provisioningStatus string

Etableringsstatus.

gällerTill
value.servicePlans.appliesTo string

Gäller för.

Hämta prenumerationer

Hämtar alla prenumerationer för en partners kund via deras active directory-klientidentifierare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Partneridentifierare för Cloud User Hub.
partnerId True string

Partneridentifierare för Cloud User Hub.

Kundidentifierare för Cloud User Hub.
customerId True string

Kundidentifierare för Cloud User Hub.

Microsofts klient-ID för kunden.
tenantId True string

Microsoft-klientidentifierare för kunden.

Returer

Name Sökväg Typ Description
Totalt antal
totalCount integer

Totalt antal prenumerationsobjekt.

items
items array of object

Objekt.

Id
items.id string

Identifierare för prenumerationen.

Berättigande-ID
items.entitlementId string

Berättigandeidentifierare för prenumerationen.

Vänligt namn
items.friendlyName string

Eget namn på prenumerationen.

Kvantitet
items.quantity integer

Prenumerationens kvantitet.

Enhetstyp
items.unitType string

Prenumerationens enhetstyp.

Skapades den
items.creationDate string

Skapades vid prenumerationens datum.

Effektivt startdatum
items.effectiveStartDate string

Gällande startdatum för prenumerationen.

Slutdatum för åtagande
items.commitmentEndDate string

Slutdatum för åtagandet för prenumerationen.

Läge
items.status string

Status för prenumerationen.

Förnya automatiskt
items.autoRenewEnabled boolean

Anger om automatisk förnyelse är aktiverat för prenumerationen.

Faktureringstyp
items.billingType string

Faktureringstyp för prenumerationen.

Kontraktstyp
items.contractType string

Avtalstyp för prenumerationen.

Uri
items.links.offer.uri string

Uri för prenumerationen.

Metod
items.links.offer.method string

Prenumerationens metod.

headers
items.links.offer.headers array of

Headers.

Uri
items.links.self.uri string

Uri för prenumerationen.

Metod
items.links.self.method string

Prenumerationens metod.

headers
items.links.self.headers array of

Headers.

Order-ID
items.orderId string

Orderidentifierare för prenumerationen.

Etag
items.attributes.etag string

Etag för prenumerationen.

Objekttyp
items.attributes.objectType string

Objekttyp för prenumerationen.

Objekttyp
attributes.objectType string

Objekttyp för prenumerationen.

Hämta statistik om kommandoblockeringsjobb för alla auktoriserade organisationer

Hämta statistik om de kommandoblocksjobb för kommandoblock som du har behörighet att visa.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kategori-ID
categoryId True string

Format – uuid. Unik identifierare för kategorin.

Välj filter
$select string

$select odatafilter.

Returer

Name Sökväg Typ Description
OData-kontext
@odata.context string

OData-kontext.

Typ
type string

Typ.

Kategori
category string

Kategori.

Punkt slut
period string

Period.

Slutfört
completed integer

Fullbordad.

Köad
queued integer

Kö.

Misslyckades
failed integer

Misslyckades.

Lista organisationsdomäner

Hämta en lista över domänobjekt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Returer

Name Sökväg Typ Description
värde
value array of object

Värde.

Autentiseringstyp
value.authenticationType string

Domänens autentiseringstyp.

Tillgänglighetsstatus
value.availabilityStatus string

Tillgänglighetsstatus för domänen.

Id
value.id string

Identifierare för domänen.

Administratörshanterad
value.isAdminManaged boolean

Anger om domänen är administratörshanterad.

Förinställning
value.isDefault boolean

Anger om detta är standarddomänen.

Initial
value.isInitial boolean

Anger om det här är den första domänen.

Rot
value.isRoot boolean

Anger om det här är rotdomänen.

Verifierat
value.isVerified boolean

Anger om domänen har verifierats.

supportedServices
value.supportedServices array of string

Tjänster som stöds.

Lösenords giltighet
value.passwordValidityPeriodInDays integer

Anger lösenordets giltighet i dagar.

Fönster för lösenordsmeddelanden
value.passwordNotificationWindowInDays integer

Anger fönstret för lösenordsavgränsning i dagar.

Stat/län
value.state string

Domänens tillstånd.

Listkommandoblock

Hämta en lista över tillgängliga kommandoblock.

Parametrar

Name Nyckel Obligatorisk Typ Description
$top objekt
$top string

Returnera endast de första $top objekten.

$skip objekt
$skip string

Antalet objekt att hoppa över.

Välj filter
$select string

$select odatafilter.

Sortera efter
$orderby string

Avgör vilka värden som används för att beställa en samling poster.

Filter
$filter string

En funktion som måste utvärderas till true för att en post ska returneras.

Räkna
$count string

Avgör att antalet objekt i en samling inte ska inkluderas.

Returer

Name Sökväg Typ Description
OData-kontext
@odata.context string

OData-kontext.

Antal OData
@odata.count integer

Antal OData.

OData nästa länk
@odata.nextLink string

OData nästa länk.

värde
value array of object

Värde.

Id
value.id string

Identifierare.

Tekniskt ID
value.technicalIdentifier string

Teknisk identifierare.

Typ
value.type string

Typ.

Utgåva
value.version integer

Version.

Kategori-ID
value.categoryId string

Kategoriidentifierare.

Nödvändig läsåtgärd
value.requiredReadAction string

Nödvändig läsåtgärd.

Nödvändig skrivåtgärd
value.requiredWriteAction string

Nödvändig skrivåtgärd.

Obligatorisk provider
value.requiredProvider string

Obligatorisk provider.

Menykategori-ID
value.menuCategory.id string

Identifierare för menykategorin.

Tekniskt ID
value.menuCategory.technicalIdentifier string

Teknisk identifierare.

Överordnat kategori-ID
value.parentCategory.id string

Identifierare för den överordnade kategorin.

Tekniskt ID
value.parentCategory.technicalIdentifier string

Teknisk identifierare.

Id
value.category.id string

ID för kategorin.

Teknisk identifierare
value.category.technicalIdentifier string

Teknisk identifierare.

Lägga till en medlem i en användargrupp

Lägg till en medlem i en användargrupp. Medlemmen ska tillhöra samma organisation som gruppen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Användargrupps-ID för molnanvändarhubben.
userGroupId True string

Molnanvändarhubbens användargruppsidentifierare.

Användar-ID för Cloud User Hub.
userId True string

Cloud User Hub-användaridentifierare.

Lägga till en medlem i en grupp

Lägg till en medlem i en Microsoft 365-grupp eller en säkerhetsgrupp via navigeringsegenskapen medlemmar.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objekt-ID för gruppen.
microsoftObjectId True string

Microsoft-objektidentifierare för gruppen.

Medlem
@odata.id True string

URI för den katalog, användare, grupp eller organisationskontakt som ska läggas till.

Lägga till ett kommandoblocksjobb för en användare

Lägg till ett kommandoblocksjobb. Providern och åtgärdsverifieringen baseras på det specifika kommandoblocket.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID
organizationId True string

Format – uuid. Unik identifierare för organisationen.

Kommandoblocks-ID
commandBlockId True string

Format – uuid. Unik identifierare för kommandoblocket.

Målanvändar-ID
targetUserId True string

Format – uuid. Unik identifierare för målanvändaren.

Tekniskt ID
technicalIdentifier string

Teknisk identifierare.

Värde
value string

Värde.

Schema-ID
scheduleId string

Schemaidentifierare.

Returer

Name Sökväg Typ Description
Värde
value string

Värde.

Lägga till ett kommandoblocksjobb för en grupp

Lägg till ett kommandoblocksjobb. Providern och åtgärdsverifieringen baseras på det specifika kommandoblocket.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID
organizationId True string

Format – uuid. Unik identifierare för organisationen.

Kommandoblocks-ID
commandBlockId True string

Format – uuid. Unik identifierare för kommandoblocket.

Målgrupps-ID
targetGroupId True string

Format – uuid. Unik identifierare för målgruppen.

Tekniskt ID
technicalIdentifier string

Teknisk identifierare.

Värde
value string

Värde.

Schema-ID
scheduleId string

Schemaidentifierare.

Returer

Name Sökväg Typ Description
Värde
value string

Värde.

Lägga till ett kommandoblocksjobb för en organisation

Lägg till ett kommandoblocksjobb. Providern och åtgärdsverifieringen baseras på det specifika kommandoblocket.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID
organizationId True string

Format – uuid. Unik identifierare för organisationen.

Kommandoblocks-ID
commandBlockId True string

Format – uuid. Unik identifierare för kommandoblocket.

Målorganisations-ID
targetOrganizationId True string

Format – uuid. Unik identifierare för målorganisationen.

Tekniskt ID
technicalIdentifier string

Teknisk identifierare

Värde
value string

Värde.

Schema-ID
scheduleId string

Schemaidentifierare.

Returer

Name Sökväg Typ Description
Värde
value string

Värde.

Skapa användare

Begärandetexten innehåller användaren som ska skapas. Du måste minst ange de egenskaper som krävs för användaren. Du kan också ange andra skrivbara egenskaper.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Konto aktiverat
accountEnabled boolean

Kontot har aktiverat sant eller falskt.

Visningsnamn
displayName string

Visningsnamn är användarens fullständiga namn.

Smeknamn för e-post
mailNickname string

Användarens smeknamn för e-post.

Användarens huvudnamn
userPrincipalName string

Användarens huvudnamn.

Framtvinga ändringslösenord vid nästa inloggning
forceChangePasswordNextSignIn boolean

Tvinga användaren att ändra lösenordet vid nästa inloggning.

Lösenord
password string

Nytt lösenord för användaren.

Returer

Name Sökväg Typ Description
OData-kontext
@odata.context string

OData-kontext.

Id
id string

Identifierare för molnanvändarhubben.

businessPhones
businessPhones array of string

Användarens företagstelefoner.

Visningsnamn
displayName string

Visningsnamn är användarens fullständiga namn.

Förnamn
givenName string

Förnamn.

Befattning
jobTitle string

Användarens befattning.

Postadress
mail string

Användarens e-postadress.

Mobiltelefon
mobilePhone string

Användarens mobiltelefonnummer.

Office-plats
officeLocation string

Office-plats för användaren.

Önskat språk
preferredLanguage string

Önskat språk som konfigurerats i Azure AD.

Surname
surname string

Användarens efternamn.

Användarens huvudnamn
userPrincipalName string

Användarens huvudnamn.

Skapa Azure AD-grupp

Skapa azure AD-grupp.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Description
description string

Beskrivning av gruppen.

Visningsnamn
displayName string

Visningsnamn för gruppen.

groupTypes
groupTypes array of string

Grupptyper.

E-post aktiverat
mailEnabled boolean

Anger om gruppen är e-postaktiverad.

Smeknamn för e-post
mailNickname string

E-post smeknamn för gruppen.

Säkerhet aktiverad
securityEnabled boolean

Anger om gruppen är säkerhetsaktiverad.

Returer

Name Sökväg Typ Description
Id
id string

Identifierare för gruppen.

Borttagen den
deletedDateTime string

Har tagits bort.

Classification
classification string

Klassificering av gruppen.

Skapades den
createdDateTime string

Skapad på.

creationOptions
creationOptions array of string

Skapandealternativ.

Description
description string

Description.

Visningsnamn
displayName string

Visningsnamn.

groupTypes
groupTypes array of string

groupTypes

Postadress
mail string

E-postadress till gruppen.

E-post aktiverat
mailEnabled boolean

Anger att gruppen är e-postaktiverad.

Smeknamn för e-post
mailNickname string

E-post smeknamn för gruppen.

Lokal senaste synkronisering
onPremisesLastSyncDateTime string

Anger när gruppen synkroniserades till lokalt.

Lokal säkerhetsidentifierare
onPremisesSecurityIdentifier string

Lokal säkerhetsidentifierare för gruppen.

Lokal synkronisering aktiverad
onPremisesSyncEnabled string

Anger om lokal synkronisering är aktiverat.

Önskad dataplats
preferredDataLocation string

Önskad dataplats för gruppen.

proxyadresser
proxyAddresses array of string

Proxyadresser.

Förnyad
renewedDateTime string

Förnyad datumtid för gruppen.

resourceBehaviorOptions
resourceBehaviorOptions array of string

Alternativ för resursbeteende.

resourceProvisioningOptions
resourceProvisioningOptions array of string

Alternativ för resursprovsion.

Säkerhet aktiverad
securityEnabled boolean

Anger om gruppen är säkerhetsaktiverad.

Visbilitet
visibility string

Synlighet för gruppen.

onPremisesProvisioningErrors
onPremisesProvisioningErrors array of string

Lokala etableringsfel.

Ta bort användare

Ta bort en användare. När de tas bort flyttas användarresurser till en tillfällig container och kan återställas inom 30 dagar. Efter den tiden tas de bort permanent.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objekt-ID för användaren.
microsoftObjectId True string

Microsoft-objektidentifierare för användaren.

Ta bort användargrupp för molnanvändarhubben

Ta bort en användargrupp.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Cloud User Hub-identifierare för användargruppen.
userGroupId True string

Cloud User Hub-identifierare för användargruppen.

Ta bort en medlem från en användargrupp

Ta bort en medlem till en användargrupp.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Användargrupps-ID för molnanvändarhubben.
userGroupId True string

Molnanvändarhubbens användargruppsidentifierare.

Användar-ID för Cloud User Hub.
userId True string

Cloud User Hub-användaridentifierare.

Ta bort medlem

Ta bort en medlem från en grupp via navigeringsegenskapen medlemmar.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objekt-ID för gruppen.
groupMicrosoftObjectId True string

Microsoft-objektidentifierare för gruppen.

Microsoft-objekt-ID för användaren.
userMicrosoftObjectId True string

Microsoft-objektidentifierare för användaren.

Tilldela en licens till en användare

Lägga till eller ta bort licenser för användaren. Du kan också aktivera och inaktivera specifika planer som är associerade med en licens.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objekt-ID för användaren.
microsoftObjectId True string

Microsoft-objektidentifierare för användaren.

disabledPlans
disabledPlans array of

Inaktiverade planer.

Sku-ID
skuId string

SKU-identifierare för Microsoft-licensen.

Ta bort licenser
removeLicenses array of

En samling GUID:er som identifierar de licenser som ska avlägsnas.

Returer

Name Sökväg Typ Description
värde
value array of object

Värde.

Id
value.id string

Identifierare för licensobjektet.

Sku-ID
value.skuId string

Microsoft sku-identifierare.

Sku-delnummer
value.skuPartNumber string

Microsoft Sku-delnummer.

servicePlans
value.servicePlans array of object

Tjänstplaner.

servicePlanId
value.servicePlans.servicePlanId string

Serviceplan-identifierare.

servicePlanName
value.servicePlans.servicePlanName string

Serviceplansnamn.

Provisioneringsstatus
value.servicePlans.provisioningStatus string

Etableringsstatus.

gällerTill
value.servicePlans.appliesTo string

Gäller för.

Uppdatera prenumerationskvantitet

Uppdatera kvantiteten för en prenumeration.

Parametrar

Name Nyckel Obligatorisk Typ Description
Partner-ID för Cloud User Hub.
partnerId True string

Partneridentifierare för Cloud User Hub.

Kund-ID för Cloud User Hub.
customerId True string

Kundidentifierare för Cloud User Hub.

Kundens Klient-ID för Microsoft.
tenantId True string

Microsoft-klientidentifierare för kunden.

Underiptions-ID.
subscriptionId True string

Kundens prenumerationsidentifierare.

Kvantitet
quantity integer

Prenumerationens kvantitet.

Ändra lösenord för användare

Uppdatera lösenordsprofilen för en användare för att återställa lösenordet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Organisations-ID för Cloud User Hub.
organizationId True string

Molnanvändarhubbens organisationsidentifierare.

Microsoft-objekt-ID för användaren.
microsoftObjectId True string

Microsoft-objektidentifierare för användaren.

Framtvinga lösenordsändring vid inloggning
forceChangePasswordNextSignIn boolean

Tvinga användaren att ändra lösenordet vid nästa inloggning.

Lösenord
password string

Nytt lösenord att ange.