Partilhar via


N-able Cloud User Hub (Pré-visualização)

O Cloud User Hub é um portal CSP unificado da Microsoft que permite automatizar tarefas comuns em todos os aplicativos do Microsoft 365 sem alternar entre consoles ou clientes.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte ao Cloud User Hub
URL https://documentation.clouduserhub.management/kb/en
Email technicalsupport@n-able.com
Metadados do conector
Editora N-able Cloud User Hub B.V.
Sítio Web https://www.n-able.com
Política de privacidade https://www.n-able.com/legal/privacy
Categorias Gestão de Negócios;Operações de TI

O Cloud User Hub é um portal CSP unificado da Microsoft que permite automatizar tarefas comuns em todos os aplicativos do Microsoft 365 sem alternar entre consoles ou clientes.

Pré-requisitos

Você precisará do seguinte para prosseguir:

  • Uma assinatura do Cloud User Hub
  • Soluções configuradas no Cloud User Hub para as operações específicas que pretende utilizar
  • Funções configuradas no Cloud User Hub para as operações específicas que você pretende usar.

Como obter credenciais

Você pode fazer login com qualquer conta configurada para acessar o Cloud User Hub. Para cenários de automação, recomendamos que você use uma conta de serviço dedicada.

Introdução ao conector

Comece com Obter organizações, para recuperar uma lista de organizações que você tem permissão para gerenciar (incluindo a sua). As organizações são retornadas de acordo com os escopos de função configurados no Cloud User Hub. Use os Ids para chamadas consecutivas. Para operações que exigiam um ID de parceiro, use o Id de sua própria organização. Para algumas operações, você precisará de um ID de locatário em vez do ID interno do Cloud User Hub, ou ambos.

Problemas conhecidos e limitações

Algumas operações exigem que a organização de destino tenha uma licença do Microsoft 365 correspondente e/ou uma assinatura ativa do Azure. Por exemplo: configurar o acesso condicional, requer uma licença Premium do Microsoft Entra ID.

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar um membro a um grupo

Adicione um membro a um grupo do Microsoft 365 ou a um grupo de segurança através da propriedade de navegação members.

Adicionar um membro a um grupo de utilizadores

Adicionar um membro a um grupo de usuários, o membro deve pertencer à mesma organização que o grupo.

Adicionar um trabalho de Bloco de Comandos para um grupo

Adicione um trabalho de Bloco de Comandos. A validação do provedor e da ação é baseada no Bloco de Comando específico.

Adicionar um trabalho de Bloco de Comandos para um usuário

Adicione um trabalho de Bloco de Comandos. A validação do provedor e da ação é baseada no Bloco de Comando específico.

Adicionar um trabalho de Bloco de Comandos para uma organização

Adicione um trabalho de Bloco de Comandos. A validação do provedor e da ação é baseada no Bloco de Comando específico.

Alterar palavra-passe do utilizador

Atualize o perfil de senha de um usuário para redefinir sua senha.

Atribuir uma licença a um utilizador

Adicione ou remova licenças para o usuário. Também pode ativar e desativar planos específicos associados a uma licença.

Atualizar quantidade de subscrição

Atualize a quantidade de uma assinatura.

Criar grupo do Azure AD

Crie o grupo azure AD.

Criar utilizador

O corpo da solicitação contém o usuário a ser criado. No mínimo, você deve especificar as propriedades necessárias para o usuário. Opcionalmente, você pode especificar quaisquer outras propriedades graváveis.

Excluir grupo de usuários do Cloud User Hub

Excluir um grupo de usuários.

Excluir usuário

Excluir um usuário. Quando excluídos, os recursos do usuário são movidos para um contêiner temporário e podem ser restaurados dentro de 30 dias. Após esse período, eles são excluídos permanentemente.

Listar blocos de comando

Recupere uma lista de Blocos de Comandos disponíveis.

Listar domínios da organização

Recupere uma lista de objetos de domínio.

Obter categorias de comando

Obtenha todas as categorias e subcategorias disponíveis.

Obter detalhes da licença de usuário

Recupere uma lista de objetos de detalhes de licença para usuários corporativos.

Obter detalhes de um trabalho de usuário único

Obter detalhes de um único trabalho de usuário, provedor e validação de ação dependem do bloco de comando específico.

Obter detalhes do Bloco de Comandos

Obtenha os detalhes de um Bloco de Comandos. A validação do provedor e da ação depende do Bloco de Comandos específico.

Obter detalhes do utilizador

Obter um usuário pelo identificador de objeto da Microsoft.

Obter estatísticas sobre os trabalhos do Bloco de Comando para todas as organizações autorizadas

Obtenha estatísticas sobre os trabalhos de Bloco de Comando para Blocos de Comando que você está autorizado a visualizar.

Obter grupos de segurança do Azure AD

Obtenha uma lista de grupos de segurança do Azure AD de todas as organizações que você está autorizado a exibir.

Obter grupos de usuários do Cloud User Hub

Obtenha uma lista de grupos de todas as organizações que você está autorizado a visualizar.

Obter localidades

Obtenha localidades.

Obter organizações

Obtenha todas as organizações que você está autorizado a visualizar.

Obter SKUs inscritos na organização

Obtenha a lista de subscrições comerciais adquiridas por uma organização.

Obter subscrições

Recupera todas as assinaturas para o cliente de um parceiro por seu identificador de locatário do Ative Directory.

Obter trabalhos de Bloco de Comando para todas as organizações autorizadas

Obter trabalhos de Bloco de Comandos para Blocos de Comandos que está autorizado a visualizar.

Obter trabalhos do Bloco de Comandos de uma organização específica

Obter trabalhos de Bloco de Comandos para Blocos de Comandos que está autorizado a visualizar.

Obter uma lista de membros do grupo de usuários do Cloud User Hub

Obtenha uma lista de membros do grupo de usuários de um grupo específico.

Obter utilizadores

Recupere uma lista de objetos de usuário.

Remover membro

Remova um membro de um grupo através da propriedade de navegação members.

Remover um membro de um grupo de utilizadores

Remover um membro para um grupo de usuários.

Adicionar um membro a um grupo

Adicione um membro a um grupo do Microsoft 365 ou a um grupo de segurança através da propriedade de navegação members.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID de objeto da Microsoft do grupo.
microsoftObjectId True string

Identificador de objeto da Microsoft do grupo.

Membro
@odata.id True string

URI do diretório, usuário, grupo ou objeto de contato organizacional a ser adicionado.

Adicionar um membro a um grupo de utilizadores

Adicionar um membro a um grupo de usuários, o membro deve pertencer à mesma organização que o grupo.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID do grupo de usuários do Cloud User Hub.
userGroupId True string

Identificador do grupo de usuários do Cloud User Hub.

ID de usuário do Cloud User Hub.
userId True string

Identificador de usuário do Cloud User Hub.

Adicionar um trabalho de Bloco de Comandos para um grupo

Adicione um trabalho de Bloco de Comandos. A validação do provedor e da ação é baseada no Bloco de Comando específico.

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

Formato - uuid. Identificador exclusivo da organização.

ID do bloco de comandos
commandBlockId True string

Formato - uuid. Identificador exclusivo do bloco de comandos.

ID do grupo-alvo
targetGroupId True string

Formato - uuid. Identificador único do grupo-alvo.

Identificação técnica
technicalIdentifier string

Identificador Técnico.

Valor
value string

valor.

ID da agenda
scheduleId string

Identificador de agendamento.

Devoluções

Name Caminho Tipo Description
Valor
value string

valor.

Adicionar um trabalho de Bloco de Comandos para um usuário

Adicione um trabalho de Bloco de Comandos. A validação do provedor e da ação é baseada no Bloco de Comando específico.

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

Formato - uuid. Identificador exclusivo da organização.

ID do bloco de comandos
commandBlockId True string

Formato - uuid. Identificador exclusivo do bloco de comandos.

ID do usuário alvo
targetUserId True string

Formato - uuid. Identificador exclusivo do usuário alvo.

Identificação técnica
technicalIdentifier string

Identificador Técnico.

Valor
value string

valor.

ID da agenda
scheduleId string

Identificador de agendamento.

Devoluções

Name Caminho Tipo Description
Valor
value string

valor.

Adicionar um trabalho de Bloco de Comandos para uma organização

Adicione um trabalho de Bloco de Comandos. A validação do provedor e da ação é baseada no Bloco de Comando específico.

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

Formato - uuid. Identificador exclusivo da organização.

ID do bloco de comandos
commandBlockId True string

Formato - uuid. Identificador exclusivo do bloco de comandos.

ID da organização de destino
targetOrganizationId True string

Formato - uuid. Identificador exclusivo da organização de destino.

Identificação técnica
technicalIdentifier string

Identificador técnico

Valor
value string

valor.

ID da agenda
scheduleId string

Identificador de agendamento.

Devoluções

Name Caminho Tipo Description
Valor
value string

valor.

Alterar palavra-passe do utilizador

Atualize o perfil de senha de um usuário para redefinir sua senha.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID de objeto da Microsoft do usuário.
microsoftObjectId True string

Identificador de objeto da Microsoft do usuário.

Forçar alteração de palavra-passe ao iniciar sessão
forceChangePasswordNextSignIn boolean

Forçar o usuário a alterar a senha no próximo login.

Palavra-passe
password string

Nova senha para definir.

Atribuir uma licença a um utilizador

Adicione ou remova licenças para o usuário. Também pode ativar e desativar planos específicos associados a uma licença.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID de objeto da Microsoft do usuário.
microsoftObjectId True string

Identificador de objeto da Microsoft do usuário.

deficientesPlanos
disabledPlans array of

Planos para deficientes.

ID do Sku
skuId string

Identificador Sku da licença da Microsoft.

Remover licenças
removeLicenses array of

Uma coleção de GUIDs que identificam as licenças a serem removidas.

Devoluções

Name Caminho Tipo Description
valor
value array of object

valor.

Id
value.id string

Identificador do objeto de licença.

ID do Sku
value.skuId string

Identificador de sku da Microsoft.

Número de peça Sku
value.skuPartNumber string

Número de peça Microsoft Sku.

Planos de Serviço
value.servicePlans array of object

Planos de serviço.

servicePlanId
value.servicePlans.servicePlanId string

Identificador do plano de serviço.

servicePlanName
value.servicePlans.servicePlanName string

Nome do plano de serviço.

estadoDeProvisionamento
value.servicePlans.provisioningStatus string

Status de provisionamento.

aplica-seTo
value.servicePlans.appliesTo string

Aplica-se a.

Atualizar quantidade de subscrição

Atualize a quantidade de uma assinatura.

Parâmetros

Name Chave Necessário Tipo Description
ID do parceiro do Cloud User Hub.
partnerId True string

Identificador de parceiro do Cloud User Hub.

ID do cliente do Cloud User Hub.
customerId True string

Identificador do cliente do Cloud User Hub.

ID de locatário da Microsoft do cliente.
tenantId True string

Identificador de locatário da Microsoft do cliente.

Subsription id.
subscriptionId True string

Identificador de subscrição do cliente.

Quantidade
quantity integer

Quantidade da assinatura.

Criar grupo do Azure AD

Crie o grupo azure AD.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

Description
description string

Descrição do grupo.

Nome de exibição
displayName string

Nome para exibição do grupo.

groupTypes
groupTypes array of string

Tipos de grupo.

Correio ativado
mailEnabled boolean

Indica se o grupo está habilitado para email.

Apelido do e-mail
mailNickname string

Apelido de correio do grupo.

Segurança ativada
securityEnabled boolean

Indica se o grupo está habilitado para segurança.

Devoluções

Name Caminho Tipo Description
Id
id string

Identificador do grupo.

Suprimido em
deletedDateTime string

Suprimido em.

Classification
classification string

Classificação do grupo.

Criado a
createdDateTime string

Criado em.

criaçãoOpções
creationOptions array of string

Opções de criação.

Description
description string

Description.

Nome de exibição
displayName string

Nome para exibição.

groupTypes
groupTypes array of string

groupTypes

Correio
mail string

Endereço de e-mail do grupo.

Correio ativado
mailEnabled boolean

Indica que o grupo está habilitado para email.

Apelido do e-mail
mailNickname string

Apelido de correio do grupo.

Última sincronização no local
onPremisesLastSyncDateTime string

Indica quando o grupo foi sincronizado no local.

Identificador de segurança local
onPremisesSecurityIdentifier string

Identificador de segurança local do grupo.

Sincronização no local ativada
onPremisesSyncEnabled string

Indica se a sincronização no local está ativada.

Localização de dados preferida
preferredDataLocation string

Localização de dados preferida do grupo.

endereços de proxy
proxyAddresses array of string

Endereços proxy.

Renovado
renewedDateTime string

Data renovada hora do grupo.

resourceBehaviorOptions
resourceBehaviorOptions array of string

Opções de comportamento de recursos.

resourceProvisioningOptions
resourceProvisioningOptions array of string

Opções de prova de recursos.

Segurança ativada
securityEnabled boolean

Indica se o grupo está habilitado para segurança.

Visibilidade
visibility string

Visibilidade do grupo.

onPremisesProvisioningErrors
onPremisesProvisioningErrors array of string

Erros de provisionamento no local.

Criar utilizador

O corpo da solicitação contém o usuário a ser criado. No mínimo, você deve especificar as propriedades necessárias para o usuário. Opcionalmente, você pode especificar quaisquer outras propriedades graváveis.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

Conta ativada
accountEnabled boolean

Conta ativada como true ou false.

Nome de exibição
displayName string

Nome para exibição do usuário.

Apelido do e-mail
mailNickname string

Apelido de email do usuário.

Nome principal do usuário
userPrincipalName string

Nome principal do usuário do usuário.

Forçar a alteração da palavra-passe no próximo início de sessão
forceChangePasswordNextSignIn boolean

Forçar o usuário a alterar a senha no próximo login.

Palavra-passe
password string

Nova senha para o usuário.

Devoluções

Name Caminho Tipo Description
Contexto OData
@odata.context string

Contexto OData.

Id
id string

Identificador do Cloud User Hub.

businessTelefones
businessPhones array of string

Telefones comerciais do usuário.

Nome de exibição
displayName string

Nome para exibição do usuário.

Nome próprio
givenName string

Nome próprio.

Cargo
jobTitle string

Cargo do usuário.

Correio
mail string

Endereço de e-mail do utilizador.

Telemóvel
mobilePhone string

Número de telemóvel do utilizador.

Localização do escritório
officeLocation string

Localização do escritório do usuário.

Língua preferida
preferredLanguage string

Idioma preferencial conforme configurado no Azure AD.

Surname
surname string

Apelido do utilizador.

Nome Principal do Utilizador
userPrincipalName string

Nome principal do usuário do usuário.

Excluir grupo de usuários do Cloud User Hub

Excluir um grupo de usuários.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

Identificador do Cloud User Hub para o grupo de usuários.
userGroupId True string

Identificador do Cloud User Hub para o grupo de usuários.

Excluir usuário

Excluir um usuário. Quando excluídos, os recursos do usuário são movidos para um contêiner temporário e podem ser restaurados dentro de 30 dias. Após esse período, eles são excluídos permanentemente.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID de objeto da Microsoft do usuário.
microsoftObjectId True string

Identificador de objeto da Microsoft do usuário.

Listar blocos de comando

Recupere uma lista de Blocos de Comandos disponíveis.

Parâmetros

Name Chave Necessário Tipo Description
$top itens
$top string

Devolva apenas os primeiros $top itens.

$skip itens
$skip string

O número de itens a ignorar.

Selecionar filtro
$select string

$select filtro odata.

Encomendar por
$orderby string

Determina quais valores são usados para ordenar uma coleção de registros.

Filter
$filter string

Uma função que deve ser avaliada como true para que um registro seja retornado.

Contar
$count string

Determina não incluir a contagem de itens em uma coleção.

Devoluções

Name Caminho Tipo Description
Contexto OData
@odata.context string

Contexto OData.

Contagem de OData
@odata.count integer

Contagem de OData.

OData próximo link
@odata.nextLink string

OData próximo link.

valor
value array of object

valor.

Id
value.id string

Identificador.

Identificação técnica
value.technicalIdentifier string

Identificador Técnico.

Tipo
value.type string

Digite.

Versão
value.version integer

Versão.

ID da categoria
value.categoryId string

Identificador de categoria.

Ação de leitura necessária
value.requiredReadAction string

Ação de leitura necessária.

Ação de escrita necessária
value.requiredWriteAction string

Ação de escrita necessária.

Provedor necessário
value.requiredProvider string

Provedor necessário.

ID da categoria do menu
value.menuCategory.id string

Identificador da categoria do menu.

Identificação técnica
value.menuCategory.technicalIdentifier string

Identificador Técnico.

ID da categoria pai
value.parentCategory.id string

Identificador da categoria pai.

Identificação técnica
value.parentCategory.technicalIdentifier string

Identificador Técnico.

Id
value.category.id string

Id da categoria.

Identificador técnico
value.category.technicalIdentifier string

Identificador técnico.

Listar domínios da organização

Recupere uma lista de objetos de domínio.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

Devoluções

Name Caminho Tipo Description
valor
value array of object

valor.

Tipo de autenticação
value.authenticationType string

Tipo de autenticação do domínio.

Estado de disponibilidade
value.availabilityStatus string

Status de disponibilidade do domínio.

Id
value.id string

Identificador do domínio.

Administrador gerenciado
value.isAdminManaged boolean

Indica se o domínio é gerenciado por administrador.

Default
value.isDefault boolean

Indica se este é o domínio padrão.

Inicial
value.isInitial boolean

Indica se este é o domínio inicial.

Raiz
value.isRoot boolean

Indica se este é o domínio raiz.

Verificada
value.isVerified boolean

Indica se o domínio é verificado.

Serviços suportados
value.supportedServices array of string

Serviços suportados.

Validade da palavra-passe
value.passwordValidityPeriodInDays integer

Indica a validade da senha em dias.

Janelas de notificação de senha
value.passwordNotificationWindowInDays integer

Indica a janela de notificação de senha em dias.

Estado
value.state string

Estado do domínio.

Obter categorias de comando

Obtenha todas as categorias e subcategorias disponíveis.

Parâmetros

Name Chave Necessário Tipo Description
$top itens
$top string

Devolva apenas os primeiros $top itens.

$skip itens
$skip string

O número de itens a ignorar.

Selecionar filtro
$select string

$select filtro odata.

Encomendar por
$orderby string

Determina quais valores são usados para ordenar uma coleção de registros.

Filter
$filter string

Uma função que deve ser avaliada como true para que um registro seja retornado.

Contar
$count string

Determina o clima ou não para incluir a contagem de itens em uma coleção.

Devoluções

Name Caminho Tipo Description
Contexto OData
@odata.context string

Contexto OData.

Contagem de OData
@odata.count integer

Contagem de OData.

OData próximo link
@odata.nextLink string

OData próximo link.

valor
value array of object

valor.

Id
value.id string

Id.

Identificação técnica
value.technicalIdentifier string

Identificador Técnico.

ID da categoria pai
value.parentCategoryId string

Identificador de categoria pai.

Obter detalhes da licença de usuário

Recupere uma lista de objetos de detalhes de licença para usuários corporativos.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID de objeto da Microsoft do usuário.
microsoftObjectId True string

Identificador de objeto da Microsoft do usuário.

Devoluções

Name Caminho Tipo Description
valor
value array of object

valor.

Id
value.id string

Identificador da licença do utilizador.

ID do Sku
value.skuId string

Identificador Sku da licença da Microsoft.

Número de peça Sku
value.skuPartNumber string

Número de parte Sku da licença da Microsoft.

Planos de Serviço
value.servicePlans array of object

Planos de serviço.

servicePlanId
value.servicePlans.servicePlanId string

Identificador do plano de serviço.

servicePlanName
value.servicePlans.servicePlanName string

Nome do plano de serviço.

estadoDeProvisionamento
value.servicePlans.provisioningStatus string

Status de provisionamento.

aplica-seTo
value.servicePlans.appliesTo string

Aplica-se a.

Obter detalhes de um trabalho de usuário único

Obter detalhes de um único trabalho de usuário, provedor e validação de ação dependem do bloco de comando específico.

Parâmetros

Name Chave Necessário Tipo Description
ID da Organização
organizationId True string

Formato - uuid. Identificador exclusivo da organização.

ID do bloco de comandos
commandBlockId True string

Formato - uuid. Identificador exclusivo do bloco de comandos.

ID do trabalho
jobId True string

Formato - uuid. Identificador exclusivo do trabalho.

Devoluções

Name Caminho Tipo Description
Id
id string

Id.

ID do bloco de comandos
commandBlockId string

Identificador do bloco de comandos.

Nome do conjunto de comandos
commandSetName string

Nome do conjunto de comandos.

ID do conjunto de comandos
commandSetId string

Identificador do conjunto de comandos.

ID do Bloco do Conjunto de Comandos
commandSetBlockId string

Identificador de bloco do conjunto de comandos.

ID do utilizador
userId string

Identificador do utilizador.

Usuário upn
userUpn string

Nome principal do usuário do usuário.

ID do grupo
groupId string

Identificador de grupo.

Nome do grupo
groupName string

Nome do grupo.

ID da organização
organizationId string

Identificador da organização.

Nome da organização
organizationName string

Nome da organização.

Ator upn
actorUserUpn string

Nome principal do usuário do ator.

ID da organização do ator
actorOrganizationId string

Identificador da organização do ator.

Nome da organização do ator
actorOrganizationName string

Nome da organização do ator.

Situação
status string

Estado.

Executado em
executedOn string

Executado em.

ID técnico do Bloco de Comandos
commandBlockTechnicalIdentifier string

Identificador técnico do bloco de comandos.

Versão do Bloco de Comandos
commandBlockVersion integer

Versão do bloco de comandos.

layoutGrupos
output.body.layoutGroups array of object

Formatos de grupo de layout.

layoutGroupFormats
output.body.layoutGroups.layoutGroupFormats array of object

Formatos de grupo de layout.

tipo
output.body.layoutGroups.layoutGroupFormats.type string

Digite.

propriedade
output.body.layoutGroups.layoutGroupFormats.property string

Imóvel.

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

Propriedades.

parameters
output.body.parameters array of object

Parâmetros.

Identificação técnica
output.body.parameters.technicalIdentifier string

Identificador Técnico.

Valor
output.body.parameters.value string

valor.

Schema
output.body.parameters.schema string

Esquema.

Conjunto de comandos
output.body.parameters.placeholderEnabled.commandSet boolean

Conjunto de comandos.

Bloco de comandos
output.body.parameters.placeholderEnabled.commandBlock boolean

Bloco de comandos.

Código de erro
output.errorCode string

Código de erro.

Sucesso
output.isSuccess boolean

Bem-sucedida.

layoutGrupos
input.layoutGroups array of object

Grupos de layout.

layoutGroupFormats
input.layoutGroups.layoutGroupFormats array of object

Formatos de grupo de layout.

tipo
input.layoutGroups.layoutGroupFormats.type string

Digite.

propriedade
input.layoutGroups.layoutGroupFormats.property string

Imóvel.

propriedades
input.layoutGroups.layoutGroupFormats.properties array of string

Propriedades.

Várias organizações
input.multiSelection.multipleOrganizations boolean

Várias organizações.

Vários utilizadores
input.multiSelection.multipleUsers boolean

Vários usuários.

parameters
input.parameters array of object

Parâmetros.

Identificação técnica
input.parameters.technicalIdentifier string

Identificador Técnico.

Valor
input.parameters.value string

valor.

Valor predefinido
input.parameters.defaultValue string

Valor padrão.

Tipo
input.parameters.schema.type string

Digite.

Formato
input.parameters.schema.format string

Formato.

Padrão
input.parameters.schema.pattern string

Padrão.

Comprimento mínimo
input.parameters.schema.minLength string

Comprimento mínimo.

Conjunto de comandos
input.parameters.placeholderEnabled.commandSet boolean

Conjunto de comandos.

Bloco de comandos
input.parameters.placeholderEnabled.commandBlock boolean

Bloco de comandos.

linkedCommandBlocks
input.parameters.placeholderEnabled.linkedCommandBlocks array of object

Blocos de comando vinculados.

technicalIdentifier
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

Identificador Técnico.

versão
input.parameters.placeholderEnabled.linkedCommandBlocks.version integer

Versão.

Obter detalhes do Bloco de Comandos

Obtenha os detalhes de um Bloco de Comandos. A validação do provedor e da ação depende do Bloco de Comandos específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do bloco de comandos
commandBlockId True string

Formato - uuid. Identificador exclusivo do bloco de comandos.

Devoluções

Name Caminho Tipo Description
Id
id string

Id.

Versão
version integer

Versão.

ID da categoria
categoryId string

Id da categoria.

Identificação técnica
technicalIdentifier string

Identificador Técnico.

Ação de leitura necessária
requiredReadAction string

Ação de leitura necessária.

Ação de escrita necessária
requiredWriteAction string

Ação de escrita necessária.

Provedor necessário
requiredProvider string

Provedor necessário.

Tipo
type string

Digite.

Id
category.id string

Id.

Identificação técnica
category.technicalIdentifier string

Identificador Técnico.

Id
parentCategory.id string

Id.

Identificação técnica
parentCategory.technicalIdentifier string

Identificador Técnico.

Id
menuCategory.id string

Id.

Identificação técnica
menuCategory.technicalIdentifier string

Identificador Técnico.

Seleção múltipla
commandInput.multiSelection string

Seleção múltipla.

layoutGrupos
commandInput.layoutGroups array of object

Grupos de layout.

Identificação técnica
commandInput.layoutGroups.technicalIdentifier string

Identificador Técnico.

layoutGroupFormats
commandInput.layoutGroups.layoutGroupFormats array of object

Formatos de grupo de layout.

tipo
commandInput.layoutGroups.layoutGroupFormats.type string

Digite.

propriedade
commandInput.layoutGroups.layoutGroupFormats.property string

Imóvel.

propriedades
commandInput.layoutGroups.layoutGroupFormats.properties array of

Propriedades.

parameters
commandInput.parameters array of object

Parâmetros.

Valor predefinido
commandInput.parameters.defaultValue string

Valor padrão.

Identificação técnica
commandInput.parameters.technicalIdentifier string

Identificador Técnico.

Schema
commandInput.parameters.schema string

Esquema.

Sensível
commandInput.parameters.sensitive boolean

Sensível.

Obrigatório
commandInput.parameters.required boolean

Required.

Valor
commandInput.parameters.value string

valor.

Conjunto de comandos
commandInput.parameters.placeholderEnabled.commandSet boolean

Conjunto de comandos.

Bloco de comandos
commandInput.parameters.placeholderEnabled.commandBlock boolean

Bloco de comandos.

linkedCommandBlocks
commandInput.parameters.placeholderEnabled.linkedCommandBlocks array of object

Blocos de comando vinculados.

technicalIdentifier
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier string

Identificador Técnico.

versão
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version integer

Versão.

layoutGrupos
commandOutput.layoutGroups array of object

Grupos de layout.

Identificação técnica
commandOutput.layoutGroups.technicalIdentifier string

Identificador Técnico.

layoutGroupFormats
commandOutput.layoutGroups.layoutGroupFormats array of object

Formatos de grupo de layout.

tipo
commandOutput.layoutGroups.layoutGroupFormats.type string

Digite.

propriedade
commandOutput.layoutGroups.layoutGroupFormats.property string

Imóvel.

propriedades
commandOutput.layoutGroups.layoutGroupFormats.properties array of

Propriedades.

parameters
commandOutput.parameters array of object

Parâmetros.

Example
commandOutput.parameters.example string

Exemplo.

Identificação técnica
commandOutput.parameters.technicalIdentifier string

Identificador técnico.

Schema
commandOutput.parameters.schema string

Esquema.

Sensível
commandOutput.parameters.sensitive boolean

Sensível.

Obrigatório
commandOutput.parameters.required boolean

Required.

Valor
commandOutput.parameters.value string

valor.

Conjunto de comandos
commandOutput.parameters.placeholderEnabled.commandSet boolean

Conjunto de comandos.

Bloco de comandos
commandOutput.parameters.placeholderEnabled.commandBlock boolean

Bloco Commmand.

Obter detalhes do utilizador

Obter um usuário pelo identificador de objeto da Microsoft.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID de objeto da Microsoft do usuário.
microsoftObjectId True string

Identificador de objeto da Microsoft do usuário.

Devoluções

Name Caminho Tipo Description
Conta ativada
accountEnabled boolean

Conta ativada como true ou false.

ID do funcionário
employeeId string

Identificador de funcionário do usuário.

Nome de exibição
displayName string

Nome para exibição do usuário.

Nome próprio
givenName string

Nome próprio do utilizador.

Surname
surname string

Apelido do utilizador.

Nome principal do usuário
userPrincipalName string

Nome principal do usuário do usuário.

Cargo
jobTitle string

Cargo do usuário.

Departamento
department string

Departamento do usuário.

Nome da empresa
companyName string

Nome da empresa do utilizador.

Usagelocation
usageLocation string

Local de uso do usuário.

Endereço
streetAddress string

Endereço do usuário.

City
city string

Cidade do usuário.

Estado
state string

Estado do utilizador.

Código postal
postalCode string

Código postal do utilizador.

Country
country string

País do utilizador.

Obter estatísticas sobre os trabalhos do Bloco de Comando para todas as organizações autorizadas

Obtenha estatísticas sobre os trabalhos de Bloco de Comando para Blocos de Comando que você está autorizado a visualizar.

Parâmetros

Name Chave Necessário Tipo Description
ID da categoria
categoryId True string

Formato - uuid. Identificador único da categoria.

Selecionar filtro
$select string

$select filtro odata.

Devoluções

Name Caminho Tipo Description
Contexto OData
@odata.context string

Contexto OData.

Tipo
type string

Digite.

Categoria
category string

Categoria.

Período
period string

Ponto final.

Concluído
completed integer

Concluído.

Em fila de espera
queued integer

Enfileirado.

Falha
failed integer

Falhou.

Obter grupos de segurança do Azure AD

Obtenha uma lista de grupos de segurança do Azure AD de todas as organizações que você está autorizado a exibir.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

Devoluções

Name Caminho Tipo Description
valor
value array of object

valor.

Criado a
value.createdDateTime string

Criado em.

Nome de exibição
value.displayName string

Nome para exibição.

groupTypes
value.groupTypes array of string

Tipos de grupo.

Id
value.id string

Identificador de objeto da Microsoft do grupo.

Segurança ativada
value.securityEnabled boolean

Indica se o grupo está habilitado para segurança.

Correio
value.mail string

Endereço de e-mail do grupo.

Obter grupos de usuários do Cloud User Hub

Obtenha uma lista de grupos de todas as organizações que você está autorizado a visualizar.

Parâmetros

Name Chave Necessário Tipo Description
Grupos de filtros.
$filter True string

Filtrar grupos em uma organização. Use: organizationId in ('{organizationId}').

Devoluções

Name Caminho Tipo Description
Contar
@odata.count integer

Contagem de OData.

valor
value array of object

valor.

ID da Organização
value.organizationId string

Identificador da organização do Cloud User Hub.

Nome
value.name string

Nome do grupo.

Description
value.description string

Descrição para o grupo.

Id
value.id string

Identificador do grupo.

Criado a
value.createdOn string

Criado em.

Modificada em
value.modifiedOn string

Modificado em.

Obter localidades

Obtenha localidades.

Devoluções

Name Caminho Tipo Description
Contexto OData
@odata.context string

Contexto OData.

Contar
@odata.count integer

Contagem de OData.

OData nextLink
@odata.nextLink string

OData nextlink.

valor
value array of object

valor.

Id
value.id string

Identificador de localidade.

Código de região
value.localeCode string

Códigos linguísticos ISO-639.

Código do país
value.countryCode string

ISO-3166 Códigos dos países.

Nome do país
value.countryName string

Nome do país.

Obter organizações

Obtenha todas as organizações que você está autorizado a visualizar.

Devoluções

Name Caminho Tipo Description
Contagem de OData
@odata.count integer

Contagem de OData.

valor
value array of object

valor.

Nome
value.name string

Nome da organização do Azure AD.

ID do locatário da Microsoft
value.microsoftTenantId string

Identificador de locatário da Microsoft da organização.

Criado a
value.createdOn string

Criado em.

Modificada em
value.modifiedOn string

Modificado em.

Id
value.id string

Identificador do Cloud User Hub.

Obter SKUs inscritos na organização

Obtenha a lista de subscrições comerciais adquiridas por uma organização.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

Devoluções

Name Caminho Tipo Description
valor
value array of object

valor.

Estado da capacidade
value.capabilityStatus string

Status de capacidade da sku da Microsoft.

Unidades consumidas
value.consumedUnits integer

Unidades consumidas para este sku.

Id
value.id string

Identificador do objeto sku inscrito.

ID do Sku
value.skuId string

Identificador Sku da licença da Microsoft.

Número de peça Sku
value.skuPartNumber string

Número de parte Sku da licença da Microsoft.

Aplica-se a
value.appliesTo string

Aplica-se a usuário ou organização.

Ativado(a)
value.prepaidUnits.enabled integer

Skus subscrito ativado.

Suspenso
value.prepaidUnits.suspended integer

Skus subscrito suspenso.

Advertência
value.prepaidUnits.warning integer

Subscreveu skus com aviso.

Planos de Serviço
value.servicePlans array of object

Planos de serviço.

servicePlanId
value.servicePlans.servicePlanId string

Identificador do plano de serviço.

servicePlanName
value.servicePlans.servicePlanName string

Nome do plano de serviço.

estadoDeProvisionamento
value.servicePlans.provisioningStatus string

Status de provisionamento.

aplica-seTo
value.servicePlans.appliesTo string

Aplica-se a.

Obter subscrições

Recupera todas as assinaturas para o cliente de um parceiro por seu identificador de locatário do Ative Directory.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de parceiro do Cloud User Hub.
partnerId True string

Identificador de parceiro do Cloud User Hub.

Identificador do cliente do Cloud User Hub.
customerId True string

Identificador do cliente do Cloud User Hub.

ID do locatário Microsoft do cliente.
tenantId True string

Identificador de locatário da Microsoft do cliente.

Devoluções

Name Caminho Tipo Description
Contagem total
totalCount integer

Contagem total do objeto de assinatura.

items
items array of object

itens.

Id
items.id string

Identificador da assinatura.

ID do direito
items.entitlementId string

Identificador de direito da assinatura.

Nome amigável
items.friendlyName string

Nome amigável da assinatura.

Quantidade
items.quantity integer

Quantidade da assinatura.

Tipo de unidade
items.unitType string

Tipo de unidade da subscrição.

Criado a
items.creationDate string

Criado na data da assinatura.

Data de início efetiva
items.effectiveStartDate string

Data de início efetiva da subscrição.

Data de fim do compromisso
items.commitmentEndDate string

Data de término do compromisso da assinatura.

Situação
items.status string

Estado da subscrição.

Renovação automática
items.autoRenewEnabled boolean

Indica se a renovação automática está habilitada para a assinatura.

Tipo de faturação
items.billingType string

Tipo de faturação da subscrição.

Tipo de contrato
items.contractType string

Tipo de contrato da subscrição.

Uri
items.links.offer.uri string

Uri da assinatura.

Método
items.links.offer.method string

Método de subscrição.

headers
items.links.offer.headers array of

Cabeçalhos.

Uri
items.links.self.uri string

Uri da assinatura.

Método
items.links.self.method string

Método de subscrição.

headers
items.links.self.headers array of

Cabeçalhos.

ID da encomenda
items.orderId string

Identificador de pedido da assinatura.

Etag
items.attributes.etag string

Etag da assinatura.

Tipo de objeto
items.attributes.objectType string

Tipo de objeto da assinatura.

Tipo de objeto
attributes.objectType string

Tipo de objeto da assinatura.

Obter trabalhos de Bloco de Comando para todas as organizações autorizadas

Obter trabalhos de Bloco de Comandos para Blocos de Comandos que está autorizado a visualizar.

Parâmetros

Name Chave Necessário Tipo Description
$top itens
$top string

Devolva apenas os primeiros $top itens.

$skip itens
$skip string

O número de itens a ignorar.

Selecionar filtro
$select string

$select filtro odata.

Encomendar por
$orderby string

Determina quais valores são usados para ordenar uma coleção de registros.

Filter
$filter string

Uma função que deve ser avaliada como true para que um registro seja retornado.

Contar
$count string

Determina se a contagem de itens deve ser incluída em uma coleção.

Devoluções

Name Caminho Tipo Description
Contexto OData
@odata.context string

Contexto OData.

Contagem de OData
@odata.count integer

Contagem de OData.

OData próximo link
@odata.nextLink string

OData próximo link

valor
value array of object

valor.

Id
value.id string

Identificador.

ID do bloco de comandos
value.commandBlockId string

Identificador do bloco de comandos.

Nome do conjunto de comandos
value.commandSetName string

Nome do conjunto de comandos.

ID do conjunto de comandos
value.commandSetId string

Identificador do conjunto de comandos

ID do Bloco do Conjunto de Comandos
value.commandSetBlockId string

Identificador de bloco do conjunto de comandos.

ID do utilizador
value.userId string

Identificador do utilizador.

Nome principal do usuário
value.userUpn string

Nome principal do usuário.

ID do grupo
value.groupId string

Identificador de grupo.

Nome do grupo
value.groupName string

Nome do grupo.

ID da organização
value.organizationId string

Identificador da organização.

Nome da organização
value.organizationName string

Nome da organização.

Usuário do ator upn
value.actorUserUpn string

Nome principal do usuário do ator.

ID da organização do ator
value.actorOrganizationId string

Identificador da organização do ator.

Nome da organização do ator
value.actorOrganizationName string

Nome da organização do ator.

Situação
value.status string

Estado.

Executado em
value.executedOn string

Executado em.

ID técnico do Bloco de Comandos
value.commandBlockTechnicalIdentifier string

Identificador técnico do bloco de comandos.

Versão do Bloco de Comandos
value.commandBlockVersion integer

Versão do bloco de comandos.

Execução prevista
value.plannedExecution string

Execução prevista.

ID da agenda
value.scheduleId string

Identificador de agendamento.

Nome da agenda
value.scheduleName string

Nome da agenda.

Obter trabalhos do Bloco de Comandos de uma organização específica

Obter trabalhos de Bloco de Comandos para Blocos de Comandos que está autorizado a visualizar.

Parâmetros

Name Chave Necessário Tipo Description
Id da organização.
organizationId True string

Formato - uuid. Identificador exclusivo da organização.

$top itens
$top string

Devolva apenas os primeiros $top itens.

$skip itens
$skip string

O número de itens a ignorar.

Selecionar filtro
$select string

$select filtro odata.

Encomendar por
$orderby string

Determina quais valores são usados para ordenar uma coleção de registros.

Filter
$filter string

Uma função que deve ser avaliada como true para que um registro seja retornado.

Contar
$count string

Determina o clima ou não para incluir a contagem de itens em uma coleção.

Devoluções

Name Caminho Tipo Description
Contexto OData
@odata.context string

Contexto OData.

Contagem de OData
@odata.count integer

Contagem de OData.

OData próximo link
@odata.nextLink string

OData nextlink.

valor
value array of object

valor.

Id
value.id string

Id.

ID do bloco de comandos
value.commandBlockId string

Identificador do bloco de comandos.

Nome do conjunto de comandos
value.commandSetName string

Nome do conjunto de comandos.

ID do conjunto de comandos
value.commandSetId string

Identificador do conjunto de comandos.

ID do Bloco do Conjunto de Comandos
value.commandSetBlockId string

Identificador de bloco do conjunto de comandos.

ID do utilizador
value.userId string

Identificador do utilizador.

Usuário upn
value.userUpn string

Nome principal do usuário.

ID do grupo
value.groupId string

Identificador de grupo.

Nome do grupo
value.groupName string

Nome do grupo.

ID da organização
value.organizationId string

Identificador da organização.

Nome da organização
value.organizationName string

Nome da organização.

Nome principal do usuário do ator
value.actorUserUpn string

Nome principal do usuário do ator.

ID da organização do ator
value.actorOrganizationId string

Identificador da organização do ator.

Nome da organização do ator
value.actorOrganizationName string

Nome da organização do ator.

Situação
value.status string

Estado.

Executado em
value.executedOn string

Executado em.

ID técnico do Bloco de Comandos
value.commandBlockTechnicalIdentifier string

Identificador técnico do bloco de comandos.

Versão do Bloco de Comandos
value.commandBlockVersion integer

Versão do bloco de comandos.

Execução prevista
value.plannedExecution string

Execução prevista.

ID da agenda
value.scheduleId string

Identificador de agendamento.

Nome da agenda
value.scheduleName string

Nome da agenda.

Obter uma lista de membros do grupo de usuários do Cloud User Hub

Obtenha uma lista de membros do grupo de usuários de um grupo específico.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

Identificador do Cloud User Hub do grupo.
userGroupId True string

Identificador do Cloud User Hub do grupo.

Devoluções

Name Caminho Tipo Description
Contar
@odata.count integer

Contagem de OData.

valor
value array of object

valor.

Nome
value.name string

Nome.

Nome principal do usuário
value.upn string

Nome principal do usuário do grupo.

Id
value.id string

Identificador do objeto membro do grupo.

ID do grupo
value.groupId string

Identificador do Cloud User Hub do grupo.

Criado a
value.createdOn string

Criado em.

Modificada em
value.modifiedOn string

Modificado em.

Obter utilizadores

Recupere uma lista de objetos de usuário.

Parâmetros

Name Chave Necessário Tipo Description
Filtrar usuários.
$filter True string

Filtrar usuários em uma organização. Use: organizationId in ('{organizationId}').

Devoluções

Name Caminho Tipo Description
Contagem de OData
@odata.count integer

Contagem de OData.

valor
value array of object

valor.

ID da organização
value.organizationId string

Identificador da organização do Cloud User Hub.

Identificador de objeto da Microsoft
value.microsoftObjectIdentifier string

Identificador de objeto da Microsoft do usuário.

Nome principal do usuário
value.upn string

Nome principal do usuário do usuário.

Nome próprio
value.firstName string

Nome próprio do utilizador.

Apelido
value.lastName string

Apelido do utilizador.

Nome de exibição
value.displayName string

Nome para exibição do usuário.

Linguagem
value.language string

Língua do utilizador.

Localização de utilização
value.usageLocation string

Local de uso do usuário.

Id
value.id string

Identificador do Cloud User Hub do usuário.

Criado em
value.createdOn string

Criado em.

Modificada em
value.modifiedOn string

Modificado em.

Remover membro

Remova um membro de um grupo através da propriedade de navegação members.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID de objeto da Microsoft do grupo.
groupMicrosoftObjectId True string

Identificador de objeto da Microsoft do grupo.

ID de objeto da Microsoft do usuário.
userMicrosoftObjectId True string

Identificador de objeto da Microsoft do usuário.

Remover um membro de um grupo de utilizadores

Remover um membro para um grupo de usuários.

Parâmetros

Name Chave Necessário Tipo Description
ID da organização do Cloud User Hub.
organizationId True string

Identificador da organização do Cloud User Hub.

ID do grupo de usuários do Cloud User Hub.
userGroupId True string

Identificador do grupo de usuários do Cloud User Hub.

ID de usuário do Cloud User Hub.
userId True string

Identificador de usuário do Cloud User Hub.