Connect action in Gmail package

Use the Connect action to authenticate with Gmail and create a reusable Gmail session. This session is required to perform subsequent Gmail operations such as reading, sending, or managing emails.

The Connect action supports OAuth 2.0–based authentication managed through Control Room and validates credentials, permissions, and session settings before establishing a connection.

Considerations

An error is displayed if any of the following conditions are encountered when you deploy your automation to manage Gmail operations:
  • Any of the input parameters that you have provided is invalid.
  • The session name that you have provided already exists.
  • An OAuth connection is not available in the Control Room.
  • The token that you have provided has expired.
  • You do not have the necessary permission.

Settings

  • In the OAuth2 Authentication field, click Pick to choose from available Control Room-managed OAuth2 credentials.
    Note: Ensure that the OAuth2 connection is valid and active in the Control Room.​
    • Click the Provider type drop-down menu to select an available or custom provider.

      For information on creating a custom provider, see Configure OAuth 2.0 connection in Control Room.

    • Click the Connection name drop-down menu and select the specific OAuth connection object.

      This field is disabled until a Provider type is selected.

    • Use the Token type field to select one of the following options depending on the token that will be used at run time:
      • Shared: For a global token.

        An access token of shared type is created when a connection is established to the Control Room. This access token is stored as a credential. When you run your automation, the access token is referenced in the automation using the enterprise application provider type set up in the Control Room.

      • User-specific: For a token that is specific to a user.
  • Use the Username field to select one of the following options to specify the username:
    • Credential: To use a value available in the Credential Vault.

      Click the Choose button to select a credential.

    • Variable: To use a value that is stored as a credential variable.
    • Insecure string: To manually specify the values.

      Optional) Click the Insert a value icon to insert an existing variable

  • Use the Create Gmail session to select one of the following options to store the session:
    • Local session: Select to create a session name that can only be used in the current automation.
    • Global session: Select this option to define a global session name that enables you to share the session across multiple automations.
    • Variable: Select or create a session variable to define the session name