Hub de Usuário de Nuvem N-able (versão prévia)
O Cloud User Hub é um portal do Microsoft CSP unificado que permite automatizar tarefas comuns em todos os aplicativos do Microsoft 365 sem alternar consoles ou clientes.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao Hub de Usuário de Nuvem |
| URL | https://documentation.clouduserhub.management/kb/en |
| technicalsupport@n-able.com |
| Metadados do conector | |
|---|---|
| Publicador | N-able Cloud User Hub B.V. |
| Site | https://www.n-able.com |
| Política de privacidade | https://www.n-able.com/legal/privacy |
| Categorias | Gerenciamento de Negócios;Operações de TI |
O Cloud User Hub é um portal do Microsoft CSP unificado que permite automatizar tarefas comuns em todos os aplicativos do Microsoft 365 sem alternar consoles ou clientes.
Pré-requisitos
Você precisará do seguinte para continuar:
- Uma assinatura do Cloud User Hub
- Soluções configuradas no Cloud User Hub para as operações específicas que você pretende usar
- Funções configuradas no Hub de Usuário de Nuvem para as operações específicas que você pretende usar.
Como obter credenciais
Você pode fazer logon com qualquer conta configurada para acessar o Cloud User Hub. Para cenários de automação, aconselhamos você a usar uma conta de serviço dedicada.
Introdução ao conector
Comece com As organizações Get, para recuperar uma lista de organizações que você tem permissão para gerenciar (incluindo as suas). As organizações são retornadas de acordo com os escopos de função configurados no Cloud User Hub. Use as IDs para chamadas consecutivas. Para operações que exigiam uma ID de parceiro, use a ID de sua própria organização. Para algumas operações, você precisará de uma ID de locatário em vez da ID interna do Cloud User Hub ou ambas.
Problemas e limitações conhecidos
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 do Microsoft Entra ID Premium.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à 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 por meio da propriedade de navegação de membros. |
| Adicionar um membro a um grupo de usuários |
Adicione um membro a um grupo de usuários, o membro deve pertencer à mesma organização que o grupo. |
| Adicionar um trabalho de Bloco de Comando para um usuário |
Adicionar um trabalho de Bloco de Comandos. O provedor e a validação de ação baseiam-se no bloco de comando específico. |
| Adicionar um trabalho de Bloco de Comandos para um grupo |
Adicionar um trabalho de Bloco de Comandos. O provedor e a validação de ação baseiam-se no bloco de comando específico. |
| Adicionar um trabalho de Bloco de Comandos para uma organização |
Adicionar um trabalho de Bloco de Comandos. O provedor e a validação de ação baseiam-se no bloco de comando específico. |
| Atribuir uma licença a um usuário |
Adicione ou remova licenças para o usuário. Você também pode habilitar e desabilitar planos específicos associados a uma licença. |
| Atualizar quantidade de assinatura |
Atualize a quantidade de uma assinatura. |
| Criar um grupo do Azure AD |
Criar um grupo do Azure AD. |
| Criar usuário |
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, elas serão permanentemente excluídos. |
| Listar blocos de comando |
Recupere uma lista de blocos de comando disponíveis. |
| Listar domínios da organização |
Recupere uma lista de objetos de domínio. |
| Obter assinaturas |
Recupera todas as assinaturas para o cliente de um parceiro pelo identificador de locatário do Active Directory. |
| Obter categorias de comando |
Obtenha todas as categorias e subcategorias disponíveis. |
| Obter detalhes da licença do usuário |
Recupere uma lista de objetos de detalhes da licença para usuários corporativos. |
| Obter detalhes de um único trabalho de usuário |
Obter detalhes de um único trabalho de usuário, provedor e validação de ação depende do bloco de comandos específico. |
| Obter detalhes do Bloco de Comandos |
Obtenha os detalhes de um bloco de comando. A validação do provedor e da ação depende do bloco de comando específico. |
| Obter detalhes do usuário |
Obtenha um usuário pelo identificador de objeto da Microsoft. |
| Obter estatísticas sobre os trabalhos do Bloco de Comandos 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 exibir. |
| 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 exibir. |
| Obter localidades |
Obtenha localidades. |
| Obter organizações |
Obtenha todas as organizações que você está autorizado a exibir. |
| Obter SKUs assinados pela organização |
Obtenha a lista de assinaturas comerciais que uma organização adquiriu. |
| Obter trabalhos de Bloco de Comando de uma organização específica |
Obtenha trabalhos de Bloco de Comando para Blocos de Comando que você está autorizado a exibir. |
| Obter trabalhos do Bloco de Comandos para todas as organizações autorizadas |
Obtenha trabalhos de Bloco de Comando para Blocos de Comando que você está autorizado a exibir. |
| 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 usuários |
Recupere uma lista de objetos de usuário. |
| Remover membro |
Remova um membro de um grupo por meio da propriedade de navegação de membros. |
| Remover um membro de um grupo de usuários |
Remova um membro para um grupo de usuários. |
| Senha de alteração do usuário |
Atualize o perfil de senha de um usuário para redefinir sua senha. |
Adicionar um membro a um grupo
Adicione um membro a um grupo do Microsoft 365 ou a um grupo de segurança por meio da propriedade de navegação de membros.
Parâmetros
| Nome | Chave | Obrigató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 usuários
Adicione um membro a um grupo de usuários, o membro deve pertencer à mesma organização que o grupo.
Parâmetros
| Nome | Chave | Obrigató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 de 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 Comando para um usuário
Adicionar um trabalho de Bloco de Comandos. O provedor e a validação de ação baseiam-se no bloco de comando específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organizationId | True | string |
Formato – uuid. Identificador exclusivo da organização. |
|
ID do bloco de comando
|
commandBlockId | True | string |
Formato – uuid. Identificador exclusivo do Bloco de Comandos. |
|
ID do usuário de destino
|
targetUserId | True | string |
Formato – uuid. Identificador exclusivo do usuário de destino. |
|
ID técnica
|
technicalIdentifier | string |
Identificador técnico. |
|
|
Value
|
value | string |
Valor. |
|
|
ID de agendamento
|
scheduleId | string |
Identificador de agendamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Value
|
value | string |
Valor. |
Adicionar um trabalho de Bloco de Comandos para um grupo
Adicionar um trabalho de Bloco de Comandos. O provedor e a validação de ação baseiam-se no bloco de comando específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organizationId | True | string |
Formato – uuid. Identificador exclusivo da organização. |
|
ID do bloco de comando
|
commandBlockId | True | string |
Formato – uuid. Identificador exclusivo do Bloco de Comandos. |
|
ID do grupo de destino
|
targetGroupId | True | string |
Formato – uuid. Identificador exclusivo do grupo de destino. |
|
ID técnica
|
technicalIdentifier | string |
Identificador técnico. |
|
|
Value
|
value | string |
Valor. |
|
|
ID de agendamento
|
scheduleId | string |
Identificador de agendamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Value
|
value | string |
Valor. |
Adicionar um trabalho de Bloco de Comandos para uma organização
Adicionar um trabalho de Bloco de Comandos. O provedor e a validação de ação baseiam-se no bloco de comando específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organizationId | True | string |
Formato – uuid. Identificador exclusivo da organização. |
|
ID do bloco de comando
|
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. |
|
ID técnica
|
technicalIdentifier | string |
Identificador Técnico |
|
|
Value
|
value | string |
Valor. |
|
|
ID de agendamento
|
scheduleId | string |
Identificador de agendamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Value
|
value | string |
Valor. |
Atribuir uma licença a um usuário
Adicione ou remova licenças para o usuário. Você também pode habilitar e desabilitar planos específicos associados a uma licença.
Parâmetros
| Nome | Chave | Obrigató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. |
|
Planos desabilitados
|
disabledPlans | array of |
Planos desabilitados. |
|
|
ID do SKU
|
skuId | string |
Identificador de 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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
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 partes de SKU
|
value.skuPartNumber | string |
Número de partes do Microsoft Sku. |
|
servicePlans
|
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. |
|
status de provisionamento
|
value.servicePlans.provisioningStatus | string |
Status de provisionamento. |
|
aplica-sePara
|
value.servicePlans.appliesTo | string |
Aplica-se a. |
Atualizar quantidade de assinatura
Atualize a quantidade de uma assinatura.
Parâmetros
| Nome | Chave | Obrigató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 de cliente do Cloud User Hub. |
|
ID do locatário da Microsoft do cliente.
|
tenantId | True | string |
Identificador de locatário da Microsoft do cliente. |
|
ID de subsription.
|
subscriptionId | True | string |
Identificador de assinatura do cliente. |
|
Quantidade
|
quantity | integer |
Quantidade da assinatura. |
Criar um grupo do Azure AD
Criar um grupo do Azure AD.
Parâmetros
| Nome | Chave | Obrigató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 de 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 de email
|
mailNickname | string |
Apelido de email do grupo. |
|
|
Segurança habilitada
|
securityEnabled | boolean |
Indica se o grupo está habilitado para segurança. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificador do grupo. |
|
Excluído em
|
deletedDateTime | string |
Excluído. |
|
Classification
|
classification | string |
Classificação do grupo. |
|
Criado em
|
createdDateTime | string |
Criado em. |
|
creationOptions
|
creationOptions | array of string |
Opções de criação. |
|
Description
|
description | string |
Descrição. |
|
Nome de exibição
|
displayName | string |
Nome de exibição. |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
Mail
|
string |
Endereço de email do grupo. |
|
|
Correio ativado
|
mailEnabled | boolean |
Indica que o grupo está habilitado para email. |
|
Apelido de email
|
mailNickname | string |
Apelido de email do grupo. |
|
Última sincronização local
|
onPremisesLastSyncDateTime | string |
Indica quando o grupo foi sincronizado com o local. |
|
Identificador de segurança local
|
onPremisesSecurityIdentifier | string |
Identificador de segurança local do grupo. |
|
Sincronização local habilitada
|
onPremisesSyncEnabled | string |
Indica se a sincronização local está habilitada. |
|
Local de dados preferencial
|
preferredDataLocation | string |
Local de dados preferencial do grupo. |
|
endereços de proxy
|
proxyAddresses | array of string |
Endereços proxy. |
|
Renovada
|
renewedDateTime | string |
Hora da data renovada do grupo. |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
Opções de comportamento de recurso. |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
Opções de provsionamento de recursos. |
|
Segurança habilitada
|
securityEnabled | boolean |
Indica se o grupo está habilitado para segurança. |
|
Visabilidade
|
visibility | string |
Visibilidade do grupo. |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
Erros de provisionamento local. |
Criar usuário
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização do Cloud User Hub.
|
organizationId | True | string |
Identificador da organização do Cloud User Hub. |
|
Conta habilitada
|
accountEnabled | boolean |
Conta habilitada como true ou false. |
|
|
Nome de exibição
|
displayName | string |
Nome de exibição do usuário. |
|
|
Apelido de email
|
mailNickname | string |
Apelido de email do usuário. |
|
|
Nome Principal do Usuário
|
userPrincipalName | string |
Nome principal de utilizador do utilizador. |
|
|
Forçar alteração de senha na próxima entrada
|
forceChangePasswordNextSignIn | boolean |
Force o usuário a alterar a senha na próxima entrada. |
|
|
Senha
|
password | string |
Nova senha para o usuário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contexto OData
|
@odata.context | string |
Contexto OData. |
|
ID
|
id | string |
Identificador do Hub de Usuário de Nuvem. |
|
businessPhones
|
businessPhones | array of string |
Telefones comerciais do usuário. |
|
Nome de exibição
|
displayName | string |
Nome de exibição do usuário. |
|
Nome indicado
|
givenName | string |
Nome. |
|
Cargo
|
jobTitle | string |
Cargo do usuário. |
|
Mail
|
string |
Endereço de email do usuário. |
|
|
Telefone celular
|
mobilePhone | string |
Número de telefone celular do usuário. |
|
Localização do Office
|
officeLocation | string |
Local do Office do usuário. |
|
Idioma preferencial
|
preferredLanguage | string |
Idioma preferencial conforme configurado no Azure AD. |
|
Surname
|
surname | string |
Sobrenome do usuário. |
|
Nome Principal do Usuário
|
userPrincipalName | string |
Nome principal de utilizador do utilizador. |
Excluir grupo de usuários do Cloud User Hub
Excluir um grupo de usuários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização do Cloud User Hub.
|
organizationId | True | string |
Identificador da organização do Cloud User Hub. |
|
Identificador do Hub de Usuário de Nuvem para o grupo de usuários.
|
userGroupId | True | string |
Identificador do Hub de Usuário de Nuvem 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, elas serão permanentemente excluídos.
Parâmetros
| Nome | Chave | Obrigató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 comando disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Itens de $top
|
$top | string |
Retornar somente os primeiros $top itens. |
|
|
Itens de $skip
|
$skip | string |
O número de itens a serem ignorados. |
|
|
Selecionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordem 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. |
|
|
Contagem
|
$count | string |
Determina não incluir a contagem de itens em uma coleção. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contexto OData
|
@odata.context | string |
Contexto OData. |
|
Contagem de OData
|
@odata.count | integer |
Contagem de OData. |
|
Próximo link do OData
|
@odata.nextLink | string |
Próximo link do OData. |
|
value
|
value | array of object |
Valor. |
|
ID
|
value.id | string |
Identificador. |
|
ID técnica
|
value.technicalIdentifier | string |
Identificador técnico. |
|
Tipo
|
value.type | string |
Tipo. |
|
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 gravação necessária
|
value.requiredWriteAction | string |
Ação de gravação necessária. |
|
Provedor necessário
|
value.requiredProvider | string |
Provedor necessário. |
|
ID da categoria do menu
|
value.menuCategory.id | string |
Identificador da categoria de menu. |
|
ID técnica
|
value.menuCategory.technicalIdentifier | string |
Identificador técnico. |
|
ID da categoria pai
|
value.parentCategory.id | string |
Identificador da categoria pai. |
|
ID 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização do Cloud User Hub.
|
organizationId | True | string |
Identificador da organização do Cloud User Hub. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Tipo de autenticação
|
value.authenticationType | string |
Tipo de autenticação do domínio. |
|
Status 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 pelo administrador. |
|
Padrão
|
value.isDefault | boolean |
Indica se esse é o domínio padrão. |
|
Inicial
|
value.isInitial | boolean |
Indica se esse é o domínio inicial. |
|
Raiz
|
value.isRoot | boolean |
Indica se esse é o domínio raiz. |
|
Verificado(a)
|
value.isVerified | boolean |
Indica se o domínio foi verificado. |
|
supportedServices
|
value.supportedServices | array of string |
Serviços com suporte. |
|
Validade da senha
|
value.passwordValidityPeriodInDays | integer |
Indica a validade da senha em dias. |
|
Janelas de notificação por senha
|
value.passwordNotificationWindowInDays | integer |
Indica a janela de notifcação de senha em dias. |
|
Estado
|
value.state | string |
Estado do domínio. |
Obter assinaturas
Recupera todas as assinaturas para o cliente de um parceiro pelo identificador de locatário do Active Directory.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de parceiro do Cloud User Hub.
|
partnerId | True | string |
Identificador de parceiro do Cloud User Hub. |
|
Identificador de cliente do Cloud User Hub.
|
customerId | True | string |
Identificador de cliente do Cloud User Hub. |
|
ID do locatário da Microsoft do cliente.
|
tenantId | True | string |
Identificador de locatário da Microsoft do cliente. |
Retornos
| Nome | 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 assinatura. |
|
Criado em
|
items.creationDate | string |
Criado na data da assinatura. |
|
Data de início efetiva
|
items.effectiveStartDate | string |
Data de início efetiva da assinatura. |
|
Data de término do compromisso
|
items.commitmentEndDate | string |
Data de término do compromisso da assinatura. |
|
Situação
|
items.status | string |
Status da assinatura. |
|
Renovação automática
|
items.autoRenewEnabled | boolean |
Indica se a renovação automática está habilitada para a assinatura. |
|
Tipo de cobrança
|
items.billingType | string |
Tipo de cobrança da assinatura. |
|
Tipo de contrato
|
items.contractType | string |
Tipo de contrato da assinatura. |
|
Uri
|
items.links.offer.uri | string |
Uri da assinatura. |
|
Método
|
items.links.offer.method | string |
Método da assinatura. |
|
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 da assinatura. |
|
headers
|
items.links.self.headers | array of |
Cabeçalhos. |
|
ID do pedido
|
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 categorias de comando
Obtenha todas as categorias e subcategorias disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Itens de $top
|
$top | string |
Retornar somente os primeiros $top itens. |
|
|
Itens de $skip
|
$skip | string |
O número de itens a serem ignorados. |
|
|
Selecionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordem 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. |
|
|
Contagem
|
$count | string |
Determina o clima ou não para incluir a contagem de itens em uma coleção. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contexto OData
|
@odata.context | string |
Contexto OData. |
|
Contagem de OData
|
@odata.count | integer |
Contagem de OData. |
|
Próximo link do OData
|
@odata.nextLink | string |
Próximo link do OData. |
|
value
|
value | array of object |
Valor. |
|
ID
|
value.id | string |
Id. |
|
ID técnica
|
value.technicalIdentifier | string |
Identificador técnico. |
|
ID da categoria pai
|
value.parentCategoryId | string |
Identificador de categoria pai. |
Obter detalhes da licença do usuário
Recupere uma lista de objetos de detalhes da licença para usuários corporativos.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
ID
|
value.id | string |
Identificador da licença do usuário. |
|
ID do SKU
|
value.skuId | string |
Identificador de SKU da licença da Microsoft. |
|
Número de partes de SKU
|
value.skuPartNumber | string |
Número parcial de SKU da licença da Microsoft. |
|
servicePlans
|
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. |
|
status de provisionamento
|
value.servicePlans.provisioningStatus | string |
Status de provisionamento. |
|
aplica-sePara
|
value.servicePlans.appliesTo | string |
Aplica-se a. |
Obter detalhes de um único trabalho de usuário
Obter detalhes de um único trabalho de usuário, provedor e validação de ação depende do bloco de comandos específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organizationId | True | string |
Formato – uuid. Identificador exclusivo da organização. |
|
ID do bloco de comando
|
commandBlockId | True | string |
Formato – uuid. Identificador exclusivo do bloco de comandos. |
|
ID do trabalho
|
jobId | True | string |
Formato – uuid. Identificador exclusivo do trabalho. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
Id. |
|
ID do Bloco de Comandos
|
commandBlockId | string |
Identificador de Bloco de Comando. |
|
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 de Conjunto de Comandos. |
|
ID do usuário
|
userId | string |
Identificador de usuário. |
|
Upn do usuário
|
userUpn | string |
Nome principal de utilizador do utilizador. |
|
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. |
|
Upn ator
|
actorUserUpn | string |
Nome da entidade de 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 |
Status. |
|
Executado em
|
executedOn | string |
Executado em. |
|
ID técnica do Bloco de Comando
|
commandBlockTechnicalIdentifier | string |
Identificador técnico do Bloco de Comandos. |
|
Versão do Bloco de Comandos
|
commandBlockVersion | integer |
Versão do Bloco de Comandos. |
|
layoutGroups
|
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 |
Tipo. |
|
propriedade
|
output.body.layoutGroups.layoutGroupFormats.property | string |
Propriedade. |
|
propriedades
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
Propriedades. |
|
parameters
|
output.body.parameters | array of object |
Parâmetros. |
|
ID técnica
|
output.body.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Value
|
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 comando
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
Bloco de Comando. |
|
Código do erro
|
output.errorCode | string |
Código de erro. |
|
Êxito
|
output.isSuccess | boolean |
Bem-sucedido. |
|
layoutGroups
|
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 |
Tipo. |
|
propriedade
|
input.layoutGroups.layoutGroupFormats.property | string |
Propriedade. |
|
propriedades
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
Propriedades. |
|
Várias organizações
|
input.multiSelection.multipleOrganizations | boolean |
Várias organizações. |
|
Vários usuários
|
input.multiSelection.multipleUsers | boolean |
Vários usuários. |
|
parameters
|
input.parameters | array of object |
Parâmetros. |
|
ID técnica
|
input.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Value
|
input.parameters.value | string |
Valor. |
|
Valor padrão
|
input.parameters.defaultValue | string |
Valor padrão. |
|
Tipo
|
input.parameters.schema.type | string |
Tipo. |
|
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 comando
|
input.parameters.placeholderEnabled.commandBlock | boolean |
Bloco de Comando. |
|
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 comando. A validação do provedor e da ação depende do bloco de comando específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do bloco de comando
|
commandBlockId | True | string |
Formato – uuid. Identificador exclusivo do Bloco de Comandos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
Id. |
|
Versão
|
version | integer |
Versão. |
|
ID da categoria
|
categoryId | string |
ID da categoria. |
|
ID técnica
|
technicalIdentifier | string |
Identificador técnico. |
|
Ação de leitura necessária
|
requiredReadAction | string |
Ação de leitura necessária. |
|
Ação de gravação necessária
|
requiredWriteAction | string |
Ação de gravação necessária. |
|
Provedor necessário
|
requiredProvider | string |
Provedor necessário. |
|
Tipo
|
type | string |
Tipo. |
|
ID
|
category.id | string |
Id. |
|
ID técnica
|
category.technicalIdentifier | string |
Identificador técnico. |
|
ID
|
parentCategory.id | string |
Id. |
|
ID técnica
|
parentCategory.technicalIdentifier | string |
Identificador técnico. |
|
ID
|
menuCategory.id | string |
Id. |
|
ID técnica
|
menuCategory.technicalIdentifier | string |
Identificador técnico. |
|
Seleção múltipla
|
commandInput.multiSelection | string |
Seleção múltipla. |
|
layoutGroups
|
commandInput.layoutGroups | array of object |
Grupos de layout. |
|
ID 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 |
Tipo. |
|
propriedade
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
Propriedade. |
|
propriedades
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
Propriedades. |
|
parameters
|
commandInput.parameters | array of object |
Parâmetros. |
|
Valor padrão
|
commandInput.parameters.defaultValue | string |
Valor padrão. |
|
ID técnica
|
commandInput.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Schema
|
commandInput.parameters.schema | string |
Esquema. |
|
Sigiloso
|
commandInput.parameters.sensitive | boolean |
Sensível. |
|
Obrigatório
|
commandInput.parameters.required | boolean |
Obrigatório |
|
Value
|
commandInput.parameters.value | string |
Valor. |
|
Conjunto de Comandos
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
Conjunto de Comandos. |
|
Bloco de comando
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
Bloco de Comando. |
|
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. |
|
layoutGroups
|
commandOutput.layoutGroups | array of object |
Grupos de layout. |
|
ID 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 |
Tipo. |
|
propriedade
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
Propriedade. |
|
propriedades
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
Propriedades. |
|
parameters
|
commandOutput.parameters | array of object |
Parâmetros. |
|
Example
|
commandOutput.parameters.example | string |
Exemplo. |
|
ID técnica
|
commandOutput.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Schema
|
commandOutput.parameters.schema | string |
Esquema. |
|
Sigiloso
|
commandOutput.parameters.sensitive | boolean |
Sensível. |
|
Obrigatório
|
commandOutput.parameters.required | boolean |
Obrigatório |
|
Value
|
commandOutput.parameters.value | string |
Valor. |
|
Conjunto de Comandos
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
Conjunto de Comandos. |
|
Bloco de comando
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
Bloco Commmand. |
Obter detalhes do usuário
Obtenha um usuário pelo identificador de objeto da Microsoft.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Conta habilitada
|
accountEnabled | boolean |
Conta habilitada como true ou false. |
|
ID do funcionário
|
employeeId | string |
Identificador de funcionário do usuário. |
|
Nome de exibição
|
displayName | string |
Nome de exibição do usuário. |
|
Nome indicado
|
givenName | string |
Dado o nome do usuário. |
|
Surname
|
surname | string |
Sobrenome do usuário. |
|
Nome Principal do Usuário
|
userPrincipalName | string |
Nome principal de utilizador do utilizador. |
|
Cargo
|
jobTitle | string |
Cargo do usuário. |
|
Departamento
|
department | string |
Departamento do usuário. |
|
Nome da empresa
|
companyName | string |
Nome da empresa do usuário. |
|
Localização de uso
|
usageLocation | string |
Local de uso do usuário. |
|
Endereço
|
streetAddress | string |
Endereço de rua do usuário. |
|
City
|
city | string |
Cidade do usuário. |
|
Estado
|
state | string |
Estado do usuário. |
|
CEP
|
postalCode | string |
Código postal do usuário. |
|
País
|
country | string |
País do usuário. |
Obter estatísticas sobre os trabalhos do Bloco de Comandos 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 exibir.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da categoria
|
categoryId | True | string |
Formato – uuid. Identificador exclusivo da categoria. |
|
Selecionar filtro
|
$select | string |
$select filtro odata. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contexto OData
|
@odata.context | string |
Contexto OData. |
|
Tipo
|
type | string |
Tipo. |
|
Categoria
|
category | string |
Categoria. |
|
Período
|
period | string |
Período. |
|
Concluído
|
completed | integer |
Concluído. |
|
Em fila
|
queued | integer |
Enfileirado. |
|
Com 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização do Cloud User Hub.
|
organizationId | True | string |
Identificador da organização do Cloud User Hub. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Criado em
|
value.createdDateTime | string |
Criado em. |
|
Nome de exibição
|
value.displayName | string |
Nome de exibição. |
|
groupTypes
|
value.groupTypes | array of string |
Tipos de grupo. |
|
ID
|
value.id | string |
Identificador de objeto da Microsoft do grupo. |
|
Segurança habilitada
|
value.securityEnabled | boolean |
Indica se o grupo está habilitado para segurança. |
|
Mail
|
value.mail | string |
Endereço de email 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 exibir.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar grupos.
|
$filter | True | string |
Filtrar em grupos em uma organização. Use: organizationId in ('{organizationId}'). |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
@odata.count | integer |
Contagem de OData. |
|
value
|
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 do grupo. |
|
ID
|
value.id | string |
Identificador do grupo. |
|
Criado em
|
value.createdOn | string |
Criado em. |
|
Modificado em
|
value.modifiedOn | string |
Modificado. |
Obter localidades
Obtenha localidades.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contexto OData
|
@odata.context | string |
Contexto OData. |
|
Contagem
|
@odata.count | integer |
Contagem de OData. |
|
NextLink do OData
|
@odata.nextLink | string |
Próximolink do OData. |
|
value
|
value | array of object |
Valor. |
|
ID
|
value.id | string |
Identificador de localidade. |
|
Código de localidade
|
value.localeCode | string |
Códigos de idioma ISO-639. |
|
Código do país
|
value.countryCode | string |
Códigos de país ISO-3166. |
|
Nome do país
|
value.countryName | string |
Nome do país. |
Obter organizações
Obtenha todas as organizações que você está autorizado a exibir.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de OData
|
@odata.count | integer |
Contagem de OData. |
|
value
|
value | array of object |
Valor. |
|
Nome
|
value.name | string |
Nome da organização do Azure AD. |
|
Microsoft tenantId
|
value.microsoftTenantId | string |
Identificador de locatário da Microsoft da organização. |
|
Criado em
|
value.createdOn | string |
Criado em. |
|
Modificado em
|
value.modifiedOn | string |
Modificado. |
|
ID
|
value.id | string |
Identificador do Hub de Usuário de Nuvem. |
Obter SKUs assinados pela organização
Obtenha a lista de assinaturas comerciais que uma organização adquiriu.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização do Cloud User Hub.
|
organizationId | True | string |
Identificador da organização do Cloud User Hub. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Status da funcionalidade
|
value.capabilityStatus | string |
Status da funcionalidade do sku da Microsoft. |
|
Unidades consumidas
|
value.consumedUnits | integer |
Unidades consumidas para esse sku. |
|
ID
|
value.id | string |
Identificador do objeto sku inscrito. |
|
ID do SKU
|
value.skuId | string |
Identificador de SKU da licença da Microsoft. |
|
Número de partes de SKU
|
value.skuPartNumber | string |
Número parcial de SKU da licença da Microsoft. |
|
Aplica-se a
|
value.appliesTo | string |
Aplica-se ao usuário ou à organização. |
|
Enabled
|
value.prepaidUnits.enabled | integer |
Skus inscritos habilitados. |
|
Suspenso
|
value.prepaidUnits.suspended | integer |
SKUs com assinatura suspensa. |
|
Aviso
|
value.prepaidUnits.warning | integer |
SKUs inscritos com aviso. |
|
servicePlans
|
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. |
|
status de provisionamento
|
value.servicePlans.provisioningStatus | string |
Status de provisionamento. |
|
aplica-sePara
|
value.servicePlans.appliesTo | string |
Aplica-se a. |
Obter trabalhos de Bloco de Comando de uma organização específica
Obtenha trabalhos de Bloco de Comando para Blocos de Comando que você está autorizado a exibir.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização.
|
organizationId | True | string |
Formato – uuid. Identificador exclusivo da organização. |
|
Itens de $top
|
$top | string |
Retornar somente os primeiros $top itens. |
|
|
Itens de $skip
|
$skip | string |
O número de itens a serem ignorados. |
|
|
Selecionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordem 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. |
|
|
Contagem
|
$count | string |
Determina o clima ou não para incluir a contagem de itens em uma coleção. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contexto OData
|
@odata.context | string |
Contexto OData. |
|
Contagem de OData
|
@odata.count | integer |
Contagem de OData. |
|
Próximolink do OData
|
@odata.nextLink | string |
Próximolink do OData. |
|
value
|
value | array of object |
Valor. |
|
ID
|
value.id | string |
Id. |
|
ID do Bloco de Comandos
|
value.commandBlockId | string |
Identificador de Bloco de Comando. |
|
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 de Conjunto de Comandos. |
|
ID do usuário
|
value.userId | string |
Identificador de usuário. |
|
Upn do usuário
|
value.userUpn | string |
Nome da entidade de 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 da entidade de usuário do ator
|
value.actorUserUpn | string |
Nome da entidade de 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 |
Status. |
|
Executado em
|
value.executedOn | string |
Executado em. |
|
ID técnica do Bloco de Comando
|
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 planejada
|
value.plannedExecution | string |
Execução planejada. |
|
ID de agendamento
|
value.scheduleId | string |
Identificador de agendamento. |
|
Nome da agenda
|
value.scheduleName | string |
Nome da agenda. |
Obter trabalhos do Bloco de Comandos para todas as organizações autorizadas
Obtenha trabalhos de Bloco de Comando para Blocos de Comando que você está autorizado a exibir.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Itens de $top
|
$top | string |
Retornar somente os primeiros $top itens. |
|
|
Itens de $skip
|
$skip | string |
O número de itens a serem ignorados. |
|
|
Selecionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordem 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. |
|
|
Contagem
|
$count | string |
Determina se a contagem de itens deve ser incluída em uma coleção. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contexto OData
|
@odata.context | string |
Contexto OData. |
|
Contagem de OData
|
@odata.count | integer |
Contagem de OData. |
|
Próximo link do OData
|
@odata.nextLink | string |
Próximo link do OData |
|
value
|
value | array of object |
Valor. |
|
ID
|
value.id | string |
Identificador. |
|
ID do Bloco de Comandos
|
value.commandBlockId | string |
Identificador de Bloco de Comando. |
|
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 de Conjunto de Comandos. |
|
ID do usuário
|
value.userId | string |
Identificador de usuário. |
|
Nome Principal do Usuário
|
value.userUpn | string |
Nome da entidade de 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. |
|
Upn do usuário do ator
|
value.actorUserUpn | string |
Nome da entidade de 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 |
Status. |
|
Executado em
|
value.executedOn | string |
Executado em. |
|
ID técnica do Bloco de Comando
|
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 planejada
|
value.plannedExecution | string |
Execução planejada. |
|
ID de agendamento
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização do Cloud User Hub.
|
organizationId | True | string |
Identificador da organização do Cloud User Hub. |
|
Identificador do Hub de Usuário de Nuvem do grupo.
|
userGroupId | True | string |
Identificador do Hub de Usuário de Nuvem do grupo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
@odata.count | integer |
Contagem de OData. |
|
value
|
value | array of object |
Valor. |
|
Nome
|
value.name | string |
Nome.. |
|
Nome Principal do Usuário
|
value.upn | string |
Nome da entidade de usuário do grupo. |
|
ID
|
value.id | string |
Identificador do objeto membro do grupo. |
|
ID do grupo
|
value.groupId | string |
Identificador do Hub de Usuário de Nuvem do grupo. |
|
Criado em
|
value.createdOn | string |
Criado em. |
|
Modificado em
|
value.modifiedOn | string |
Modificado. |
Obter usuários
Recupere uma lista de objetos de usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Filtrar usuários.
|
$filter | True | string |
Filtrar os usuários em uma organização. Use: organizationId in ('{organizationId}'). |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de OData
|
@odata.count | integer |
Contagem de OData. |
|
value
|
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 de utilizador do utilizador. |
|
Nome
|
value.firstName | string |
Nome do usuário. |
|
Sobrenome
|
value.lastName | string |
Sobrenome do usuário. |
|
Nome de exibição
|
value.displayName | string |
Nome de exibição do usuário. |
|
Linguagem
|
value.language | string |
Idioma do usuário. |
|
Local de uso
|
value.usageLocation | string |
Local de uso do usuário. |
|
ID
|
value.id | string |
Identificador do Hub de Usuário de Nuvem do usuário. |
|
Data da criação
|
value.createdOn | string |
Criado em. |
|
Modificado em
|
value.modifiedOn | string |
Modificado. |
Remover membro
Remova um membro de um grupo por meio da propriedade de navegação de membros.
Parâmetros
| Nome | Chave | Obrigató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 usuários
Remova um membro para um grupo de usuários.
Parâmetros
| Nome | Chave | Obrigató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 de 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. |
Senha de alteração do usuário
Atualize o perfil de senha de um usuário para redefinir sua senha.
Parâmetros
| Nome | Chave | Obrigató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 senha na entrada
|
forceChangePasswordNextSignIn | boolean |
Force o usuário a alterar a senha na próxima entrada. |
|
|
Senha
|
password | string |
Nova senha a ser definida. |