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 |
The LDAP client | |
userConfig |
The user data configuration | |
groupConfig |
The group data configuration | |
vendorConfig |
VendorConfig | undefined | |
options |
{ groupTransformer?: GroupTransformer; userTransformer?: UserTransformer; logger: LoggerService; } |
Additional options |
Promise<{ users: UserEntity[]; groups: GroupEntity[]; }>