GithubMultiOrgEntityProviderOptions
Home > @backstage/plugin-catalog-backend-module-github > GithubMultiOrgEntityProviderOptions
Options for GithubMultiOrgEntityProvider.
Signature:
export interface GithubMultiOrgEntityProviderOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| events? | EventsService | (Optional) Passing the optional EventsService enables event-based delta updates. | |
| githubCredentialsProvider? | GithubCredentialsProvider | (Optional) Optionally supply a custom credentials provider, replacing the default one. | |
| githubUrl | string | The target that this provider should consume. | |
| id | string | A unique, stable identifier for this provider. | |
| logger | LoggerService | The logger to use. | |
| orgs? | 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). | |
| schedule? | 'manual' | TaskRunner | (Optional) The refresh schedule to use. | |
| teamTransformer? | TeamTransformer | (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. | |
| userTransformer? | UserTransformer | (Optional) Optionally include a user transformer for transforming from GitHub users to User Entities |