LDAP Search

4D v15

LDAP Search


LDAP Search ( drRootEntry ; filtro {; escopo {; atributos {; atributosComoArray}}} ) -> Resultado

Parâmetro	Tipo	Descrição
drRootEntry	String	Distinguished Name da entrada raiz para começar a pesquisa
filtro	String	filtro de pesquisa LDAP
escopo	String	EScopo da pesquisa: "base" (padrao), "one" ou "sub"
atributos	Array string	atributos
atributosComoArray	Array booleano	True = força que os atributos sejam retornados como array, false = força que os atributos sejam retornados como uma simples variável
Resultado	Objeto	Key/value attributes

Descrição

O comando LDAP Search encontra a primeira ocorrência que corresponde aos critérios definidos no servidor LDAP alvo. Este comando deve ser executado em uma conexão com um servidor LDAP aberta com LDAP LOGIN; caso contrário, é devolvido um erro 1003.

Em dnRootEntry, passar o Distinguished Name do elemento raiz do servidor LDAP; a pesquisa irá recomeçar a partir deste elemento.

em Filtro, passar o filtro de pesquisa LDAP para aplicar. A seqüência de filtro deve ser compatível com rfc2225. Você pode passar uma string vazia "" para não filtrar a pesquisa; o "*" é suportado para substrings.

Em escopo, passe uma das seguintes constantes do tema "LDAP":

Constante	Tipo	Valor	Comentário
LDAP root only	Texto	"base"	Buscar só no elemento raíz definido por dnRootEntry (como padrão se for omitido)
LDAP root and next	Texto	"one"	Buscar no elemento raíz definido por dnRootEntry e nas entradas posteriores diretamente em um nivel
LDAP all levels	Texto	"sub"	Buscar no elemento raíz definido por dnRootEntry e em todas as entradas posteriores

Em atributos, passe um array texto que contenha a lista de todos os atributos LDAP a recuperar a partir das entradas encontradas. Como padrão, se for omitido este parâmetro, todos os atributos se recuperam.

Nota: lembre que os nomes de atributos LDAP distinguen entre maiúsculas e minúsculas. Para mais informação sobre os atributos LDAP, pode consultar esta página que lista todos os atributos disponíveis para MS Active directory.

Como padrão, o comando retorna atributos como um array se se encontram vários resultados, ou como uma variável se for encontrado um só resultado. Os parâmetros opcionais atributosEmArray permitem "forçar" o formato dos atributos retornados num array ou como uma variável para cada atributo definido:

Quando passar true em um elemento, o elemento correspondente do parâmetro atributos será retornado em um array. Se for encontrado um único valor, o comando devolve um array com um só elemento.
Quando passar false em um elemento, o elemento correspondente do parâmetro atributos será retornado em uma variável simples. Se forem encontradas várias entradas, o comando devolve só o primeiro elemento.

Exemplo 1

Se deseja conseguir o número de telefone do usuário "smith" no diretório da empresa:

 ARRAY TEXT($_tabAttributes;0)

 APPEND TO ARRAY($_tabAttributes;"cn")

 APPEND TO ARRAY($_tabAttributes;"phoneNumber")

 LDAP LOGIN($url;$dn;$pwd)

 $filter:="cn=*smith*"

 $vfound:=LDAP Search($dnSearchRootEntry;$filter;LDAP all levels;$_tabAttributes)

 LDAP LOGOUT

Exemplo 2

Queremos obter um array de todas as entradas que se encontram no atributo "memberOf":

 C_OBJECT($entry)

 ARRAY TEXT($_tabAttributes;0)

 ARRAY BOOLEAN($_tabAttributes_asArray;0)

 APPEND TO ARRAY($_tabAttributes;"cn")

 APPEND TO ARRAY($_tabAttributes_asArray;False)

 APPEND TO ARRAY($_tabAttributes;"memberOf")

 APPEND TO ARRAY($_tabAttributes_asArray;True)

 

 LDAP LOGIN($url;$login;$pwd;LDAP password plain text)

 $entry:=LDAP Search($dnSearchRootEntry;"cn=adrien*";LDAP all levels;$_tabAttributes;$_tabAttributes_asArray)

 LDAP LOGOUT

 

 ARRAY TEXT($_arrMemberOf;0)

 OB GET ARRAY($entry;"memberOf";$_arrMemberOf)

  // em $_arrMemberOf temos um array que contém todos os grupos da entrada

Ver também

LDAP SEARCH ALL