Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/tables/googleworkspace_calendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The `googleworkspace_calendar` table provides insights into calendars within Goo

**Important Notes**
- You must specify the `id` in the `where` or join clause (`where id=`, `join googleworkspace_calendar c on c.id=`) to query this table.
- **Required OAuth Scope**: `https://www.googleapis.com/auth/calendar.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/calendar/api/v3/reference/calendars/get#auth)

## Examples

Expand All @@ -39,4 +40,4 @@ from
googleworkspace_calendar
where
id = '[email protected]';
```
```
3 changes: 2 additions & 1 deletion docs/tables/googleworkspace_calendar_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The `googleworkspace_calendar_event` table provides insights into Calendar Event

**Important Notes**
- You must specify the `calendar_id` in the `where` or join clause (`where calendar_id=`, `join googleworkspace_calendar_event e on e.calendar_id=`) to query this table.
- **Required OAuth Scope**: `https://www.googleapis.com/auth/calendar.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/calendar/api/v3/reference/events/list#auth)

## Examples

Expand Down Expand Up @@ -208,4 +209,4 @@ where
and start_time >= date('now')
and start_time < date('now', '+30 days')
order by start_time;
```
```
5 changes: 4 additions & 1 deletion docs/tables/googleworkspace_calendar_my_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Google Workspace Calendar is a core service within Google Workspace that allows

The `googleworkspace_calendar_my_event` table provides insights into Google Workspace Calendar Events. As an administrator or a user, explore event-specific details through this table, including event start and end times, attendees, and event status. Utilize it to uncover information about your events, such as those with conflicting schedules, attendees' responses to event invitations, and details about recurring events.

**Important Notes**
- **Required OAuth Scope**: `https://www.googleapis.com/auth/calendar.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/calendar/api/v3/reference/events/list#auth)

## Examples

### Basic info
Expand Down Expand Up @@ -197,4 +200,4 @@ where
and date(start_time) >= date('now')
order by start_time
limit 10;
```
```
3 changes: 2 additions & 1 deletion docs/tables/googleworkspace_drive.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The `googleworkspace_drive` table provides insights into Drives within Google Wo

**Important Notes**
- To filter the resource using `name`, or `created_time` you must set `use_domain_admin_access` setting as true** in the where clause, and for that you must have admin access in the domain. See [Shared drive-specific query terms](https://developers.google.com/drive/api/v3/ref-search-terms#drive_properties) for information on `use_domain_admin_access` setting.
- **Required OAuth Scope**: `https://www.googleapis.com/auth/drive.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/drive/api/reference/rest/v3/drives/list#authorization-scopes)

## Examples

Expand Down Expand Up @@ -149,4 +150,4 @@ from
where
query = 'createdTime > ''2021-08-01T07:00:00'' and name contains ''steampipe'''
and use_domain_admin_access;
```
```
5 changes: 4 additions & 1 deletion docs/tables/googleworkspace_drive_my_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Google Workspace Drive is a cloud storage service within Google Workspace that a

The `googleworkspace_drive_my_file` table provides insights into files within Google Workspace Drive. As a Google Workspace administrator, explore file-specific details through this table, including ownership, sharing settings, and associated metadata. Utilize it to uncover information about files, such as those shared externally, the permissions associated with each file, and the verification of sharing policies.

**Important Notes**
- **Required OAuth Scope**: `https://www.googleapis.com/auth/drive.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/drive/api/reference/rest/v3/files/list#authorization-scopes)

## Examples

### Basic info
Expand Down Expand Up @@ -127,4 +130,4 @@ from
googleworkspace_drive_my_file
where
query = 'name contains "steampipe"';
```
```
3 changes: 2 additions & 1 deletion docs/tables/googleworkspace_gmail_draft.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The `googleworkspace_gmail_draft` table provides insights into draft emails with

**Important Notes**
- You must specify the `user_id` in the `where` or join clause (`where user_id=`, `join googleworkspace_gmail_draft g on g.user_id=`) to query this table.
- **Required OAuth Scope**: `https://www.googleapis.com/auth/gmail.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/gmail/api/auth/scopes)

## Examples

Expand Down Expand Up @@ -144,4 +145,4 @@ from
where
user_id = '[email protected]'
and message_snippet is null;
```
```
3 changes: 2 additions & 1 deletion docs/tables/googleworkspace_gmail_message.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The `googleworkspace_gmail_message` table provides insights into Gmail Messages

**Important Notes**
- You must specify the `user_id` in the `where` or join clause (`where user_id=`, `join googleworkspace_gmail_my_message g on g.user_id=`) to query this table.
- **Required OAuth Scope**: `https://www.googleapis.com/auth/gmail.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/gmail/api/auth/scopes)

## Examples

Expand Down Expand Up @@ -179,4 +180,4 @@ where
user_id = '[email protected]'
and query = 'in:chats'
order by internal_date;
```
```
5 changes: 4 additions & 1 deletion docs/tables/googleworkspace_gmail_my_draft.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Gmail Drafts in Google Workspace is a feature that allows users to save and mana

The `googleworkspace_gmail_my_draft` table provides insights into draft messages within Google Workspace's Gmail. As an IT administrator, explore draft-specific details through this table, including content, status, and associated metadata. Utilize it to uncover information about drafts, such as those that have been left unsent or abandoned, and the details of these drafts, to better manage email communications within your organization.

**Important Notes**
- **Required OAuth Scope**: `https://www.googleapis.com/auth/gmail.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/gmail/api/auth/scopes)

## Examples

### Basic info
Expand Down Expand Up @@ -131,4 +134,4 @@ from
googleworkspace_gmail_my_draft
where
message_snippet is null;
```
```
5 changes: 4 additions & 1 deletion docs/tables/googleworkspace_gmail_my_message.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Gmail is a service within Google Workspace that provides a robust and secure pla

The `googleworkspace_gmail_my_message` table provides insights into Gmail Messages within Google Workspace. As a system administrator, explore message-specific details through this table, including the sender, recipient, subject, and timestamp. Utilize it to uncover information about messages, such as those marked as spam, the communication patterns, and the verification of message headers.

**Important Notes**
- **Required OAuth Scope**: `https://www.googleapis.com/auth/gmail.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/gmail/api/auth/scopes)

## Examples

### Basic info
Expand Down Expand Up @@ -164,4 +167,4 @@ from
where
query = 'in:chats'
order by internal_date;
```
```
3 changes: 2 additions & 1 deletion docs/tables/googleworkspace_gmail_my_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The `googleworkspace_gmail_my_settings` table provides insights into the Gmail S

**Important Notes**
- To list delegated accounts, you must authenticate using a service account client that has been delegated domain-wide authority.
- **Required OAuth Scope**: `https://www.googleapis.com/auth/gmail.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/gmail/api/auth/scopes)

## Examples

Expand Down Expand Up @@ -135,4 +136,4 @@ from
googleworkspace_gmail_my_settings
where
json_extract(auto_forwarding, '$.enabled');
```
```
3 changes: 2 additions & 1 deletion docs/tables/googleworkspace_gmail_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The `googleworkspace_gmail_settings` table provides insights into individual use
**Important Notes**
- You must specify the `user_email` in the `where` or join clause (`where user_email=`, `join googleworkspace_gmail_settings g on g.user_email=`) to query this table.
- To list delegated accounts, you must authenticate using a service account client that has been delegated domain-wide authority.
- **Required OAuth Scope**: `https://www.googleapis.com/auth/gmail.readonly`, for more details see required [Authorization scope](https://developers.google.com/workspace/gmail/api/auth/scopes)

## Examples

Expand Down Expand Up @@ -148,4 +149,4 @@ from
where
user_email = '[email protected]'
and json_extract(auto_forwarding, '$.enabled');
```
```
5 changes: 4 additions & 1 deletion docs/tables/googleworkspace_people_contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Google Workspace Contacts is a resource within Google Workspace that allows user

The `googleworkspace_people_contact` table provides insights into contact details within Google Workspace. As a system administrator, explore contact-specific details through this table, including names, email addresses, phone numbers, and associated metadata. Utilize it to uncover information about contacts, such as their professional affiliations, communication details, and the verification of associated metadata.

**Important Notes**
- **Required OAuth Scope**: `https://www.googleapis.com/auth/contacts.readonly`, for more details see required [Authorization scope](https://developers.google.com/people/api/rest/v1/people.connections/list#authorization-scopes)

## Examples

### Basic info
Expand Down Expand Up @@ -88,4 +91,4 @@ from
where
json_extract(org.value, '$.metadata.primary') = 'true'
and json_extract(org.value, '$.name') = 'Turbot';
```
```
5 changes: 4 additions & 1 deletion docs/tables/googleworkspace_people_contact_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Google Workspace People Contact Groups is a feature within Google Workspace that

The `googleworkspace_people_contact_group` table provides insights into People Contact Groups within Google Workspace. As an IT administrator or a Google Workspace user, you can explore group-specific details through this table, including group metadata, member count, and member resource names. Use it to manage and organize your Google Workspace contacts more efficiently, such as identifying large groups, finding groups without members, and understanding the structure of your contact groups.

**Important Notes**
- **Required OAuth Scope**: `https://www.googleapis.com/auth/contacts.readonly`, for more details see required [Authorization scope](https://developers.google.com/people/api/rest/v1/contactGroups/list#authorization-scopes)

## Examples

### Basic info
Expand Down Expand Up @@ -113,4 +116,4 @@ select
member_count
from
googleworkspace_people_contact_group;
```
```
5 changes: 4 additions & 1 deletion docs/tables/googleworkspace_people_directory_people.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Google Workspace Directory People is a resource within Google Workspace that all

The `googleworkspace_people_directory_people` table provides insights into user profiles within Google Workspace Directory People. As an IT administrator, explore user-specific details through this table, including email addresses, phone numbers, and other profile details. Utilize it to uncover information about users, such as their roles, the groups they belong to, and their profile's metadata.

**Important Notes**
- **Required OAuth Scope**: `https://www.googleapis.com/auth/directory.readonly`, for more details see required [Authorization scope](https://developers.google.com/people/api/rest/v1/people/listDirectoryPeople#authorization-scopes)

## Examples

### Basic info
Expand Down Expand Up @@ -46,4 +49,4 @@ from
googleworkspace_people_directory_people,
json_each(organizations) as org,
json_each(phone_numbers) as ph;
```
```
Loading
Loading