From 7b1722d49276d757c098711c50cca205bedc2fff Mon Sep 17 00:00:00 2001 From: Marc Guasch Date: Mon, 31 Aug 2020 12:47:01 +0200 Subject: [PATCH 1/3] Add note about admin in gsuite docs --- filebeat/docs/modules/gsuite.asciidoc | 2 ++ x-pack/filebeat/module/gsuite/_meta/docs.asciidoc | 2 ++ 2 files changed, 4 insertions(+) diff --git a/filebeat/docs/modules/gsuite.asciidoc b/filebeat/docs/modules/gsuite.asciidoc index 81e14071013e..be3174ddc3ea 100644 --- a/filebeat/docs/modules/gsuite.asciidoc +++ b/filebeat/docs/modules/gsuite.asciidoc @@ -32,10 +32,12 @@ 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]. +NOTE: It is required that the account used to set up the service account *is an administrator account*. Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly. diff --git a/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc b/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc index 70c8fabf63d7..5424e4414840 100644 --- a/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc @@ -27,10 +27,12 @@ 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]. +NOTE: It is required that the account used to set up the service account *is an administrator account*. Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly. From 2a2e8f684d56a99df79361e171ac68799876a3b2 Mon Sep 17 00:00:00 2001 From: Marc Guasch Date: Tue, 1 Sep 2020 09:38:26 +0200 Subject: [PATCH 2/3] Make required steps a list --- filebeat/docs/modules/gsuite.asciidoc | 9 +++++---- x-pack/filebeat/module/gsuite/_meta/docs.asciidoc | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/filebeat/docs/modules/gsuite.asciidoc b/filebeat/docs/modules/gsuite.asciidoc index be3174ddc3ea..33bb78ba8b70 100644 --- a/filebeat/docs/modules/gsuite.asciidoc +++ b/filebeat/docs/modules/gsuite.asciidoc @@ -35,11 +35,12 @@ It is compatible with a subset of applications under the https://developers.goog [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: -NOTE: It is required that the account used to set up the service account *is an administrator account*. - -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 5424e4414840..a81b8873dda5 100644 --- a/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc @@ -30,11 +30,12 @@ It is compatible with a subset of applications under the https://developers.goog [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: -NOTE: It is required that the account used to set up the service account *is an administrator account*. - -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*: From 0a58acc632178d5ba4adf595f66222c05c2e0066 Mon Sep 17 00:00:00 2001 From: Marc Guasch Date: Tue, 1 Sep 2020 15:08:36 +0200 Subject: [PATCH 3/3] Uppercase filebeat --- filebeat/docs/modules/gsuite.asciidoc | 2 +- x-pack/filebeat/module/gsuite/_meta/docs.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/filebeat/docs/modules/gsuite.asciidoc b/filebeat/docs/modules/gsuite.asciidoc index 33bb78ba8b70..2b2684253553 100644 --- a/filebeat/docs/modules/gsuite.asciidoc +++ b/filebeat/docs/modules/gsuite.asciidoc @@ -35,7 +35,7 @@ It is compatible with a subset of applications under the https://developers.goog [float] === Configure the module -In order for filebeat to ingest data from the Google Reports API you must: +In order for Filebeat to ingest data from the Google Reports API you must: - Have an *administrator account*. - https://support.google.com/gsuitemigrate/answer/9222993?hl=en[Set up a ServiceAccount] using the administrator account. diff --git a/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc b/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc index a81b8873dda5..37f11e4a9458 100644 --- a/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/gsuite/_meta/docs.asciidoc @@ -30,7 +30,7 @@ It is compatible with a subset of applications under the https://developers.goog [float] === Configure the module -In order for filebeat to ingest data from the Google Reports API you must: +In order for Filebeat to ingest data from the Google Reports API you must: - Have an *administrator account*. - https://support.google.com/gsuitemigrate/answer/9222993?hl=en[Set up a ServiceAccount] using the administrator account.