GithubMultiOrgEntityProviderOptions
Home > @backstage/plugin-catalog-backend-module-github
> GithubMultiOrgEntityProviderOptions
Options for GithubMultiOrgEntityProvider.
Signature:
export interface GithubMultiOrgEntityProviderOptions
Properties
Property |
Modifiers |
Type |
Description |
---|---|---|---|
boolean |
(Optional) Use the default namespace for groups. By default, groups will be namespaced according to their GitHub org. | ||
(Optional) Passing the optional EventsService enables event-based delta updates. | |||
(Optional) Optionally supply a custom credentials provider, replacing the default one. | |||
string |
The target that this provider should consume. | ||
string |
A unique, stable identifier for this provider. | ||
The logger to use. | |||
string[] |
(Optional) The list of the GitHub orgs to consume. By default, it will consume all accessible orgs on the given GitHub instance (support for GitHub App integration only). | ||
'manual' | SchedulerServiceTaskRunner |
(Optional) The refresh schedule to use. | ||
(Optional) Optionally include a team transformer for transforming from GitHub teams to Group Entities. By default, groups will be namespaced according to their GitHub org. | |||
(Optional) Optionally include a user transformer for transforming from GitHub users to User Entities |