@backstage/plugin-catalog-backend-module-msgraph
Home > @backstage/plugin-catalog-backend-module-msgraph
A Backstage catalog backend module that helps integrate towards Microsoft Graph
Classes
| Class | Description |
|---|---|
| MicrosoftGraphClient | A HTTP Client that communicates with Microsoft Graph API. Simplify Authentication and API calls to get Uses |
| MicrosoftGraphOrgEntityProvider | Reads user and group entries out of Microsoft Graph, and provides them as User and Group entities for the catalog. |
| MicrosoftGraphOrgReaderProcessor | Extracts teams and users out of the Microsoft Graph API. |
Functions
| Function | Description |
|---|---|
| defaultGroupTransformer(group, groupPhoto) | The default implementation of the transformation from a graph group entry to a Group entity. |
| defaultOrganizationTransformer(organization) | The default implementation of the transformation from a graph organization entry to a Group entity. |
| defaultUserTransformer(user, userPhoto) | The default implementation of the transformation from a graph user entry to a User entity. |
| normalizeEntityName(name) | Takes an input string and cleans it up to become suitable as an entity name. |
| readMicrosoftGraphConfig(config) | Parses configuration. |
| readMicrosoftGraphOrg(client, tenantId, options) | Reads an entire org as Group and User entities. |
| readProviderConfig(id, config) | Parses a single configured provider by id. |
| readProviderConfigs(config) | Parses all configured providers. |
Interfaces
| Interface | Description |
|---|---|
| MicrosoftGraphOrgEntityProviderLegacyOptions | Legacy options for MicrosoftGraphOrgEntityProvider based on catalog.processors.microsoftGraphOrg. |
Variables
| Variable | Description |
|---|---|
| MICROSOFT_EMAIL_ANNOTATION | The (primary) user email. Also used by the Microsoft auth provider to resolve the User entity. |
| MICROSOFT_GRAPH_GROUP_ID_ANNOTATION | The group id used by the Microsoft Graph API |
| MICROSOFT_GRAPH_TENANT_ID_ANNOTATION | The tenant id used by the Microsoft Graph API |
| MICROSOFT_GRAPH_USER_ID_ANNOTATION | The user id used by the Microsoft Graph API |
Type Aliases
| Type Alias | Description |
|---|---|
| GroupMember | Extends the base msgraph types to include the odata type. |
| GroupTransformer | Customize the ingested Group entity |
| MicrosoftGraphOrgEntityProviderOptions | Options for MicrosoftGraphOrgEntityProvider. |
| MicrosoftGraphProviderConfig | The configuration parameters for a single Microsoft Graph provider. |
| ODataQuery | OData (Open Data Protocol) Query https://docs.microsoft.com/en-us/odata/concepts/queryoptions-overview https://docs.microsoft.com/en-us/graph/query-parameters |
| OrganizationTransformer | Customize the ingested organization Group entity |
| UserTransformer | Customize the ingested User entity |