Class LdapOrgEntityProvider

Reads user and group entries out of an LDAP service, and provides them as User and Group entities for the catalog.

Remarks

Add an instance of this class to your catalog builder, and then periodically call the LdapOrgEntityProvider.read method.

Implements

EntityProvider

Index

Constructors

Methods

connect getProviderName read fromConfig fromLegacyConfig

Constructors

constructor

new LdapOrgEntityProvider(
    options: {
        groupTransformer?: GroupTransformer;
        id: string;
        logger: LoggerService;
        provider: LdapProviderConfig;
        userTransformer?: UserTransformer;
    },
): LdapOrgEntityProvider
Parameters
- options: {
      groupTransformer?: GroupTransformer;
      id: string;
      logger: LoggerService;
      provider: LdapProviderConfig;
      userTransformer?: UserTransformer;
  }
Returns LdapOrgEntityProvider
- Defined in plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts:250

Methods

connect

connect(connection: EntityProviderConnection): Promise<void>
Parameters
- connection: EntityProviderConnection
Returns Promise<void>
Implementation of EntityProvider.connect
- Defined in plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts:266

getProviderName

getProviderName(): string
Returns string
Implementation of EntityProvider.getProviderName
- Defined in plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts:261

read

read(options?: { logger?: LoggerService }): Promise<void>
Runs one single complete ingestion. This is only necessary if you use manual scheduling.
Parameters
- Optionaloptions: { logger?: LoggerService }
Returns Promise<void>
- Defined in plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts:275

`Static`fromConfig

fromConfig(
configRoot: Config,
options: LdapOrgEntityProviderOptions,
): LdapOrgEntityProvider[]
Parameters
- configRoot: Config
- options: LdapOrgEntityProviderOptions
Returns LdapOrgEntityProvider[]
- Defined in plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts:159

`Static`fromLegacyConfig

fromLegacyConfig(
configRoot: Config,
options: LdapOrgEntityProviderLegacyOptions,
): LdapOrgEntityProvider
Parameters
- configRoot: Config
- options: LdapOrgEntityProviderLegacyOptions
Returns LdapOrgEntityProvider
- Defined in plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts:215