Azure AD (ID do Entra)

Com o conector do Azure AD (Entra ID), você pode realizar operações de inserção, exclusão, atualização e leitura no Azure Active Directory.

Antes de começar

Antes de usar o conector do Azure AD (Entra ID), realize as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
    • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

  • Antes de criar uma conexão do Azure AD (Entra ID), crie um aplicativo no portal do Azure/Microsoft Entra ID. Para mais informações, consulte Guia de início rápido: registre um aplicativo com a plataforma de identidade da Microsoft e Registrar um aplicativo cliente no Microsoft Entra ID.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + Criar novo para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Veja abaixo as regiões compatíveis com o conector:

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em Próxima.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione Azure AD (Entra ID) na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    7. Locatário do Azure: o locatário do Microsoft Online usado para acessar dados. Se não for especificado, o locatário padrão será usado.
    8. Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
    9. Clique em Próxima.
  5. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      A conexão do Azure AD (Entra ID) aceita os seguintes tipos de autenticação:

      • Azure AD (tipo de concessão de código de autorização)
      • Credenciais do cliente OAuth 2.0
      • Credenciais do cliente OAuth 2.0 com portador JWT
    2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    3. Clique em Next.
  6. Revisão: revise os detalhes de conexão e autenticação.
  7. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Azure AD (tipo de concessão de código de autorização)
    • ID do cliente: o ID do cliente usado para solicitar tokens de acesso.
    • Escopos: uma lista separada por vírgulas dos escopos desejados.
    • Chave secreta do cliente: a chave secreta do cliente usada para solicitar tokens de acesso.
    • Versão do secret: a versão do chave secreta do cliente.
    • URL de autorização: o URL de autorização gerado ao criar o cliente.
  • Credenciais do cliente OAuth 2.0
    • ID do cliente: o ID do cliente fornecido pelo Azure AD (Entra ID) para o app que você criou.
    • Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.
    • Versão do secret: a versão do chave secreta do cliente.
  • Credenciais do cliente OAuth 2.0 com portador JWT
    • Chave privada: o secret do Secret Manager que contém o conteúdo do arquivo de chave privada no formato PEM. A chave privada precisa corresponder à chave pública/certificado.
    • Senha da chave privada: o secret do Secret Manager que contém a senha (parafraseada) do arquivo da chave privada.
    • Versão do secret: a versão do secret da chave privada.
    • ID do cliente: o ID do cliente usado para solicitar tokens de acesso.

Exemplos de configuração de conexão

Esta seção lista os valores de exemplo para os vários campos que você configura ao criar a conexão do Azure AD (Entra ID).

Tipo de conexão do Azure AD (tipo de concessão de código de autenticação)

Nome do campo Detalhes
Local europe-west1
Conector Azure AD (ID do Entra)
Versão do conector 1
Nome da conexão azure-ad-connection
Ativar Cloud Logging Sim
Conta de serviço XXXX@serviceaccount
Azure Tenant 9b25e811-f983-4982-82e4-263c1ca48112
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Sim
Azure AD Sim
ID do cliente XXXX
Escopo https://graph.microsoft.com/user.read
Chave secreta do cliente XXXX
Versão do secret 1
URL de autorização https://login.microsoftonline.com/9b25e811-f983-4982-82e4-263c1ca48112/oauth2/v2.0/authorize
Antes de especificar um valor para o campo "Escopo", verifique o seguinte:
  • É necessário fornecer as permissões User.Read.All e User.Write.All no nível da conexão e do app do Azure.
  • É possível adicionar os escopos restantes no nível do registro do app do Azure AD e também no nível da conexão, de acordo com seus requisitos.
  • Verifique se as permissões delegadas e do aplicativo foram adicionadas no nível do aplicativo. Os escopos a seguir são usados com frequência:
    • https://graph.microsoft.com/group.readwrite.all
    • https://graph.microsoft.com/groupmember.readwrite.all
    • https://graph.microsoft.com/user.read.all
    • https://graph.microsoft.com/user.read
    • https://graph.microsoft.com/directory.readwrite.all
    • https://graph.microsoft.com/RoleManagement.ReadWrite.Directory
    • https://graph.microsoft.com/directory.accessasuser.all
    • https://graph.microsoft.com/domain.readwrite.all
    • https://graph.microsoft.com/device.read.all
    • https://graph.microsoft.com/RoleManagement.Read.Directory
    • https://graph.microsoft.com/organization.Read.all
    • https://graph.microsoft.com/Application.ReadWrite.all
    • https://graph.microsoft.com/AuditLog.Read.All
    • https://graph.microsoft.com/DeviceLocalCredential.Read.All.

Tipo de conexão das credenciais do cliente OAuth 2.0

Nome do campo Detalhes
Local us-central1
Conector Azure AD (ID do Entra)
Versão do conector 1
Nome da conexão azure-ad-client-credentials
Ativar Cloud Logging Sim
Conta de serviço XXXX@serviceaccount
Azure Tenant 9b25e811-f983-4982-82e4-263c1ca48112
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Sim
OAuth 2.0: credenciais do cliente com chave secreta do cliente Sim
ID do cliente XXXX
Chave secreta do cliente XXXX
Versão do secret 1

Credenciais do cliente OAuth 2.0 com o tipo de conexão de portador JWT

Nome do campo Detalhes
Local europe-west1
Conector Azure AD (ID do Entra)
Versão do conector 1
Nome da conexão azure-jwt
Ativar Cloud Logging Sim
Conta de serviço XXXX@serviceaccount
Azure Tenant 9b25e811-f983-4982-82e4-263c1ca48112
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Sim
OAuth 2.0: credenciais do cliente com o portador JWT Sim
Chave privada XXXX
Versão do secret 1
ID do cliente XXXX
Ao usar as credenciais do cliente OAuth 2.0 com o tipo de conexão de portador JWT, conclua as seguintes tarefas:
  • Crie um certificado autoassinado e faça o download do certificado de chave privada e da chave pública. Para mais informações, consulte Criar certificado autoassinado.
  • Faça upload do certificado de chave pública no aplicativo do Azure AD em "Certificados e chaves secretas".
  • Em um campo de chave privada, transmita o valor do certificado de chave privada e do certificado de chave pública em uma única chave secreta. Não é necessário criar segredos separados para as chaves privadas e públicas.

Para saber como estabelecer a conectividade usando o Postman, consulte Conectividade JWT usando a API.

Reautorização do código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de cofiguração no aplicativo do Azure AD, será necessário autorizar novamente a conexão do Azure AD (Entra ID). Para autorizar novamente uma conexão, siga estas etapas:

  1. Clique na conexão necessária na página "Conexões".

    A página de detalhes da conexão será aberta.

  2. Clique em Editar para editar os detalhes da conexão.
  3. Verifique os detalhes do OAuth 2.0: código de autorização na seção Autenticação.

    Se necessário, faça as mudanças necessárias.

  4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
  5. Clique em Edit authorization na seção Authentication. O painel Authorize é mostrado.
  6. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas etapas adicionais após criar a conexão:

  1. Na página "Conexões", localize a conexão recém-criada.

    O Status do novo conector será Autorização necessária.

  2. Clique em Autorização necessária.

    O painel Editar autorização é mostrado.

  3. Copie o valor do URI de redirecionamento para seu aplicativo externo.
  4. Verifique os detalhes da autorização.
  5. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Limitações do sistema

O conector do Azure AD (Entra ID) pode processar cinco transações por segundo, por , e limita todas as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Ações

Esta seção lista algumas das ações aceitas pelo conector. Para entender como configurar as ações, consulte Exemplos de ações.

Ação "AddGroupMember"

Essa ação adiciona um participante a um grupo.

Parâmetros de entrada da ação AddGroupMember

Nome do parâmetro Tipo de dados Obrigatório Descrição
MemberId String Sim O identificador exclusivo do membro.
GroupId String Sim O identificador exclusivo do grupo.

Para saber como configurar essa ação, consulte Exemplos de ação.

Ação RemoveGroupMember

Essa ação remove um participante de um grupo.

Parâmetros de entrada da ação RemoveGroupMember

Nome do parâmetro Tipo de dados Obrigatório Descrição
MemberId String Sim O identificador exclusivo do membro.
GroupId String Sim O identificador exclusivo do grupo.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AddGroupMember" (adicionar membro do grupo)

Essa ação adiciona um participante a um grupo.

Parâmetros de entrada da ação AddGroupMember

Nome do parâmetro Tipo de dados Obrigatório Descrição
MemberId String Sim O identificador exclusivo do membro.
GroupId String Sim O identificador exclusivo do grupo.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemoveGroupMember" (conta de visitante)

Essa ação remove um participante de um grupo

Parâmetros de entrada da ação RemoveGroupMember

Nome do parâmetro Tipo de dados Obrigatório Descrição
MemberId String Sim O identificador exclusivo do membro.
GroupId String Sim O identificador exclusivo do grupo.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AddUserApplicationRoleAssignment"

Essa ação adiciona um usuário a uma atribuição de função do aplicativo.

Parâmetros de entrada da ação "AddUserApplicationRoleAssignment"

Nome do parâmetro Tipo de dados Obrigatório Descrição
ResourceId String Sim O identificador exclusivo do recurso.
AppRoleId String Sim O identificador exclusivo da função do aplicativo.
UserId String Sim O identificador exclusivo do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemoveUserApplicationRoleAssignment"

Essa ação remove um usuário de uma atribuição de função do aplicativo.

Parâmetros de entrada da ação RemoveUserApplicationRoleAssignment

Nome do parâmetro Tipo de dados Obrigatório Descrição
AppRoleAssignmentId String Sim O identificador exclusivo da atribuição de função do app.
UserId String Sim O identificador exclusivo do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AddGroupApplicationRoleAssignment"

Esta ação adiciona um grupo a uma atribuição de função do aplicativo./p>

Parâmetros de entrada da ação AddGroupApplicationRoleAssignment

Nome do parâmetro Tipo de dados Obrigatório Descrição
ResourceId String Sim O identificador exclusivo do recurso.
AppRoleId String Sim O identificador exclusivo da função do aplicativo.
GroupId String Sim O identificador exclusivo do grupo

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemoveGroupApplicationRoleAssignment"

Essa ação remove um grupo de uma atribuição de função do aplicativo.

Parâmetros de entrada da ação RemoveGroupApplicationRoleAssignment

Nome do parâmetro Tipo de dados Obrigatório Descrição
AppRoleAssignmentId String Sim O identificador exclusivo da atribuição de função do app.
GroupId String Sim O identificador exclusivo do grupo.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação ActivateDirectoryRole

Essa ação ativa uma função de diretório.

Parâmetros de entrada da ação ActivateDirectoryRole

Nome do parâmetro Tipo de dados Obrigatório Descrição
RoleTemplateId String Sim O ID do directoryRoleTemplate em que a função se baseia.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação VerifyDomain

Essa ação verifica um domínio.

Parâmetros de entrada da ação VerifyDomain

Nome do parâmetro Tipo de dados Obrigatório Descrição
ID String Sim O ID do domínio a ser verificado.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação ChangePassword

Essa ação muda a senha de um usuário.

Parâmetros de entrada da ação ChangePassword

Nome do parâmetro Tipo de dados Obrigatório Descrição
NewPassword String Sim A nova senha do usuário.
CurrentPassword String Sim A senha atual do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "ResetPassword"

Esta ação redefine a senha de um usuário.

Parâmetros de entrada da ação ResetPassword

Nome do parâmetro Tipo de dados Obrigatório Descrição
Senha String Sim A senha enviada pelo usuário para redefinição. Se você deixar em branco, uma senha gerada pelo sistema será criada.
UserId String Sim O identificador exclusivo do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AssignLicense"

Essa ação atribui uma licença a um usuário.

Parâmetros de entrada da ação AssignLicense

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserPrincipalName String Sim O nome principal do usuário para quem a licença precisa ser atribuída.Não informe o nome de usuário com que você fez login.
UserId String Sim O ID do usuário para quem a licença precisa ser atribuída. Não informe o nome de usuário com que você fez login.
AddLicenseSkuId String Sim O identificador exclusivo da SKU.
DisabledPlans String Não Uma coleção de identificadores exclusivos separados por vírgulas para planos desativados.
RemoveLicenses String Não Uma coleção de GUIDs separados por vírgulas que identificam as licenças a serem removidas.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemoveLicense"

Essa ação remove a licença atribuída a um usuário.

Parâmetros de entrada da ação RemoveLicense

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserPrincipalName String Sim O nome principal do usuário para quem a licença precisa ser atribuída. Não informe o nome de usuário que você usou para fazer login.
UserId String Sim O ID do usuário para quem a licença precisa ser atribuída. Não informe o nome de usuário com que você fez login.
AddLicenseSkuId String Não O identificador exclusivo da SKU.
DisabledPlans String Não Uma coleção de identificadores exclusivos separados por vírgulas para planos desativados.
RemoveLicenses String Sim Uma coleção de GUIDs separados por vírgulas que identificam as licenças a serem removidas.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação FetchAdditionalUserFields

Essa ação recupera campos de atributos obrigatórios.

Parâmetros de entrada da ação FetchAdditionalUserFields

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserId String Sim O identificador exclusivo do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AddGroupOwner"

Esta ação adiciona um proprietário a um grupo.

Parâmetros de entrada da ação AddGroupOwner

Nome do parâmetro Tipo de dados Obrigatório Descrição
GroupId String Sim O identificador exclusivo do grupo.
OwnerId String Sim O identificador exclusivo do proprietário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemoveGroupOwner"

Essa ação remove um proprietário de grupo.

Parâmetros de entrada da ação RemoveGroupOwner

Nome do parâmetro Tipo de dados Obrigatório Descrição
GroupId String Sim O identificador exclusivo do grupo.
OwnerId String Sim O identificador exclusivo do proprietário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação InviteExternalUser

Essa ação convida um usuário externo para a organização.

Parâmetros de entrada da ação InviteExternalUser

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserEmailAddress String Sim O endereço de e-mail do usuário que você está convidando.
RedirectURL String Sim O URL para onde o usuário é redirecionado após a troca.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AddPhoneAuthenticationMethod"

Essa ação permite que os usuários realizem tarefas específicas

Parâmetros de entrada da ação AddPhoneAuthenticationMethod

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserID String Sim O ID do usuário para adicionar um método de autenticação por telefone.
PhoneNumber String Sim O número de telefone do método de autenticação.
PhoneType String Sim O tipo de telefone do método de autenticação. Os valores possíveis são: celular, celular alternativo e escritório.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemovePhoneAuthenticationMethod"

Essa ação remove o método de autenticação por smartphone de um usuário.

Parâmetros de entrada da ação RemovePhoneAuthenticationMethod

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserID String Sim O ID do usuário para remover um método de autenticação por telefone. Não informe o nome de usuário com que você fez login.
ID String Sim O ID do método de telefone correspondente ao phoneType.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "UpdatePhoneAuthenticationMethod"

Essa ação atualiza o método de autenticação por smartphone de um usuário.

Parâmetros de entrada da ação UpdatePhoneAuthenticationMethod

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserID String Sim O ID do usuário para atualizar um método de autenticação por telefone.
ID String Sim O ID do método de telefone correspondente ao phoneType.
PhoneNumber String Sim O número de telefone do método de autenticação.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AddPrivilegedRole"

Essa ação adiciona uma função privilegiada a um usuário.

Parâmetros de entrada da ação AddPrivilegedRole

Nome do parâmetro Tipo de dados Obrigatório Descrição
PrincipalId String Sim Identificador do principal que recebeu a qualificação do papel.
RoleDefinitionId String Sim Identificador do objeto unifiedRoleDefinition que está sendo atribuído ao principal.
Motivo String Sim Uma mensagem fornecida por usuários e administradores.
ScheduleInfo String Sim O período de qualificação para o papel.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemovePrivilegedRole"

Essa ação remove a função privilegiada de um usuário.<

Parâmetros de entrada da ação RemovePrivilegedRole

Nome do parâmetro Tipo de dados Obrigatório Descrição
PrincipalId String Sim Identificador do principal que recebeu a qualificação do papel.
RoleDefinitionId String Sim Identificador do objeto unifiedRoleDefinition que está sendo removido para o principal.
Motivo String Sim Uma mensagem fornecida por usuários e administradores.

Ação RetrieveUserPhoto

Essa ação recupera uma foto do usuário.

Parâmetros de entrada da ação RetrieveUserPhoto

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserId String Sim ID do arquivo que você quer fazer o download.
FileLocation String Não Onde armazenar o arquivo. Especifique o caminho completo e o nome do arquivo.
Codificação String Não O tipo de codificação de entrada de FileData.
FileStream String Não Uma instância de um fluxo de saída em que os dados do arquivo são gravados. Só é usado se o FileLocation não for fornecido.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "UpdateUserPhoto"

Essa ação atualiza a foto de um usuário.

Parâmetros de entrada da ação UpdateUserPhoto

Nome do parâmetro Tipo de dados Obrigatório Descrição
LocalFile String Não Local do arquivo local que contém a foto a ser enviada. Especifique o caminho e o nome do arquivo completo.
ContentStream String Não O conteúdo como InputStream a ser enviado quando localpath ou folderpath não for especificado
UserId String Sim ID do usuário.
Conteúdo String Sim Conteúdo da foto a ser enviado.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemoveUserPhoto"

Essa ação remove a foto de um usuário.

Parâmetros de entrada da ação RemoveUserPhoto

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserId String Sim ID do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação AssignManager

Essa ação atribui um gerente a um usuário específico.

Parâmetros de entrada da ação AssignManager

Nome do parâmetro Tipo de dados Obrigatório Descrição
ObjectId String Sim O identificador exclusivo do objeto.
ObjectName String Sim O objeto de contato de usuário, organização ou diretório a ser adicionado.
UserId String Sim O identificador exclusivo do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "RemoveManager"

Essa ação remove o administrador atribuído a um usuário.

Parâmetros de entrada da ação RemoveManager

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserId String Sim O identificador exclusivo do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação RetrieveManagerChain

Essa ação recupera um administrador de um usuário.

Parâmetros de entrada da ação RetrieveManagerChain

Nome do parâmetro Tipo de dados Obrigatório Descrição
níveis String Sim O número de níveis de gerentes a serem recuperados. Especifique max para retornar todos os gerentes.
UserId String Sim O ID do usuário.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Ação "AddProfileCardProperty"

Essa ação adiciona uma nova propriedade de cartão de perfil a uma organização.

Parâmetros de entrada da ação AddProfileCardProperty

Nome do parâmetro Tipo de dados Obrigatório Descrição
DirectoryPropertyName String Sim Identifica um recurso de propriedade de cardápio de perfil.
Anotações String Sim Permite que um administrador defina um rótulo de exibição personalizado para a propriedade do diretório.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

A tabela a seguir lista as permissões necessárias para executar as operações de listagem e de recebimento em profilecardproperties:

Permissão Tipo
People.Read.All Aplicativo
PeopleSettings.Read.All Delegada
PeopleSettings.Read.All Aplicativo

A tabela a seguir lista as permissões necessárias para realizar a ação "Criar" em profilecardproperties:

Permissão Tipo
PeopleSettings.ReadWrite.All Aplicativo
PeopleSettings.ReadWrite.All Delegada

Ação "RemoveProfileCardProperty"

Esta ação remove uma propriedade da ProfileCard de uma organização.

Parâmetros de entrada da ação RemoveProfileCardProperty

Nome do parâmetro Tipo de dados Obrigatório Descrição
DirectoryPropertyName String Sim Identifica um recurso de propriedade de cartão de perfil.

Para conferir um exemplo de como configurar essa ação, consulte Exemplos.

Exemplos de ação

Esta seção descreve como realizar algumas das ações neste conector.

Exemplo: AddGroupMember

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddGroupMember e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. Essa ação retorna a mensagem de confirmação do AddGroupMember. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddGroupMember terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemoveGroupMember

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveGroupMember e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveGroupMember terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: adicionar um membro ao grupo(conta de visitante)

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddGroupMember e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddGroupMember terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemoveGroupMember(Guest Account)

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveGroupMember e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveGroupMember terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: AddUserApplicationRoleAssignment

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddUserApplicationRoleAssignment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
      "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddUserApplicationRoleAssignment terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemoveUserApplicationRoleAssignment

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveUserApplicationRoleAssignment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "AppRoleAssignmentId": "bspYNS4s00GoVL-SSaPJE0xC2--0GxxIu8uS4aeindU"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveUserApplicationRoleAssignment terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: AddGroupApplicationRoleAssignment

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddGroupApplicationRoleAssignment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
      "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217",
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddGroupApplicationRoleAssignment terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemoveGroupApplicationRoleAssignment

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveGroupApplicationRoleAssignment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
      "AppRoleAssignmentId": "p3luD3g1tEid3t7Pu3uxAMT7DwI3p29HlrxMuZ143eU"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveGroupApplicationRoleAssignment terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: ActivateDirectoryRole

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ActivateDirectoryRole e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
     {
      "RoleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033"
      } 
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ActivateDirectoryRole terá um valor semelhante a este:

    [{
      "id": "c865d9cb-57da-416c-97a3-753e733da678",
      "roleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033",
      "displayName": "Service Support Administrator",
      "description": "Can read service health information and manage support tickets."
      }]
      

Exemplo: VerifyDomain

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação VerifyDomain e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "Id": "eternalsolarsolutions.com"
      } 
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa VerifyDomain terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: ChangePassword

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ChangePassword e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "NewPassword": "XXX@9876",
      "CurrentPassword": "XXX@123"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ChangePassword terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: ResetPassword

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ResetPassword e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "Password": "XXX@9876",
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ResetPassword terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: atribuir licença

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AssignLicense e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
      "AddLicenseSkuId": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AssignLicense terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemoveLicense

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AssignLicense e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
      "RemoveLicenses": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveLicense terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: FetchAdditionalUserFields

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação FetchAdditionalUserFields e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      } 
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa FetchAdditionalUserFields terá um valor semelhante a este:

    [{
        "id": "9630c9d7-cf15-4406-8d21-598e41a058cc",
        "deleteddatetime": null,
        "accountenabled": "true",
        "agegroup": null,
        "businessphones": "",
        "city": null,
        "companyname": null,
        "consentprovidedforminor": null,
        "country": null,
        "createddatetime": "2024-04-12T10:24:42Z",
        "creationtype": null,
        "department": null,
        "displayname": "Azure_AD_Test",
        "employeehiredate": null,
        "employeeid": null,
        "employeeleavedatetime": null,
        "employeetype": null,
        "externaluserstate": null,
        "externaluserstatechangedatetime": null,
        "faxnumber": null,
        "givenname": null,
        "imaddresses": "",
        "isresourceaccount": null,
        "jobtitle": null,
        "lastpasswordchangedatetime": "2024-05-14T05:07:15Z",
        "legalagegroupclassification": null,
        "mail": null,
        "mailnickname": "Azure_AD_Test",
        "mobilephone": null,
        "officelocation": null,
        "onpremisesdistinguishedname": null,
        "onpremisesdomainname": null,
        "onpremisesimmutableid": null,
        "onpremiseslastsyncdatetime": null,
        "onpremisessamaccountname": null,
        "onpremisessecurityidentifier": null,
        "onpremisessyncenabled": null,
        "onpremisesuserprincipalname": null,
        "othermails": "",
        "passwordpolicies": null,
        "postalcode": null,
        "preferreddatalocation": null,
        "preferredlanguage": null,
        "proxyaddresses": "",
        "securityidentifier": "S-1-12-1-2519779799-1141296917-2388205965-3428360257",
        "showinaddresslist": null,
        "signinsessionsvalidfromdatetime": "2024-05-14T05:07:15Z",
        "state": null,
        "streetaddress": null,
        "surname": null,
        "usagelocation": "IN",
        "userprincipalname": "Azure_AD_Test@z8474.onmicrosoft.com",
        "usertype": "Member",
        "aboutme": null,
        "birthday": "0001-01-01T08:00:00Z",
        "hiredate": "0001-01-01T08:00:00Z",
        "interests": "",
        "mysite": null,
        "pastprojects": "",
        "preferredname": "",
        "responsibilities": "",
        "schools": "",
        "skills": "",
        "assignedlicenses": "",
        "assignedplans": "[\r\n  {\r\n    \"assignedDateTime\": \"2024-05-16T10:17:45Z\",\r\n    \"capabilityStatus\": \"Deleted\",\r\n    \"service\": \"DynamicsNAV\",\r\n    \"servicePlanId\": \"3f2afeed-6fb5-4bf9-998f-f2912133aead\"\r\n  }\r\n]",
      "authorizationinfo_certificateuserids": "",
      "identities": "[\r\n  {\r\n    \"signInType\": \"userPrincipalName\",\r\n    \"issuer\": \"z8474.onmicrosoft.com\",\r\n    \"issuerAssignedId\": \"Azure_AD_Test@z8474.onmicrosoft.com\"\r\n  }\r\n]",
      "licenseassignmentstates": "",
      "onpremisesextensionattributes_extensionattribute1": null,
      "onpremisesextensionattributes_extensionattribute2": null,
      "onpremisesextensionattributes_extensionattribute3": null,
      "onpremisesextensionattributes_extensionattribute4": null,
      "onpremisesextensionattributes_extensionattribute5": null,
      "onpremisesextensionattributes_extensionattribute6": null,
      "onpremisesextensionattributes_extensionattribute7": null,
      "onpremisesextensionattributes_extensionattribute8": null,
      "onpremisesextensionattributes_extensionattribute9": null,
      "onpremisesextensionattributes_extensionattribute10": null,
      "onpremisesextensionattributes_extensionattribute11": null,
      "onpremisesextensionattributes_extensionattribute12": null,
      "onpremisesextensionattributes_extensionattribute13": null,
      "onpremisesextensionattributes_extensionattribute14": null,
      "onpremisesextensionattributes_extensionattribute15": null,
      "onpremisesprovisioningerrors": "",
      "provisionedplans": "",
      "serviceprovisioningerrors": "",
      "customsecurityattributes": "{\r\n  \"ConnectorTesting\": {\r\n    \"@odata.type\": \"#microsoft.graph.customSecurityAttributeValue\",\r\n    \"FavouriteSport\": \"cricket\",\r\n    \"FavouriteMovie\": \"3 idiots\"\r\n  }\r\n}",
      "signinactivity_lastsignindatetime": "2024-05-14T07:04:51Z",
      "signinactivity_lastsigninrequestid": "ed35b322-d0d9-4fcb-8e71-f9ee7e065e00",
      "signinactivity_lastnoninteractivesignindatetime": "2024-05-15T09:00:02Z",
      "signinactivity_lastnoninteractivesigninrequestid": "0d4ce88b-710a-440f-a612-f590954d6800",
      "signinactivity_lastsuccessfulsignindatetime": "2024-05-15T06:45:42Z",
      "signinactivity_lastsuccessfulsigninrequestid": "64643e9d-3468-4e4d-b7c3-8bd316956600"
      }  
      

Exemplo: AddGroupOwner

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddGroupOwner e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
      "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddGroupOwner terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemoveGroupOwner

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveGroupOwner e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
      "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveGroupOwner terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: InviteExternalUser

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação InviteExternalUser e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserEmailAddress": "taleprajyot97@gmail.com",
      "RedirectURL": "https://www.example.com"
      }
      
  4. Essa ação retorna a mensagem de confirmação do InviteExternalUser. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa InviteExternalUser terá um valor semelhante ao seguinte:

    [{
      "Success": "True",
      "Id": "70905aef-361f-4cb1-8d04-41f9e377ebd3",
      "ReedemURL": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3d9b25e811-f983-4982-82e4-263c1ca48112%26user%3d70905aef-361f-4cb1-8d04-41f9e377ebd3%26ticket%3dx5aOZc%25252bE9XslKcOdb101qLnoe2V%25252b8%25252beeFlNhYA5WvTg%25253d%26ver%3d2.0",
      "InvitedUserId": "d5eeb199-a544-4985-b726-e3073751050c"
      }]
      

Exemplo: AddPhoneAuthenticationMethod

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddPhoneAuthenticationMethod e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "PhoneType": "mobile",
      "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
      "PhoneNumber": "+91 9898989890"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddPhoneAuthenticationMethod terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemovePhoneAuthenticationMethod

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemovePhoneAuthenticationMethod e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "PhoneType": "mobile",
      "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
      "PhoneNumber": "+91 9898989890"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemovePhoneAuthenticationMethod terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: UpdatePhoneAuthenticationMethod

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UpdatePhoneAuthenticationMethod e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "securityComplianceNotificationPhones": "9899999999",
      "securityComplianceNotificationMails": "abc@gmail.com"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UpdatePhoneAuthenticationMethod terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: AddPrivilegedRole

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddPrivilegedRole e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
      "Justification": "Add Privileged Role",
      "ScheduleInfo": "{\n\"StartDateTime\" : \"2022-09-09T21:31:27.91Z\",\n\"Expiration\"    : {\n\"Type\"        : \"Eligible\"}\n}"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddPrivilegedRole terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RemovePrivilegedRole

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemovePrivilegedRole e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
      "Justification": "Removing Privileage Role"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemovePrivilegedRole terá um valor semelhante a este:

    [{
      "Success": "True"
      }]
      

Exemplo: RetrieveUserPhoto

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RetrieveUserPhoto e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "8e22c728-c523-436b-8f46-3b21cc1b5f80"
      } 
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RetrieveUserPhoto terá um valor semelhante a este:

    [{
        "Status": "Success",
        "FileData": "77+9UE5HDQoaCgAAAA1JSERSAAADUgAAAjYIBgAAAFo077+977+9AAAAAXNSR0IA77+977+9HO+/vQAAAARnQU1BAADvv73vv70L77+9YQUAAAAJcEhZcwAADu+/vQAADu+/vQHvv71v77+9ZAAA77+977+9SURBVHhe77+977+9ZXwcV9K+LWlmZCbvv71O77+977+977+9ZO+/vcmG77+9Ge+/vThmZmZm77+9OO+/vcmG77+977+9MTMzM++/vS0z77+977+977+9eu+/ve+/vXTvv71o77+9KAvvv73vv73vv71w77+9DjRO77+977+9Vl3vv70677+9KWsrR2zvv71zEe+/ve+/vUTvv73vv717KGrvv709EO+/ve+/vWjvv71RG01777+977+9Me+/ve+/vWjvv73vv719OmJLyqfZuu+/vRHvv71ZK++/vQ7Uj9iJ77+977+9du+/vUXEslrvv73vv73vv70uzbzvv70pFu+/vUrvv709Yl4P77+9eu+/vSDvv73vv71n77+977+977+9Gu+/ve+/vV3vv71sP2Vm77+977+9be+/vWbvv707RmxV77+9VFvvv70u77+9Fu+/ve+/vdqi77+9aTbvv71N77+977+9Re+/ve+/vWPvv70tYe+/vRXvv73vv70677+9bu+/vTRbS++/ve+/ve+/vWxkP1vvv71FbWt377+977+9LdW277+977+977+977+977+9ae+/ve+/vXvvv73vv73vv70Z77+9Xe+/vSLvv73vv70X77+977+9E++/vT1ob1/vv71+ae+/ve+/vWx3by1P77+9XT3vv71sL++/ve+/ve+/vWbvv73vv73vv71m77+9F+e0s2vvv712dErvv73vv73vv73vv73vv73vv71p77+977+9Le+/vW/vv73vv71oZ0vvv73vv70577+9R3tb77+92b7vv70R77+977+9KmIHKQ/vv73vv73agdapdu+/vU3vv73vv73vv73vv73vv71zXe+/ve+/ve+/ve+/ve+/vRTvv70777+977+977+96pqK77+9LO+/vXN077+9PO+/ve+/ve+/vVp2f++/vdOgNO+/ve+/veyBlO+/ve+/vQdQ77+9cO+/vTc477+9bBDvv71S77+977+977+977+9Zu+/ve+/vW8I77+977+977+9ZQ8paFnvv70LWnxwYe+/ve+/vVEWNBvvv71O77+977+9eQMKW++/vV8x77+977+9FO+/vd6k77+977+9LmHvv70eRS3erQBiG++/vXXvv71DzLI577+9LO+/vT3vv73vv71077+9Ze+/ve+/ve+/vTcebe+/vWbvv73vv71E77+9UEPvv71r77+9NMus77+9Zu+/ve+/vUVsXe+/ve+/ve+/ve+/ve+/vWZr77+9c29qRG0177+9VdWi77+977+9eu+/ve+/ve+/vUlfTe+/ve+/vW/vv73NujVTbX3vv73vv73vv73vv70V77+9He+/ve+/vXUj77+977+9AdeeMe+/ve+/ve+/ve+/ve+/ve+/vQHvv73vv70Y77+9aFcj77+9Y2Pvv700Zjtpb2vvv73vv73vv73vv73ZmHvXnHvvv70Y77+904Lvv73vv70y77+977+9EO+/ve+/vRjvv73vv71077+9dDvbs++/ve+/vXsX4bqU77+9Wu+/vVsH77+977+977+977+9P1vvv73vv70y77+9fO+/ve+/vV8pZd6rJe+/vXvvv70cy6Yef++/ve+/vWXvv71U1LJf77+9Wg3vv73vv71j1otF77+9NO+/ve+/vQTvv73vv70A77+9SO+/vWZHD++/vQ3vv71ta++/ve+/ve+/veO+rmDvv73vv73vv71c77+9cD1+77+9Hu+/ve+/vSpG77+977+9Y++/ve+/vWfvv73vv73vv70zMXvvv73vv73vv73
      ...[too long to view on UI. Please use the API to view the full content.]
      

Exemplo: UpdateUserPhoto

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UpdateUserPhoto e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc",
      "Content": "iVBORw0KGgoAAAANSUhEUgAAA1IAAAI2CAIAAADVVi6oAAAgAElEQVR4AZy9d3Rc1dX3r3POHVmWrG6ckIQHN0gCCYEkT/IkJA89lARc1Xsf1ZlR78W2iis4BFuybMAFMMW4qctFknu31XvvzTbu0tx9fmufOzMWJe+b97fWXmede2ekBYs/8sm3bJm1uLAry9jJt2jFq9Khl6XDL0vFr0ilr0pHXlMdf52ee5tdXU5b3diAN50IYHdCyYMINh1FIJpCnJmcRCGFQSqBdDNIJzhp5H4Su5FIx5PYYDzrjaVdcaxRS+qjyWWNdFlHL2jZBR27ECNdiqNX41l9HG1MYI0JtCWBtSTSjiTWnSz1pNCuZNKXKvWl0e4U0p/GhtLZcDodz2QjmWw0i42soiOZdDiDDaXToVQ6ms76k2lvEuuKZ71xbCBJ6o+nA7F0IIb260ifhg5p6EAkHdGycS0bjaJjGjYWxSY17IZOmtCQ61p6P0a6HU1vRtPbsfRePH2QQO8lkXtJdDqN4aRTfRbRryaQQ+Ucqs+mshj9GiqvocpLyKU8h0CueMwmPJtCDoE8CtlMn2cxnWsh51pCnrWca8FzzSHPAtZYyqusIdMG0s15hq2cOkdOniUnW8hxVI5V6WPpdDSd1kn3IsndKPZNOL2hZteD6HgAHfSnff6s1ZM1u9NmD9biKTW500Z3qdGDNnmxFi+pyYO2+7BWL9Lmy9q8WbuP1OHHegJZVwDr8qc9gawvkPYF0cEgOhTMhkPYcKhqIIj2BpP+IDoQQkfD2WgEG4mgY5EqPCPodS27FUfvJ5lPpVnJGVaQbS9n28o5c+V1j+rXzYWN8+RN9vCuLWyep99kL2901G+Yo19rAevw33p6vdX9XPM72Wwiiw2l0v5U1p9Ge1Kk1gRaH8dOR7Ayf/alh2qnk7RjhWrbUmnLO6p332DrX6fZr0iZL7KUF1jCn1TaP86K/P2siN9Zhj43R/1b68DfWPv+ysbrlw5uT9g6L7JducjeeZGjy6J5zo/buyxwdF9g77nIwfcJ+9Bfzo34pX3MMw4Jv7LP/K3tpj/b5L9gu/0Fq89fn130zpzyFXNOONuecZ1z0WtOnd+ctiDrjkCbwTDH4Qjrm9qf3on9yd34H02n/Jc+9TFIf1xOX6hPexwyF0Da49NJj00nPXYndt7tuB9N6hyGImx71datfrOueNHTrtKR5axkmVS2fHaN67wLvovq1c+26f7cl/zqZPbye5u99NuC4JMI2B8LFelwIodffg/qtkBzIbTthI5dvHMP7/4cp+dL3vcVH9jPBw/CUDEfKYPRMj5Wzscq+dgRPirOh5dK8VH5d04YKYVR8YOj5TBSir9kpIwPlcJwKQyXwHAJFwNDxfg4VGx6lAcP8YGHA/0H8bH/EO8Tl76DeOk7CP378Z+wfx/v3wf9+6Dva7kXT+jbB31fQe9X0P0V79mH0/0V71LmS979BXR9bjp59xe86wve+Tl07OWdnxtnL+/cCx2fKcM7PoP2T6H9Uy5OaPuEt38C7Z/wtj3Qsou37sZp2cNb9sgte3gzDjTv4U27efNO3vwxb/4Ip0lM807etBMaP4KGHdCwgzd+iO8bP+SNH0KT4aXhfcN2qC/k9dvlum1Qvw3qxGPdNj5joN74WFsw8z3eDW8KeJ34qLYA3xhHrsuH+nxel89r83ndVsPP1hZA7VbAx628Lh8atvLGfF6/Va4v4LVbceryeaPxfWM+NObzhgLegC+VAeXeUIAX/KgA3xu/gL+wYSv+lGmMH+GbpgLT4HdmPP7f780FvHnrw2nZyvHNNpyWfN4i7k3boLmAt4pp2cZbC7npbNnGWwrxo5Z8aM0X39kGbQWG6djK2/OhrYC35z+cjnxow/e8Ix/E8M4C6MjnnQUPp2sb79qGj8rZOeOufPS9E7rF
      ...[too long to view on UI. Please use the API to view the full content.]
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UpdateUserPhoto terá um valor semelhante a este:

     [{
      "Status": "Success"
      }]
      

Exemplo: RemoveUserPhoto

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveUserPhoto e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
     {
      "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
      } 
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveUserPhoto terá um valor semelhante a este:

     [{
      "Status": "Success"
      }]
      

Exemplo: AssignManager

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AssignManager e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
      "ObjectId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "ObjectName": "users"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AssignManager terá um valor semelhante a este:

     [{
      "Status": "True"
      }]
      

Exemplo: RemoveManager

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveManager e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
      } 
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveManager terá um valor semelhante a este:

     [{
      "Status": "True"
      }]
      

Exemplo: RetrieveManagerChain

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RetrieveManagerChain e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "UserId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "Levels": "max"
      }
      
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RetrieveManagerChain terá um valor semelhante a este:

    [{
      "id": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
      "displayName": "test1",
      "manager": "{\r\n  \"@odata.type\": \"#microsoft.graph.user\",\r\n  \"id\": \"9630c9d7-cf15-4406-8d21-598e41a058cc\",\r\n  \"deletedDateTime\": null,\r\n  \"accountEnabled\": true,\r\n  \"ageGroup\": null,\r\n  \"businessPhones\": [],\r\n  \"city\": null,\r\n  \"companyName\": null,\r\n  \"consentProvidedForMinor\": null,\r\n  \"country\": null,\r\n  \"createdDateTime\": \"2024-04-12T10:24:42Z\",\r\n  \"creationType\": null,\r\n  \"department\": null,\r\n  \"displayName\": \"Azure_AD_Test\",\r\n  \"employeeId\": null,\r\n  \"employeeHireDate\": null,\r\n  \"employeeLeaveDateTime\": null,\r\n  \"employeeType\": null,\r\n  \"externalUserState\": null,\r\n  \"externalUserStateChangeDateTime\": null,\r\n  \"faxNumber\": null,\r\n  \"givenName\": null,\r\n  \"isLicenseReconciliationNeeded\": false,\r\n  \"jobTitle\": null,\r\n  \"legalAgeGroupClassification\": null,\r\n  \"mail\": null,\r\n  \"mailNickname\": \"Azure_AD_Test\",\r\n  \"mobilePhone\": null,\r\n  \"onPremisesDistinguishedName\": null,\r\n  \"onPremisesDomainName\": null,\r\n  \"onPremisesImmutableId\": null,\r\n  \"onPremisesLastSyncDateTime\": null,\r\n  \"onPremisesSecurityIdentifier\": null,\r\n  \"onPremisesSamAccountName\": null,\r\n  \"onPremisesSyncEnabled\": null,\r\n  \"onPremisesUserPrincipalName\": null,\r\n  \"otherMails\": [],\r\n  \"passwordPolicies\": null,\r\n  \"officeLocation\": null,\r\n  \"postalCode\": null,\r\n  \"preferredDataLocation\": null,\r\n  \"preferredLanguage\": null,\r\n  \"proxyAddresses\": [],\r\n  \"refreshTokensValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"imAddresses\": [],\r\n  \"isResourceAccount\": null,\r\n  \"showInAddressList\": null,\r\n  \"securityIdentifier\": \"S-1-12-1-2519779799-1141296917-2388205965-3428360257\",\r\n  \"signInSessionsValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"state\": null,\r\n  \"streetAddress\": null,\r\n  \"surname\": null,\r\n  \"usageLocat
      ...[too long to view on UI. Please use the API to view the full content.]
      

Exemplo: AddProfileCardProperty

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddProfileCardProperty e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
     {
    "Annotations": "[{"displayName": "Attributes"}]",
    "DirectoryPropertyName": "CustomAttribute15"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddProfileCardProperty terá um valor semelhante a este:

     [{
    "Status": "True"
    }]

Exemplo: RemoveProfileCardProperty

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação RemoveProfileCardProperty e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "DirectoryPropertyName": "CustomAttribute12"
    } 
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveProfileCardProperty terá um valor semelhante a este:

     [{
    "Status": "True"
    }]

Exemplos de operações de entidade

Esta seção mostra como realizar algumas das operações de entidade neste conector.

Exemplo: listar os grupos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Grupos" na lista Entity.
  3. Selecione a operação LIST e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, é possível definir a filterClause de acordo com o requisito do cliente.

Use aspas simples (") para incluir o valor da cláusula de filtro. É possível usar a cláusula de filtro para filtrar registros com base nas colunas.

Também é possível realizar operações LIST nas seguintes entidades:

  • Usuário
  • GroupMembers
  • Domínios
  • RoleAssignments
  • Aplicativos
  • Dispositivos
  • Contatos
  • DirectoryRoleTemplates
  • DirectoryRoles
  • AdministrativeUnits
  • SubscribedSKUs
  • PhoneAuthenticationMethod
  • Organização
  • DeviceLocalCredentials
  • ProfileCardProperties

Exemplo: extrair um único registro do grupo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Grupos" na lista Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Defina o ID da entidade como "bb4756c7-38c0-426b-97aa-03b6443e7f16", que é a chave a ser transmitida. Para definir o ID da entidade, na seção Data Mapper do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e digite "bb4756c7-38c0-426b-97aa-03b6443e7f16" no campo Valor de entrada e escolha o EntityId como variável local.

Também é possível realizar operações GET nas seguintes entidades:

  • Usuário
  • GroupMembers
  • Domínios
  • RoleAssignments
  • Aplicativos
  • Dispositivos
  • Contatos
  • DirectoryRoleTemplates
  • DirectoryRoles
  • AdministrativeUnits
  • PhoneAuthenticationMethod
  • Organização
  • UserManagers
  • DeviceLocalCredentials

Exemplo: excluir um registro do grupo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Grupos" na lista Entity.
  3. Selecione a operação DELETE e clique em Concluído.
  4. Defina o ID da entidade como "62008bbe-effa-4341-9d29-eac7f67b84fe", que é a chave a ser transmitida. Para definir o ID da entidade, na seção Data Mapper do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e digite "62008bbe-effa-4341-9d29-eac7f67b84fe" no campo Valor de entrada e escolha o EntityId como variável local.

    Se duas chaves compostas ou primárias estiverem presentes, a transmissão de um ID de entidade poderá gerar um erro. Nesses casos, é possível usar a cláusula de filtro, como id='62008bbe-effa-4341-9d29-eac7f67b84fe'.

Também é possível realizar operações DELETE nas seguintes entidades:

  • Usuário
  • Domínios
  • Aplicativos
  • Dispositivos
  • Exemplo: criar uma entidade de grupo (Microsoft 365)

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione "Grupos" na lista Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local.
      {
      "securityEnabled": true,
      "displayName": "GoogleGCP",
      "description": "This Group is creating for gcp testing.",
      "mailEnabled": false,
      "mailNickname": "GoogleGCP",
      "groupTypes": "Unified"
      }

      Este exemplo cria os registros de grupos. Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Groups terá um valor semelhante a este:

      {
      "id": "30fc13b3-79b3-4ac5-a3ba-684d4e887ecc"
      } 

    Exemplo: atualizar um usuário

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione "Usuários" na lista Entity.
    3. Selecione a operação Update e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como variável local.
      {
      "jobTitle": "Software Engineer"
      }
    5. Defina o ID da entidade no Data Mapper como a entidade dos usuários. Para definir o ID da entidade, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como uma variável local.

      Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 7ad59ec3-1c37-4932-be51-7513fe98c3c3.

      Este exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

      {
      "id": "7ad59ec3-1c37-4932-be51-7513fe98c3c3"
      } 

    Usar a conexão do Azure AD (Entra ID) em uma integração

    Depois de criar a conexão, ela fica disponível na integração da Apigee e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

    • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
    • Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".

    Receber ajuda da comunidade do Google Cloud

    Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

    A seguir