@backstage/plugin-catalog-backend-module-ldap
Home > @backstage/plugin-catalog-backend-module-ldap
A Backstage catalog backend module that helps integrate towards LDAP
Classes
| Class | Description |
|---|---|
| LdapClient | Basic wrapper for the Helps out with promisifying calls, paging, binding etc. |
| LdapOrgEntityProvider | Reads user and group entries out of an LDAP service, and provides them as User and Group entities for the catalog. |
| LdapOrgReaderProcessor | Extracts teams and users out of an LDAP server. |
Functions
| Function | Description |
|---|---|
| defaultGroupTransformer(vendor, config, entry) | The default implementation of the transformation from an LDAP entry to a Group entity. |
| defaultUserTransformer(vendor, config, entry) | The default implementation of the transformation from an LDAP entry to a User entity. |
| mapStringAttr(entry, vendor, attributeName, setter) | Maps a single-valued attribute to a consumer. This helper can be useful when implementing a user or group transformer. |
| readLdapConfig(config) | Parses configuration. |
| readLdapOrg(client, userConfig, groupConfig, options) | Reads users and groups out of an LDAP provider. |
Interfaces
| Interface | Description |
|---|---|
| LdapOrgEntityProviderOptions | Options for LdapOrgEntityProvider. |
Variables
| Variable | Description |
|---|---|
| LDAP_DN_ANNOTATION | The name of an entity annotation, that references the DN of the LDAP object it was ingested from. The DN is the fully qualified name that identifies the item; for example, for an item with the DN uid=john,ou=people,ou=spotify,dc=spotify,dc=net the generated entity would have this annotation, with that full string as its value. |
| LDAP_RDN_ANNOTATION | The name of an entity annotation, that references the RDN of the LDAP object it was ingested from. The RDN is the name of the leftmost attribute that identifies the item; for example, for an item with the fully qualified DN uid=john,ou=people,ou=spotify,dc=spotify,dc=net the generated entity would have this annotation, with the value "john". |
| LDAP_UUID_ANNOTATION | The name of an entity annotation, that references the UUID of the LDAP object it was ingested from. The UUID is the globally unique ID that identifies the item; for example, for an item with the UUID 76ef928a-b251-1037-9840-d78227f36a7e, the generated entity would have this annotation, with that full string as its value. |
Type Aliases
| Type Alias | Description |
|---|---|
| BindConfig | The settings to use for the a command. |
| GroupConfig | The settings that govern the reading and interpretation of groups. |
| GroupTransformer | Customize the ingested Group entity |
| LdapProviderConfig | The configuration parameters for a single LDAP provider. |
| LdapVendor | An LDAP Vendor handles unique nuances between different vendors. |
| TLSConfig | TLS settings |
| UserConfig | The settings that govern the reading and interpretation of users. |
| UserTransformer | Customize the ingested User entity |