Active Directory

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:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  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 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 parâmetro 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.

Ações

Esta seção lista as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ações.

Ação MoveToDN

Essa ação move um objeto de um DN para outro.

Parâmetros de entrada da ação MoveToDN

Para ver um exemplo de como configurar a ação MoveToDN, consulte Exemplos de ações.

Ação GetAttributes

Essa ação recebe atributos do objeto especificado.

Parâmetros de entrada da ação GetAttributes

Para ver um exemplo de como configurar a ação GetAttributes, consulte Exemplos de ações.

Ação AddMembersToGroup

Essa ação adiciona participantes a um grupo.

Parâmetros de entrada da ação AddMembersToGroup

Para ver um exemplo de como configurar a ação AddMembersToGroup, consulte Exemplos de ações.

Ação RemoveMembersFromGroup

Essa ação remove participantes de um grupo.

Parâmetros de entrada da ação RemoveMembersFromGroup

Para ver um exemplo de como configurar a ação RemoveMembersFromGroup, consulte Exemplos de ações.

Ação ResetPassword

Essa ação redefine a senha.

Parâmetros de entrada da ação ResetPassword

Para ver um exemplo de como configurar a ação ResetPassword, consulte Exemplos de ações.

Ação ChangePassword

Essa ação muda a senha.

Parâmetros de entrada da ação ChangePassword

Para ver um exemplo de como configurar a ação ChangePassword, consulte Exemplos de ações.

Exemplos de ações

Nesta seção, descrevemos como executar algumas das ações neste conector.

Exemplo: mover um objeto de um DN para outro

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação MoveToDN 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:

   {
   "NewParentDN": "CN=Users,DC=gcpad,DC=local",
   "DN": "CN=GoogleAdmin,CN=Computers,DC=gcpad,DC=local"
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa MoveToDN terá um valor semelhante a este:

[{
"Success": null,
"result": "[ok]",
"modified": "true",
"rss:title": "The movement was successful.",
"resultcode": "0"
}]

Exemplo: extrair atributos de um DN

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação GetAttributes 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:

   {
   "DN": "CN=admin,CN=Users,DC=test-ldap,DC=com"
   } 
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa GetAttributes terá um valor semelhante a este:

[{
"AttributeName": "_op",
"AttributeValue": "ldapadoGetAttributes"
},
{
"AttributeName": "msds-supportedencryptiontypes",
"AttributeValue": "24"
},
{
"AttributeName": "usncreated",
"AttributeValue": "12775"
},
{
"AttributeName": "objectclass",
"AttributeValue": "organizationalPerson"
},
{
"AttributeName": "objectclass",
"AttributeValue": "user"
},
{
"AttributeName": "accountexpires",
"AttributeValue": "9223372036854775807"
},
{
"AttributeName": "name",
"AttributeValue": "admin"
},
{
"AttributeName": "objectcategory",
"AttributeValue": "CN=Person,CN=Schema,CN=Configuration,DC=test-ldap,DC=com"
},
{
"AttributeName": null,
"AttributeValue": null
}] 

Exemplo: adicionar participantes a um grupo

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AddMembersToGroup 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": "1|CN=GoogleGRP1fa2,CN=Users,DC=gcpad,DC=local",
   "UserDNs": "[{\"DN\":\"CN=GoogleAI,CN=Users,DC=gcpad,DC=local;CN=Guest,CN=Users,DC=gcpad,DC=local\"}]"
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddMembersToGroup terá um valor semelhante a este:

[{
"Success": "True"
}] 

Exemplo: remover participantes de um grupo

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação RemoveMembersFromGroup 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": "1|CN=GoogleGRP1fa2,CN=Users,DC=gcpad,DC=local",
   "UserDNs": "[{\"DN\":\"CN=GoogleAI,CN=Users,DC=gcpad,DC=local;CN=Guest,CN=Users,DC=gcpad,DC=local\"}]"
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa RemoveMembersFromGroup terá um valor semelhante a este:

[{
"Success": "True"
}]

Exemplo: redefinir senha

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:

   {
   "AdminPassword": "XXXX=",
   "User": "CN=GCP_Admin,CN=Users,DC=gcpad,DC=local",
   "NewPassword": "XXXX",
   "AdminUser": "CN=admin,CN=Users,DC=gcpad,DC=local"
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ResetPassword terá um valor semelhante a este:

[{
"Success": "true",
"result": "[ok]",
"rss:title": "Password modified successfully",
"resultcode": "0"
}]

Exemplo: mudar a senha

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": "XXXX"
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ChangePassword terá um valor semelhante a este:

[{
"Success": "true",
"result": "[ok]",
"rss:title": "Password modified successfully.",
"resultcode": "0"
}]

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os usuários

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione User na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Se quiser, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Sempre especifique o valor da cláusula de filtro entre aspas simples (').

É possível realizar a operação de lista nas seguintes entidades:

Group, UserMembership, GroupMembership, OrganizationalPerson, Person, Top, Organization, OrganizationalRole, DomainPolicy, Contact, Computer, DnsNode, SecurityObject, OrganizationalUnit, Domain e Account

Exemplo: receber um registro de usuário

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione User na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira 1|CN=Active Directory User,DC=test-ldap,DC=com no campo Valor padrão.

   Aqui, 41|CN=Active Directory User,DC=test-ldap,DC=com é um ID de registro exclusivo na entidade User.

É possível realizar a operação "Get" nas seguintes entidades:

Group, UserMembership, GroupMembership, OrganizationalPerson, Person, Top, SecurityPrincipal, Organization, OrganizationalRole, DomainPolicy, Contact, Computer, DnsNode, SecurityObject, OrganizationalUnit, Domain e Account

Exemplo: criar um registro de usuário

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione User na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "RDN": "CN= Active Directory User ",
   "ObjectClass": "top;person;organizationalPerson;user"
   }

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "Id": "1|CN=Administrator,CN=Users,DC=test-ldap,DC=com"
   }

Exemplo: criar um registro de computador

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Computer na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
   "RDN": "CN=DELVM04S03",
   "ObjectClass": "top;person;organizationalPerson;user;computer"
   } 
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Computer terá um valor semelhante a este:

   {
   "Id": "1|CN=DELVM04S03,CN=Computers,DC=gcpad,DC=local"
   }
   

Exemplo: criar um registro de grupo (DomainLocal)

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Group na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
   "RDN": "CN=DomainLocala496",
   "ObjectClass": "group",
   "GroupType": "4"
   }
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Group terá um valor semelhante a este:

   {
     "Id": "1|CN=DomainLocala496,CN=Users,DC=test-ldap,DC=com"
   }
   

Exemplo: criar um registro de grupo (global)

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Group na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "RDN": "CN=Globalf862",
     "ObjectClass": "group",
     "GroupType": "-2147483646"
   }
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Group terá um valor semelhante a este:

   {
     "Id": "1|CN=Globalf862,CN=Users,DC=test-ldap,DC=com"
   }
   

Exemplo: criar um registro de grupo (universal)

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Group na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "RDN": "CN=UniversalGRP20e5",
     "ObjectClass": "group",
     "GroupType": "8"
   }
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Group terá um valor semelhante a este:

   {
     "Id": "1|CN=UniversalGRP20e5,CN=Users,DC=test-ldap,DC=com"
   }
   

Exemplo: criar um registro de grupo (segurança universal)

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Group na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "RDN": "CN=UniversalSecurity3f5a",
     "ObjectClass": "group",
     "GroupType": "-2147483640"
   }
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Group terá um valor semelhante a este:

   {
     "Id": "1|CN=UniversalSecurity3f5a,CN=Users,DC=test-ldap,DC=com"
   }
   

Exemplo: criar um registro OrganizationPerson

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione OrganizationPerson na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "RDN": "CN=OrgP_AD45237",
     "ObjectClass": "top;person;organizationalPerson;user;inetOrgPerson"
   }
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa OrganizationPerson terá um valor semelhante a este:

   {
     "Id": "1|CN=OrgP_AD45237,CN=Users,DC=gcpad,DC=local"
   }
   

Exemplo: criar um registro de pessoa

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Person na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "RDN": "CN=Personc3a",
     "ObjectClass": "top;person;organizationalPerson;user"
   }
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Person terá um valor semelhante a este:

   {
     "Id": "1|CN=Personc3a,CN=Users,DC=gcpad,DC=local"
   } 
   

Exemplo: criar um registro principal

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Top na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "RDN": "CN=Top49b88",
     "ObjectClass": "top;person;organizationalPerson;user;inetOrgPerson"
   }
   

   Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Top terá um valor semelhante a este:

   {
     "Id": "1|CN=Top49b88,CN=Users,DC=gcpad,DC=local"
   }
   

Exemplo: atualizar um registro de usuário

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione User na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "PostalCode": "560048"
   }

Em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=Active Directory User,DC=test-ldap,DC=com.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

{
"Id": "1|CN=Active Directory User,DC=test-ldap,DC=com"
}

Exemplo: atualizar um registro de grupo

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Group na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "Member": "CN=admin,CN=Users,DC=test-ldap,DC=com;CN=Administrator,CN=Users,DC=test-ldap,DC=com"
   }
   

   Em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=ADGroup9bff,DC=test-ldap,DC=com.

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "Id": "1|CN=ADGroup9bff,DC=test-ldap,DC=com"
   }
   

Exemplo: atualizar um registro de grupo (GroupType)

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Group na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
    "GroupType": "4"
   }
   

   Em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=UniversalGRP20e5,CN=Users,DC=test-ldap,DC=com.

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "Id": "1|CN=UniversalGRP20e5,CN=Users,DC=test-ldap,DC=com"
   }
   

Exemplo: atualizar um registro OrganizationPerson

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione OrganizationPerson na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "Title": "Test Engineer"
   }
   

   Em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=OrgP_ADa022f,DC=test-ldap,DC=com.

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "Id": "1|CN=OrgP_ADa022f,DC=test-ldap,DC=com"
   }
   

Exemplo: atualizar um registro de pessoa

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Person na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "TelephoneNumber": "7764942992"
   }
   

   Em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=Person2e6,DC=test-ldap,DC=com.

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "Id": "1|CN=Person2e6,DC=test-ldap,DC=com"
   }
   

Exemplo: atualizar um registro principal

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Top na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
     "Description": "Top Testing GOOGLECLOUD"
   }
   

   Em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=Top3b6bc,DC=test-ldap,DC=com.

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "Id": "1|CN=Top3b6bc,DC=test-ldap,DC=com"
   }
   

Exemplo: atualizar um registro de computador

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Computer na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Data Mapper da tarefa Mapeamento de dados, 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.

   {
   "Description": "This is Windows 2019 Server."
   }
   

   Em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=DELVM04S02,CN=Computers,DC=gcpad,DC=local.

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "Id": "1|CN=DELVM04S02,CN=Computers,DC=gcpad,DC=local"
   }
   

Exemplo: excluir um registro de usuário

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione User na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 1|CN=Active Directory User,DC=test-ldap,DC=com no campo Valor padrão.

É possível realizar a operação de exclusão nas seguintes entidades:

Group, UserMembership, GroupMembership, OrganizationalPerson, Person, Top, Organization, OrganizationalRole, DomainPolicy, Contact, Computer, DnsNode, SecurityObject, OrganizationalUnit, Domain e Account