Version: Next

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[], vendorConfig: VendorConfig | undefined, options: {
    groupTransformer?: GroupTransformer;
    userTransformer?: UserTransformer;
    logger: LoggerService;
}): Promise<{
    users: UserEntity[];
    groups: GroupEntity[];
}>;

Parameters

Parameter	Type	Description
client	LdapClient	The LDAP client
userConfig	UserConfig[]	The user data configuration
groupConfig	GroupConfig[]	The group data configuration
vendorConfig	VendorConfig \| undefined
options	{ groupTransformer?: GroupTransformer; userTransformer?: UserTransformer; logger: LoggerService; }	Additional options

Returns:

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

Parameters​

Parameters