Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elasticio/ldap-component

LDAP component for the elastic.io platform
https://github.com/elasticio/ldap-component

Last synced: 3 days ago
JSON representation

LDAP component for the elastic.io platform

Awesome Lists containing this project

README

        

[![CircleCI](https://circleci.com/gh/elasticio/ldap-component.svg?style=svg)](https://circleci.com/gh/elasticio/ldap-component)
# ldap-component

LDAP component for the [elastic.io platform](http://www.elastic.io)

Lightweight Directory Access Protocol is an open, vendor-neutral, industry
standard application protocol for accessing and maintaining distributed
directory information services over an Internet Protocol (IP) network. Directory
services play an important role in developing intranet and Internet applications
by allowing the sharing of information about users, systems, networks, services,
and applications throughout the network.

# Actions
## Search
Performs an [LDAP search operation](https://www.ldap.com/the-ldap-search-operation) on the instance.
* *Base* refers to the base object in the directory from which to start the search.
* *Filter* allows you to specify one or more [LDAP
filters](https://www.ldap.com/ldap-filters) to restrict the results of the
search.
* *Scope* refers to the [search
scope](https://www.ldap.com/the-ldap-search-operation). Options are `base`,
`one` or `sub` (sometimes called `baseObject`, `singleLevel` or `wholeSubtree`
respectively). The `subordinates` (a.k.a. `subordinateSubtree`) scope is not
yet supported.

Each matched result is returned individually.

# Development
This component has some integration tests. In order to run the integration
tests, one needs to create a `.env` file which contains the following
environment variables:

```
LDAP_URL=
LDAPUSER=
PASSWORD=
BASE=
```

# Configuration Info
## Required environment variables
No environment variables need to be configured.

## Version and compatibility information
This component interacts with LDAP v3.

## License

Apache-2.0 © [Elastic.io GmbH](elastic.io)

[travis-image]: https://travis-ci.org/elasticio/ldap-component.svg?branch=master
[travis-url]: https://travis-ci.org/elasticio/ldap-component
[daviddm-image]: https://david-dm.org/elasticio/ldap-component.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/elasticio/ldap-component