Merge pull request #9824 from Bonial-International-GmbH/PJ_msgraph_missing-docs
fix(msgraph): add missing docs for config options
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-catalog-backend-module-msgraph': patch
|
||||
---
|
||||
|
||||
add documentation for config options `userGroupMemberSearch` and `groupSearch`
|
||||
@@ -41,11 +41,20 @@ catalog:
|
||||
# This and userGroupMemberFilter are mutually exclusive, only one can be specified
|
||||
userFilter: accountEnabled eq true and userType eq 'member'
|
||||
# Optional filter for users, use group membership to get users.
|
||||
# (Filtered groups and fetch their members.)
|
||||
# This and userFilter are mutually exclusive, only one can be specified
|
||||
# See https://docs.microsoft.com/en-us/graph/search-query-parameter
|
||||
userGroupMemberFilter: "displayName eq 'Backstage Users'"
|
||||
# Optional search for users, use group membership to get users.
|
||||
# (Search for groups and fetch their members.)
|
||||
# This and userFilter are mutually exclusive, only one can be specified
|
||||
userGroupMemberSearch: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
|
||||
# Optional filter for group, see Microsoft Graph API for the syntax
|
||||
# See https://docs.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties
|
||||
groupFilter: securityEnabled eq false and mailEnabled eq true and groupTypes/any(c:c+eq+'Unified')
|
||||
# Optional search for groups, see Microsoft Graph API for the syntax
|
||||
# See https://docs.microsoft.com/en-us/graph/search-query-parameter
|
||||
groupSearch: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
|
||||
```
|
||||
|
||||
`userFilter` and `userGroupMemberFilter` are mutually exclusive, only one can be provided. If both are provided, an error will be thrown.
|
||||
|
||||
Reference in New Issue
Block a user