external-groups-example.yaml

#   Copyright 2021 Google LLC
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
retryPeriod: 3 day ago

# This example shows Directory API called twice, first to retrieve
# all groups and then to retrieve group settings for those groups.
# Then finally, all groups that allow external members are printed
# out.
#
# You could also use Pub/Sub fanout to parallelize the processing
# (see groups-example.yaml)
# 
processors:
  - { processor: directory, config: get_groups }
  - { processor: directory, config: get_group_settings }

get_groups:
  ### Fetching list of groups ###
  api: groups
  domain: example.com
  query: ""
  serviceAccountEmail: service-account@your-project.iam.gserviceaccount.com

get_group_settings:
  ### Fetching list of groups ###
  api: groupsettings
  domain: example.com
  groupUniqueIds: |
    {{ results|map(attribute='email')|list|json_encode }}
  query: ""
  serviceAccountEmail: service-account@your-project.iam.gserviceaccount.com

outputs:
  - type: logger
    level: debug
    message: |
      The following groups allow external members:

      {% for group in results|selectattr('allowExternalMembers', 'equalto', 'true') %}
        - {{ group['email'] }} ({{ group['name'] }})
      {% endfor %}