From 3c7ca547cf6e02b08e73975fb870b01a9f8eb9ad Mon Sep 17 00:00:00 2001 From: Marc Guasch Date: Tue, 1 Sep 2020 15:35:19 +0200 Subject: [PATCH] [Filebeat][Gsuite] Add note about admin in gsuite docs (#20855) * Add note about admin in gsuite docs * Make required steps a list * Uppercase filebeat --- filebeat/docs/modules/gsuite.asciidoc | 9 ++++++--- x-pack/filebeat/module/gsuite/_meta/docs.asciidoc | 9 ++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/filebeat/docs/modules/gsuite.asciidoc b/filebeat/docs/modules/gsuite.asciidoc index 81e14071013..2b268425355 100644 --- a/filebeat/docs/modules/gsuite.asciidoc +++ b/filebeat/docs/modules/gsuite.asciidoc @@ -32,12 +32,15 @@ It is compatible with a subset of applications under the https://developers.goog | Groups https://developers.google.com/admin-sdk/reports/v1/appendix/activity/groups[api docs] https://support.google.com/a/answer/6270454?hl=en&ref_topic=9027054[help] | Track changes to groups, group memberships and group messages. | |=========================================================================================================================================================================================================================== +[float] === Configure the module -In order for filebeat to ingest data from the Google Reports API you must https://support.google.com/gsuitemigrate/answer/9222993?hl=en[set up a ServiceAccount] that https://support.google.com/gsuitemigrate/answer/9222865?hl=en[has access to the Admin SDK API]. - +In order for Filebeat to ingest data from the Google Reports API you must: -Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly. +- Have an *administrator account*. +- https://support.google.com/gsuitemigrate/answer/9222993?hl=en[Set up a ServiceAccount] using the administrator account. +- https://support.google.com/gsuitemigrate/answer/9222865?hl=en[Set up access to the Admin SDK API] for the ServiceAccount. +- https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Enable Domain-Wide Delegation] for your ServiceAccount. This module will make use of the following *oauth2 scope*: diff --git a/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc b/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc index 70c8fabf63d..37f11e4a945 100644 --- a/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc @@ -27,12 +27,15 @@ It is compatible with a subset of applications under the https://developers.goog | Groups https://developers.google.com/admin-sdk/reports/v1/appendix/activity/groups[api docs] https://support.google.com/a/answer/6270454?hl=en&ref_topic=9027054[help] | Track changes to groups, group memberships and group messages. | |=========================================================================================================================================================================================================================== +[float] === Configure the module -In order for filebeat to ingest data from the Google Reports API you must https://support.google.com/gsuitemigrate/answer/9222993?hl=en[set up a ServiceAccount] that https://support.google.com/gsuitemigrate/answer/9222865?hl=en[has access to the Admin SDK API]. - +In order for Filebeat to ingest data from the Google Reports API you must: -Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly. +- Have an *administrator account*. +- https://support.google.com/gsuitemigrate/answer/9222993?hl=en[Set up a ServiceAccount] using the administrator account. +- https://support.google.com/gsuitemigrate/answer/9222865?hl=en[Set up access to the Admin SDK API] for the ServiceAccount. +- https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Enable Domain-Wide Delegation] for your ServiceAccount. This module will make use of the following *oauth2 scope*: