@backstage/plugin-catalog-backend-module-msgraph 0.0.0-nightly-20220705025009 → 0.0.0-nightly-20220708025041

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,13 +1,203 @@
1
1
  # @backstage/plugin-catalog-backend-module-msgraph
2
2
 
3
- ## 0.0.0-nightly-20220705025009
3
+ ## 0.0.0-nightly-20220708025041
4
+
5
+ ### Minor Changes
6
+
7
+ - a145672f0f: Align `msgraph` plugin's entity provider config with other providers. **Deprecated** entity processor as well as previous config.
8
+
9
+ You will see warning at the log output until you migrate to the new setup.
10
+ All deprecated parts will be removed eventually after giving some time to migrate.
11
+
12
+ Please find information on how to migrate your current setup to the new one below.
13
+
14
+ **Migration Guide:**
15
+
16
+ There were two different way on how to use the msgraph plugin: processor or provider.
17
+
18
+ Previous registration for the processor:
19
+
20
+ ```typescript
21
+ // packages/backend/src/plugins/catalog.ts
22
+ builder.addProcessor(
23
+ MicrosoftGraphOrgReaderProcessor.fromConfig(env.config, {
24
+ logger: env.logger,
25
+ // [...]
26
+ }),
27
+ );
28
+ ```
29
+
30
+ Previous registration when using the provider:
31
+
32
+ ```typescript
33
+ // packages/backend/src/plugins/catalog.ts
34
+ builder.addEntityProvider(
35
+ MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
36
+ id: 'https://graph.microsoft.com/v1.0',
37
+ target: 'https://graph.microsoft.com/v1.0',
38
+ logger: env.logger,
39
+ schedule: env.scheduler.createScheduledTaskRunner({
40
+ frequency: { minutes: 30 },
41
+ timeout: { minutes: 3 },
42
+ }),
43
+ // [...]
44
+ }),
45
+ );
46
+ ```
47
+
48
+ Previous configuration as used for both:
49
+
50
+ ```yaml
51
+ # app-config.yaml
52
+ catalog:
53
+ processors:
54
+ microsoftGraphOrg:
55
+ providers:
56
+ - target: https://graph.microsoft.com/v1.0
57
+ # [...]
58
+ ```
59
+
60
+ **Replacement:**
61
+
62
+ Please check https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-msgraph/README.md for the complete documentation of all configuration options (config as well as registration of the provider).
63
+
64
+ ```yaml
65
+ # app-config.yaml
66
+ catalog:
67
+ providers:
68
+ microsoftGraphOrg:
69
+ # In case you used the deprecated configuration with the entity provider
70
+ # using the value of `target` will keep the same location key for all
71
+ providerId: # some stable ID which will be used as part of the location key for all ingested data
72
+ target: https://graph.microsoft.com/v1.0
73
+ # [...]
74
+ ```
75
+
76
+ ```typescript
77
+ // packages/backend/src/plugins/catalog.ts
78
+ builder.addEntityProvider(
79
+ MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
80
+ logger: env.logger,
81
+ schedule: env.scheduler.createScheduledTaskRunner({
82
+ frequency: { minutes: 30 },
83
+ timeout: { minutes: 3 },
84
+ }),
85
+ // [...]
86
+ }),
87
+ );
88
+ ```
89
+
90
+ In case you've used multiple entity providers before
91
+ **and** you had different transformers for each of them
92
+ you can provide these directly at the one `fromConfig` call
93
+ by passing a Record with the provider ID as key.
94
+
95
+ ### Patch Changes
96
+
97
+ - a70869e775: Updated dependency `msw` to `^0.43.0`.
98
+ - Updated dependencies
99
+ - @backstage/plugin-catalog-backend@0.0.0-nightly-20220708025041
100
+ - @backstage/catalog-model@0.0.0-nightly-20220708025041
101
+ - @backstage/backend-tasks@0.0.0-nightly-20220708025041
102
+
103
+ ## 0.4.0-next.1
104
+
105
+ ### Minor Changes
106
+
107
+ - a145672f0f: Align `msgraph` plugin's entity provider config with other providers. **Deprecated** entity processor as well as previous config.
108
+
109
+ You will see warning at the log output until you migrate to the new setup.
110
+ All deprecated parts will be removed eventually after giving some time to migrate.
111
+
112
+ Please find information on how to migrate your current setup to the new one below.
113
+
114
+ **Migration Guide:**
115
+
116
+ There were two different way on how to use the msgraph plugin: processor or provider.
117
+
118
+ Previous registration for the processor:
119
+
120
+ ```typescript
121
+ // packages/backend/src/plugins/catalog.ts
122
+ builder.addProcessor(
123
+ MicrosoftGraphOrgReaderProcessor.fromConfig(env.config, {
124
+ logger: env.logger,
125
+ // [...]
126
+ }),
127
+ );
128
+ ```
129
+
130
+ Previous registration when using the provider:
131
+
132
+ ```typescript
133
+ // packages/backend/src/plugins/catalog.ts
134
+ builder.addEntityProvider(
135
+ MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
136
+ id: 'https://graph.microsoft.com/v1.0',
137
+ target: 'https://graph.microsoft.com/v1.0',
138
+ logger: env.logger,
139
+ schedule: env.scheduler.createScheduledTaskRunner({
140
+ frequency: { minutes: 30 },
141
+ timeout: { minutes: 3 },
142
+ }),
143
+ // [...]
144
+ }),
145
+ );
146
+ ```
147
+
148
+ Previous configuration as used for both:
149
+
150
+ ```yaml
151
+ # app-config.yaml
152
+ catalog:
153
+ processors:
154
+ microsoftGraphOrg:
155
+ providers:
156
+ - target: https://graph.microsoft.com/v1.0
157
+ # [...]
158
+ ```
159
+
160
+ **Replacement:**
161
+
162
+ Please check https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-msgraph/README.md for the complete documentation of all configuration options (config as well as registration of the provider).
163
+
164
+ ```yaml
165
+ # app-config.yaml
166
+ catalog:
167
+ providers:
168
+ microsoftGraphOrg:
169
+ # In case you used the deprecated configuration with the entity provider
170
+ # using the value of `target` will keep the same location key for all
171
+ providerId: # some stable ID which will be used as part of the location key for all ingested data
172
+ target: https://graph.microsoft.com/v1.0
173
+ # [...]
174
+ ```
175
+
176
+ ```typescript
177
+ // packages/backend/src/plugins/catalog.ts
178
+ builder.addEntityProvider(
179
+ MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
180
+ logger: env.logger,
181
+ schedule: env.scheduler.createScheduledTaskRunner({
182
+ frequency: { minutes: 30 },
183
+ timeout: { minutes: 3 },
184
+ }),
185
+ // [...]
186
+ }),
187
+ );
188
+ ```
189
+
190
+ In case you've used multiple entity providers before
191
+ **and** you had different transformers for each of them
192
+ you can provide these directly at the one `fromConfig` call
193
+ by passing a Record with the provider ID as key.
4
194
 
5
195
  ### Patch Changes
6
196
 
7
197
  - Updated dependencies
8
- - @backstage/catalog-model@0.0.0-nightly-20220705025009
9
- - @backstage/backend-tasks@0.0.0-nightly-20220705025009
10
- - @backstage/plugin-catalog-backend@0.0.0-nightly-20220705025009
198
+ - @backstage/catalog-model@1.1.0-next.2
199
+ - @backstage/backend-tasks@0.3.3-next.2
200
+ - @backstage/plugin-catalog-backend@1.2.1-next.2
11
201
 
12
202
  ## 0.3.4-next.0
13
203
 
package/README.md CHANGED
@@ -1,85 +1,86 @@
1
1
  # Catalog Backend Module for Microsoft Graph
2
2
 
3
- This is an extension module to the `plugin-catalog-backend` plugin, providing a
4
- `MicrosoftGraphOrgReaderProcessor` and a `MicrosoftGraphOrgEntityProvider` that
5
- can be used to ingest organization data from the Microsoft Graph API. This
6
- processor is useful if you want to import users and groups from Azure Active
7
- Directory or Office 365.
3
+ This is an extension module to the `plugin-catalog-backend` plugin, providing a `MicrosoftGraphOrgEntityProvider`
4
+ that can be used to ingest organization data from the Microsoft Graph API.
5
+ This provider is useful if you want to import users and groups from Azure Active Directory or Office 365.
8
6
 
9
7
  ## Getting Started
10
8
 
11
- First you need to decide whether you want to use an [entity provider or a processor](https://backstage.io/docs/features/software-catalog/life-of-an-entity#stitching) to ingest the organization data.
12
- If you want groups and users deleted from the source to be automatically deleted
13
- from Backstage, choose the entity provider.
14
-
15
9
  1. Create or use an existing App registration in the [Microsoft Azure Portal](https://portal.azure.com/).
16
10
  The App registration requires at least the API permissions `Group.Read.All`,
17
11
  `GroupMember.Read.All`, `User.Read` and `User.Read.All` for Microsoft Graph
18
12
  (if you still run into errors about insufficient privileges, add
19
13
  `Team.ReadBasic.All` and `TeamMember.Read.All` too).
20
14
 
21
- 2. Configure the processor or entity provider:
15
+ 2. Configure the entity provider:
22
16
 
23
17
  ```yaml
24
18
  # app-config.yaml
25
19
  catalog:
26
- processors:
20
+ providers:
27
21
  microsoftGraphOrg:
28
- providers:
29
- - target: https://graph.microsoft.com/v1.0
30
- authority: https://login.microsoftonline.com
31
- # If you don't know you tenantId, you can use Microsoft Graph Explorer
32
- # to query it
33
- tenantId: ${MICROSOFT_GRAPH_TENANT_ID}
34
- # Client Id and Secret can be created under Certificates & secrets in
35
- # the App registration in the Microsoft Azure Portal.
36
- clientId: ${MICROSOFT_GRAPH_CLIENT_ID}
37
- clientSecret: ${MICROSOFT_GRAPH_CLIENT_SECRET_TOKEN}
38
- # Optional mode for querying which defaults to "basic".
39
- # By default, the Microsoft Graph API only provides the basic feature set
40
- # for querying. Certain features are limited to advanced querying capabilities.
41
- # (See https://docs.microsoft.com/en-us/graph/aad-advanced-queries)
42
- queryMode: basic # basic | advanced
22
+ providerId:
23
+ target: https://graph.microsoft.com/v1.0
24
+ authority: https://login.microsoftonline.com
25
+ # If you don't know you tenantId, you can use Microsoft Graph Explorer
26
+ # to query it
27
+ tenantId: ${MICROSOFT_GRAPH_TENANT_ID}
28
+ # Client Id and Secret can be created under Certificates & secrets in
29
+ # the App registration in the Microsoft Azure Portal.
30
+ clientId: ${MICROSOFT_GRAPH_CLIENT_ID}
31
+ clientSecret: ${MICROSOFT_GRAPH_CLIENT_SECRET_TOKEN}
32
+ # Optional mode for querying which defaults to "basic".
33
+ # By default, the Microsoft Graph API only provides the basic feature set
34
+ # for querying. Certain features are limited to advanced querying capabilities.
35
+ # (See https://docs.microsoft.com/en-us/graph/aad-advanced-queries)
36
+ queryMode: basic # basic | advanced
37
+ # Optional configuration block
38
+ user:
43
39
  # Optional parameter to include the expanded resource or collection referenced
44
40
  # by a single relationship (navigation property) in your results.
45
41
  # Only one relationship can be expanded in a single request.
46
42
  # See https://docs.microsoft.com/en-us/graph/query-parameters#expand-parameter
47
43
  # Can be combined with userGroupMember[...] instead of userFilter.
48
- userExpand: manager
44
+ expand: manager
49
45
  # Optional filter for user, see Microsoft Graph API for the syntax
50
46
  # See https://docs.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties
51
47
  # and for the syntax https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter
52
48
  # This and userGroupMemberFilter are mutually exclusive, only one can be specified
53
- userFilter: accountEnabled eq true and userType eq 'member'
49
+ filter: accountEnabled eq true and userType eq 'member'
50
+ # Optional configuration block
51
+ userGroupMember:
54
52
  # Optional filter for users, use group membership to get users.
55
53
  # (Filtered groups and fetch their members.)
56
54
  # This and userFilter are mutually exclusive, only one can be specified
57
55
  # See https://docs.microsoft.com/en-us/graph/search-query-parameter
58
- userGroupMemberFilter: "displayName eq 'Backstage Users'"
56
+ filter: "displayName eq 'Backstage Users'"
57
+ # Optional search for users, use group membership to get users.
58
+ # (Search for groups and fetch their members.)
59
+ # This and userFilter are mutually exclusive, only one can be specified
60
+ search: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
61
+ # Optional configuration block
62
+ group:
59
63
  # Optional parameter to include the expanded resource or collection referenced
60
64
  # by a single relationship (navigation property) in your results.
61
65
  # Only one relationship can be expanded in a single request.
62
66
  # See https://docs.microsoft.com/en-us/graph/query-parameters#expand-parameter
63
67
  # Can be combined with userGroupMember[...] instead of userFilter.
64
- groupExpand: member
65
- # Optional search for users, use group membership to get users.
66
- # (Search for groups and fetch their members.)
67
- # This and userFilter are mutually exclusive, only one can be specified
68
- userGroupMemberSearch: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
68
+ expand: member
69
69
  # Optional filter for group, see Microsoft Graph API for the syntax
70
70
  # See https://docs.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties
71
- groupFilter: securityEnabled eq false and mailEnabled eq true and groupTypes/any(c:c+eq+'Unified')
71
+ filter: securityEnabled eq false and mailEnabled eq true and groupTypes/any(c:c+eq+'Unified')
72
72
  # Optional search for groups, see Microsoft Graph API for the syntax
73
73
  # See https://docs.microsoft.com/en-us/graph/search-query-parameter
74
- groupSearch: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
75
- # Optional select for groups, this will allow you work with schemaExtensions in order to add extra information to your groups that can be used on you custom groupTransformers
74
+ search: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
75
+ # Optional select for groups, this will allow you work with schemaExtensions
76
+ # in order to add extra information to your groups that can be used on you custom groupTransformers
76
77
  # See https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0
77
- groupSelect: ['id', 'displayName', 'description']
78
+ select: ['id', 'displayName', 'description']
78
79
  ```
79
80
 
80
- `userFilter` and `userGroupMemberFilter` are mutually exclusive, only one can be provided. If both are provided, an error will be thrown.
81
+ `user.filter` and `userGroupMember.filter` are mutually exclusive, only one can be provided. If both are provided, an error will be thrown.
81
82
 
82
- By default, all users are loaded. If you want to filter users based on their attributes, use `userFilter`. `userGroupMemberFilter` can be used if you want to load users based on their group membership.
83
+ By default, all users are loaded. If you want to filter users based on their attributes, use `user.filter`. `userGroupMember.filter` can be used if you want to load users based on their group membership.
83
84
 
84
85
  3. The package is not installed by default, therefore you have to add a
85
86
  dependency to `@backstage/plugin-catalog-backend-module-msgraph` to your
@@ -90,15 +91,12 @@ By default, all users are loaded. If you want to filter users based on their att
90
91
  yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-msgraph
91
92
  ```
92
93
 
93
- ### Using the Entity Provider
94
-
95
94
  4. The `MicrosoftGraphOrgEntityProvider` is not registered by default, so you
96
95
  have to register it in the catalog plugin. Pass the target to reference a
97
96
  provider from the configuration.
98
97
 
99
98
  ```diff
100
99
  // packages/backend/src/plugins/catalog.ts
101
- +import { Duration } from 'luxon';
102
100
  +import { MicrosoftGraphOrgEntityProvider } from '@backstage/plugin-catalog-backend-module-msgraph';
103
101
 
104
102
  export default async function createPlugin(
@@ -106,53 +104,21 @@ yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-msgraph
106
104
  ): Promise<Router> {
107
105
  const builder = await CatalogBuilder.create(env);
108
106
 
109
- + // The target parameter below needs to match one of the providers' target
110
- + // value specified in your app-config (see above).
111
107
  + builder.addEntityProvider(
112
108
  + MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
113
- + id: 'production',
114
- + target: 'https://graph.microsoft.com/v1.0',
115
109
  + logger: env.logger,
116
110
  + schedule: env.scheduler.createScheduledTaskRunner({
117
- + frequency: Duration.fromObject({ minutes: 5 }),
118
- + timeout: Duration.fromObject({ minutes: 3 }),
111
+ + frequency: { minutes: 5 },
112
+ + timeout: { minutes: 3 },
119
113
  + }),
120
114
  + }),
121
115
  + );
122
116
  ```
123
117
 
124
- ### Using the Processor
125
-
126
- 4. The `MicrosoftGraphOrgReaderProcessor` is not registered by default, so you
127
- have to register it in the catalog plugin:
128
-
129
- ```typescript
130
- // packages/backend/src/plugins/catalog.ts
131
- builder.addProcessor(
132
- MicrosoftGraphOrgReaderProcessor.fromConfig(env.config, {
133
- logger: env.logger,
134
- }),
135
- );
136
- ```
137
-
138
- 5. Add a location that ingests from Microsoft Graph:
139
-
140
- ```yaml
141
- # app-config.yaml
142
- catalog:
143
- locations:
144
- - type: microsoft-graph-org
145
- target: https://graph.microsoft.com/v1.0
146
- rules:
147
- - allow: [Group, User]
148
- …
149
- ```
150
-
151
118
  ## Customize the Processor or Entity Provider
152
119
 
153
- In case you want to customize the ingested entities, both the `MicrosoftGraphOrgReaderProcessor`
154
- and the `MicrosoftGraphOrgEntityProvider` allows to pass transformers for users,
155
- groups and the organization.
120
+ In case you want to customize the ingested entities, the `MicrosoftGraphOrgEntityProvider`
121
+ allows to pass transformers for users, groups and the organization.
156
122
 
157
123
  1. Create a transformer:
158
124
 
@@ -179,13 +145,17 @@ export async function myGroupTransformer(
179
145
  }
180
146
  ```
181
147
 
182
- 2. Configure the processor with the transformer:
148
+ 2. Add the transformer:
183
149
 
184
- ```ts
185
- builder.addProcessor(
186
- MicrosoftGraphOrgReaderProcessor.fromConfig(env.config, {
187
- logger: env.logger,
188
- groupTransformer: myGroupTransformer,
189
- }),
190
- );
150
+ ```diff
151
+ builder.addEntityProvider(
152
+ MicrosoftGraphOrgEntityProvider.fromConfig(env.config, {
153
+ logger: env.logger,
154
+ schedule: env.scheduler.createScheduledTaskRunner({
155
+ frequency: { minutes: 5 },
156
+ timeout: { minutes: 3 },
157
+ }),
158
+ + groupTransformer: myGroupTransformer,
159
+ }),
160
+ );
191
161
  ```
package/config.d.ts CHANGED
@@ -25,6 +25,7 @@ export interface Config {
25
25
  processors?: {
26
26
  /**
27
27
  * MicrosoftGraphOrgReaderProcessor configuration
28
+ * @deprecated Use `catalog.providers.microsoftGraphOrg` instead.
28
29
  */
29
30
  microsoftGraphOrg?: {
30
31
  /**
@@ -102,5 +103,173 @@ export interface Config {
102
103
  }>;
103
104
  };
104
105
  };
106
+ /**
107
+ * List of provider-specific options and attributes
108
+ */
109
+ providers?: {
110
+ /**
111
+ * MicrosoftGraphOrgEntityProvider configuration.
112
+ */
113
+ microsoftGraphOrg?:
114
+ | {
115
+ /**
116
+ * The prefix of the target that this matches on, e.g.
117
+ * "https://graph.microsoft.com/v1.0", with no trailing slash.
118
+ */
119
+ target: string;
120
+ /**
121
+ * The auth authority used.
122
+ *
123
+ * Default value "https://login.microsoftonline.com"
124
+ */
125
+ authority?: string;
126
+ /**
127
+ * The tenant whose org data we are interested in.
128
+ */
129
+ tenantId: string;
130
+ /**
131
+ * The OAuth client ID to use for authenticating requests.
132
+ */
133
+ clientId: string;
134
+ /**
135
+ * The OAuth client secret to use for authenticating requests.
136
+ *
137
+ * @visibility secret
138
+ */
139
+ clientSecret: string;
140
+
141
+ user?: {
142
+ /**
143
+ * The "expand" argument to apply to users.
144
+ *
145
+ * E.g. "manager".
146
+ */
147
+ expand?: string;
148
+ /**
149
+ * The filter to apply to extract users.
150
+ *
151
+ * E.g. "accountEnabled eq true and userType eq 'member'"
152
+ */
153
+ filter?: string;
154
+ };
155
+
156
+ group?: {
157
+ /**
158
+ * The "expand" argument to apply to groups.
159
+ *
160
+ * E.g. "member".
161
+ */
162
+ expand?: string;
163
+ /**
164
+ * The filter to apply to extract groups.
165
+ *
166
+ * E.g. "securityEnabled eq false and mailEnabled eq true"
167
+ */
168
+ filter?: string;
169
+ /**
170
+ * The search criteria to apply to extract users by groups memberships.
171
+ *
172
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
173
+ */
174
+ search?: string;
175
+ /**
176
+ * The fields to be fetched on query.
177
+ *
178
+ * E.g. ["id", "displayName", "description"]
179
+ */
180
+ select?: string[];
181
+ };
182
+
183
+ userGroupMember?: {
184
+ /**
185
+ * The filter to apply to extract users by groups memberships.
186
+ *
187
+ * E.g. "displayName eq 'Backstage Users'"
188
+ */
189
+ filter?: string;
190
+ /**
191
+ * The search criteria to apply to extract groups.
192
+ *
193
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
194
+ */
195
+ search?: string;
196
+ };
197
+ }
198
+ | Record<
199
+ string,
200
+ {
201
+ /**
202
+ * The prefix of the target that this matches on, e.g.
203
+ * "https://graph.microsoft.com/v1.0", with no trailing slash.
204
+ */
205
+ target: string;
206
+ /**
207
+ * The auth authority used.
208
+ *
209
+ * Default value "https://login.microsoftonline.com"
210
+ */
211
+ authority?: string;
212
+ /**
213
+ * The tenant whose org data we are interested in.
214
+ */
215
+ tenantId: string;
216
+ /**
217
+ * The OAuth client ID to use for authenticating requests.
218
+ */
219
+ clientId: string;
220
+ /**
221
+ * The OAuth client secret to use for authenticating requests.
222
+ *
223
+ * @visibility secret
224
+ */
225
+ clientSecret: string;
226
+
227
+ user?: {
228
+ /**
229
+ * The filter to apply to extract users.
230
+ *
231
+ * E.g. "accountEnabled eq true and userType eq 'member'"
232
+ */
233
+ filter?: string;
234
+ };
235
+
236
+ group?: {
237
+ /**
238
+ * The filter to apply to extract groups.
239
+ *
240
+ * E.g. "securityEnabled eq false and mailEnabled eq true"
241
+ */
242
+ filter?: string;
243
+ /**
244
+ * The search criteria to apply to extract users by groups memberships.
245
+ *
246
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
247
+ */
248
+ search?: string;
249
+ /**
250
+ * The fields to be fetched on query.
251
+ *
252
+ * E.g. ["id", "displayName", "description"]
253
+ */
254
+ select?: string[];
255
+ };
256
+
257
+ userGroupMember?: {
258
+ /**
259
+ * The filter to apply to extract users by groups memberships.
260
+ *
261
+ * E.g. "displayName eq 'Backstage Users'"
262
+ */
263
+ filter?: string;
264
+ /**
265
+ * The search criteria to apply to extract groups.
266
+ *
267
+ * E.g. "\"displayName:-team\"" would only match groups which contain '-team'
268
+ */
269
+ search?: string;
270
+ };
271
+ }
272
+ >;
273
+ };
105
274
  };
106
275
  }