[DO NOT CLOSE PR] Prepare demo project #255701
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| navigation_title: "Gmail" | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/kibana/current/gmail-action-type.html | ||
| applies_to: | ||
| stack: preview 9.4 | ||
| serverless: preview | ||
| --- | ||
|
|
||
| # Gmail connector [gmail-action-type] | ||
|
|
||
| The Gmail connector enables searching and reading emails from Gmail via the Gmail API. | ||
|
|
||
| ## Create connectors in {{kib}} [define-gmail-ui] | ||
|
|
||
| You can create connectors in **{{stack-manage-app}} > {{connectors-ui}}**. | ||
|
|
||
| ### Connector configuration [gmail-connector-configuration] | ||
|
|
||
| Gmail connectors use the following configuration: | ||
|
|
||
| Bearer Token | ||
| : A Google OAuth 2.0 access token with Gmail API scopes. See [Get API credentials](#gmail-api-credentials) for instructions. | ||
|
|
||
| ## Test connectors [gmail-action-configuration] | ||
|
|
||
| You can test connectors when creating or editing the connector in {{kib}}. The test verifies connectivity by fetching the authenticated user's profile from the Gmail API. | ||
|
|
||
| The Gmail connector has the following actions: | ||
|
|
||
| Search messages | ||
| : Search for messages using Gmail search syntax. | ||
| - **query** (optional): Gmail search query (e.g. `from:user@example.com`, `is:unread`, `subject:report`, `after:2024/01/01`, `has:attachment`). | ||
| - **maxResults** (optional): Maximum number of messages to return (1–100). Defaults to 50. | ||
| - **pageToken** (optional): Pagination token from a previous response. | ||
|
|
||
| Get message | ||
| : Retrieve a single message by ID with full headers and body. | ||
| - **messageId** (required): The ID of the message to retrieve. | ||
| - **format** (optional): `minimal` (headers only), `full` (default), or `raw` (RFC 2822). | ||
|
|
||
| List messages | ||
| : List messages, optionally filtered by label. | ||
| - **maxResults** (optional): Maximum number of messages to return (1–100). Defaults to 50. | ||
| - **pageToken** (optional): Pagination token from a previous response. | ||
| - **labelIds** (optional): Array of label IDs (e.g. INBOX, SENT). | ||
|
|
||
| ## Get API credentials [gmail-api-credentials] | ||
|
|
||
| To use the Gmail connector, you need a Google OAuth 2.0 access token with Gmail API scopes. You can obtain one using the [Google OAuth 2.0 Playground](https://developers.google.com/oauthplayground/): | ||
|
|
||
| 1. Open the OAuth 2.0 Playground and ensure **Use your own OAuth credentials** is checked if you have a project. | ||
| 2. In **Step 1 - Select & authorize APIs**, select the Gmail API v1 scope: `https://www.googleapis.com/auth/gmail.readonly` (or `https://www.googleapis.com/auth/gmail.metadata` for metadata only; use `https://mail.google.com/` for full access). | ||
| 3. Click **Authorize APIs** and sign in with your Google account. | ||
| 4. In **Step 2 - Exchange authorization code for tokens**, click **Exchange authorization code for tokens**. | ||
| 5. Copy the **Access token** and use it as the Bearer token when creating or activating the Gmail data source in Kibana. | ||
|
|
||
| The token expires after a short time (e.g. one hour). For long-lived access, use a refresh token flow or re-authorize as needed. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the "Elastic License | ||
| * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side | ||
| * Public License v 1"; you may not use this file except in compliance with, at | ||
| * your election, the "Elastic License 2.0", the "GNU Affero General Public | ||
| * License v3.0 only", or the "Server Side Public License, v 1". | ||
| */ | ||
|
|
||
| import { z } from '@kbn/zod/v4'; | ||
| import type { AxiosInstance } from 'axios'; | ||
| import type { AuthContext, AuthTypeSpec } from '../connector_spec'; | ||
| import * as i18n from './translations'; | ||
|
|
||
| export const EARS_PROVIDERS = ['google', 'microsoft', 'slack'] as const; | ||
|
|
||
| const authSchema = z | ||
| .object({ | ||
| provider: z.enum(EARS_PROVIDERS).meta({ hidden: true }), | ||
| scope: z.string().meta({ label: i18n.OAUTH_SCOPE_LABEL }).optional(), | ||
| }) | ||
| .meta({ label: i18n.EARS_LABEL }); | ||
|
|
||
| type AuthSchemaType = z.infer<typeof authSchema>; | ||
|
|
||
| /** | ||
| * EARS (Elastic Authentication Redirect Service) OAuth Flow | ||
| * | ||
| * EARS is an OAuth proxy that manages client credentials (clientId/clientSecret) | ||
| * on behalf of the user. Instead of users creating their own OAuth apps for each | ||
| * 3rd party, they can rely on the Elastic-owned apps for simplicity. | ||
| * Therefore, connectors using EARS don't require users to input any | ||
| * client credentials — EARS already knows them. | ||
| * | ||
| * EARS Redirect Flow: | ||
| * 1. On `/_start_oauth_flow`, Kibana builds EARS authorize URL with callback_uri, state, scope, pkce_challenge, pkce_method, and redirects to it | ||
| * 2. User visits EARS authorize URL → EARS redirects to OAuth provider and shows auth screen to user, in order for them to enter their credentials and authorize scopes | ||
| * 3. OAuth provider redirects back to EARS with authz code & state | ||
| * 4. EARS redirects to callback_uri (Kibana's `/_oauth_callback`) with authz code & state | ||
| * 5. Kibana then exchanges code via EARS token endpoint: POST {earsTokenUrl} with code & pkce_verifier in the JSON body | ||
| * 6. Tokens are auto-refreshed when expired during connector execution | ||
| */ | ||
| export const Ears: AuthTypeSpec<AuthSchemaType> = { | ||
| id: 'ears', | ||
| schema: authSchema, | ||
| authMode: 'per-user', | ||
| configure: async ( | ||
| ctx: AuthContext, | ||
| axiosInstance: AxiosInstance, | ||
| secret: AuthSchemaType | ||
| ): Promise<AxiosInstance> => { | ||
| let token; | ||
| try { | ||
| token = await ctx.getToken({ | ||
| authType: 'ears', | ||
| provider: secret.provider, | ||
| scope: secret.scope, | ||
| }); | ||
| } catch (error) { | ||
| throw new Error( | ||
| `Unable to retrieve/refresh the access token. User may need to re-authorize: ${error.message}` | ||
| ); | ||
| } | ||
|
|
||
| if (!token) { | ||
| throw new Error(`No access token available. User must complete OAuth authorization flow.`); | ||
| } | ||
|
|
||
| // set global defaults | ||
| axiosInstance.defaults.headers.common.Authorization = token; | ||
|
|
||
| return axiosInstance; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the "Elastic License | ||
| * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side | ||
| * Public License v 1"; you may not use this file except in compliance with, at | ||
| * your election, the "Elastic License 2.0", the "GNU Affero General Public | ||
| * License v3.0 only", or the "Server Side Public License, v 1". | ||
| */ | ||
|
|
||
| import { GmailConnector } from './gmail'; | ||
|
|
||
| describe('GmailConnector', () => { | ||
| it('has required metadata', () => { | ||
| expect(GmailConnector.metadata.id).toBe('.gmail'); | ||
| expect(GmailConnector.metadata.displayName).toBe('Gmail'); | ||
| expect(GmailConnector.metadata.supportedFeatureIds).toContain('workflows'); | ||
| }); | ||
|
|
||
| it('exposes searchMessages, getMessage, listMessages actions', () => { | ||
| expect(GmailConnector.actions.searchMessages).toBeDefined(); | ||
| expect(GmailConnector.actions.getMessage).toBeDefined(); | ||
| expect(GmailConnector.actions.listMessages).toBeDefined(); | ||
| }); | ||
|
|
||
| it('has a test handler', () => { | ||
| expect(GmailConnector.test?.handler).toBeDefined(); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.