npm package: @kronos-integration/service-ldap
Description: ldap auth service
Latest version: 6.1.1

[![npm](https://img.shields.io/npm/v/@kronos-integration/service-ldap.svg)](https://www.npmjs.com/package/@kronos-integration/service-ldap)
[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
[![bundlejs](https://deno.bundlejs.com/?q=@kronos-integration/service-ldap\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/service-ldap)
[![downloads](http://img.shields.io/npm/dm/@kronos-integration/service-ldap.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/service-ldap)
[![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/service-ldap.svg?style=flat-square)](https://github.com/Kronos-Integration/service-ldap/issues)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fservice-ldap%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/service-ldap/goto)
[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/service-ldap/badge.svg)](https://snyk.io/test/github/Kronos-Integration/service-ldap)

# @kronos-integration/service-ldap

ldap

# usage

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

*   [ServiceLDAP](#serviceldap)
    *   [search](#search)
        *   [Parameters](#parameters)
    *   [authenticate](#authenticate)
        *   [Parameters](#parameters-1)
    *   [name](#name)

## ServiceLDAP

**Extends Service**

LDAP

### search

Execute a query.

#### Parameters

*   `request` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>** result

### authenticate

Authorize with username and password.

#### Parameters

*   `props` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;

    *   `props.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
    *   `props.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>>** entitlements

### name

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'ldap'

# install

With [npm](http://npmjs.org) do:

```shell
npm install @kronos-integration/service-ldap
```

# license

BSD-2-Clause