Class AdClient

description: this is a class to provide low level promise base interaction with ldap server

Hierarchy

AdClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AdClient(config: IClientConfig): AdClient

- Defined in src/index.ts:46
Parameters
- config: IClientConfig
Returns AdClient

Properties

baseDN

baseDN: string

Private client

client: Client

Private config

config: IClientConfig

Private Optional logger

logger: Logger

Methods

bind

bind(): Promise<Client>

- Defined in src/index.ts:59
Returns Promise<Client>

a connected ldap client that is useful for use flexibility of ldap.js directly.

Private connect

connect(): Promise<Client>

- Defined in src/index.ts:77
Returns Promise<Client>

findGroup

findGroup(groupName: string, options?: FindGroupsInputOptions): Promise<Group>

- Defined in src/index.ts:129
deprecated

will be remove in next major version. this functionality will be added to another package soon

description

return first found group or fail

Parameters
- groupName: string
- Optional options: FindGroupsInputOptions
Returns Promise<Group>

findUser

findUser(username: string, options?: FindUsersInputOptions): Promise<User>

- Defined in src/index.ts:89
deprecated

will be remove in next major version. this functionality will be added to another package soon

description

return first found user

Parameters
- username: string
- Optional options: FindUsersInputOptions
Returns Promise<User>

findUsers

findUsers(searchCriteria: string, options?: FindUsersInputOptions): Promise<User[]>

- Defined in src/index.ts:107
deprecated

will be remove in next major version. this functionality will be added to another package soon

description

return array of users based on UPN

Parameters
- searchCriteria: string
- Optional options: FindUsersInputOptions
Returns Promise<User[]>

getGroupMembershipForUser

getGroupMembershipForUser(username: string, options?: FindGroupsInputOptions): Promise<Group[]>

- Defined in src/index.ts:147
deprecated

will be remove in next major version. this functionality will be added to another package soon

description

return array of groups

Parameters
- username: string
- Optional options: FindGroupsInputOptions
Returns Promise<Group[]>

query

query(__namedParameters: { base: string; controls: any; options: SearchOptions }): Promise<SearchEntry[]>

- Defined in src/index.ts:163
description

raw search to provided full flexibility

Parameters
- __namedParameters: { base: string; controls: any; options: SearchOptions }
  - base: string
  - controls: any
  - options: SearchOptions
Returns Promise<SearchEntry[]>

queryAttributes

queryAttributes(__namedParameters: { base: string; controls: any; options: SearchOptions }): Promise<SearchEntryObject[]>

- Defined in src/index.ts:176
description

raw search returns just attributes

Parameters
- __namedParameters: { base: string; controls: any; options: SearchOptions }
  - base: string
  - controls: any
  - options: SearchOptions
Returns Promise<SearchEntryObject[]>

unbind

unbind(): void

- Defined in src/index.ts:72
Returns void

Generated using TypeDoc