Skip to main content

readLdapOrg()

Home > @backstage/plugin-catalog-backend-module-ldap > readLdapOrg

Reads users and groups out of an LDAP provider.

Signature:

function readLdapOrg(client: LdapClient, userConfig: UserConfig, groupConfig: GroupConfig, options: {
groupTransformer?: GroupTransformer;
userTransformer?: UserTransformer;
logger: Logger;
}): Promise<{
users: UserEntity[];
groups: GroupEntity[];
}>;

Parameters

ParameterTypeDescription
clientLdapClientThe LDAP client
userConfigUserConfigThe user data configuration
groupConfigGroupConfigThe group data configuration
options{ groupTransformer?: GroupTransformer; userTransformer?: UserTransformer; logger: Logger; }Additional options

Returns:

Promise<{ users: UserEntity[]; groups: GroupEntity[]; }>