Adding a Gmail application
Learn how to add a Gmail application to IBM RPA.
Before you begin
- IBM RPA on premises environment.
- User with permission to manage applications.
See the Checking user permissions topic to learn how to check your user permissions. - Google 🡥 account.
- Your server must have a valid Fully Qualified Domain Name (FQDN). Google™ does not accept public IP addresses in their API services.
Procedure
Follow the steps to create a Google™ Gmail™ application:
Enable the Gmail API
- Navigate to the Google Cloud™🡥 website.
- Log in with your account.
- Create a new project or use an existing project. Refer to Creating and managing projects🡥 for more information.
- Click Enable APIs and services on the main dashboard screen.
- Click the Gmail API card.
- Click the Enable button.
Create OAuth consent screen
- On the left side menu in APIs & Services, go to OAuth consent screen.
- Select the External option, and click the Create button.
- Name your app, such as
Gmail connection
. - Select your email on the User support email combination box.
- Optional: Upload an image file to become your application's logo.
- Enter URLs of your application's home page, public privacy policy, and terms of service.
- Set authorized domains, if you are using a custom domain.
- Add your email address in Developer contact information and click Save and continue.
- On the Scopes tab, click Add or remove scopes.
- On Filter field, search
Gmail
. - Select all Gmail API checkbox.
- Click Update button.
- On Filter field, search
- Click Save and continue once you are done configuring the scopes.
- Optional: On the Test users tab, you can add users to your testing app.
- Click Save and continue.
Create credentials
-
Click Back to dashboard.
-
On the left side menu in APIs & Services, go to Credentials.
-
Click Create credentials > OAuth client ID.
-
Select the Web application option in the Application type combination box.
-
Name your application, such as
Gmail provider
. -
In Authorized JavaScript origins, click Add URI. This address is the Fully Qualified Domain Name (FQDN) to your IBM RPA's API, such as
https://example.com:7790
, where7790
is the port that is used by the IBM RPA's API. -
In Authorized redirect URIs, click Add URI. This address is the Fully Qualified Domain Name (FQDN) to your IBM RPA's API, such as
https://example.com:7790
, whereexample.com
is the FQDN and7790
is the port used by the IBM RPA's API, with the OAuth2 specifications/integration/oauth2
. Following are examples of valid URLs with the OAuth2 specifications:https://example.com:7790/integration/oauth2
https://api.example.com/integration/oauth2
if you have configured theapi
subdomain as your API domain forwarding to the appropriate API port.
🛈 Remember: Replace the URL with the appropriate server API URL.
-
Click Create to create the credentials.
After you create the credentials, you should be prompted with the Client ID and Client secret.
If you were unable to see it, follow these steps:
- Navigate to Google Cloud Developers 🡥.
- In the left side menu, go to Credentials.
- Under OAuth 2.0 Client IDs, look for your newly created credentials and click it.
- The Client ID and Client secret are listed on the right.
Add the application
-
Log in to IBM RPA Control Center.
-
Click Applications on the main menu.
-
Click Add application.
-
In the Name field, enter the application name.
-
In the Description field, enter the application description.
-
In the Application tags field, select a tag to identify the application. The tag is used to filter applications.
-
Click Next.
-
In the Client ID field, enter your Client ID.
-
In the Client Secret field, enter your Client secret.
-
In the Redirect URL field, enter the Redirect URL you have previously configured in the Gmail app, such as
https://api.example.com/integration/oauth2
. -
In the Authorization URL field, enter
https://accounts.google.com/o/oauth2/v2/auth
. -
In the Authorization Template Parameter field, enter the following code snippet:
prompt=consent&access_type=offline&client_id={clientId}&response_type=code&redirect_uri={redirectUri}
🛈 Remember: IBM RPA automatically replaces the values of
{clientId}
and{redirectUri}
with the values defined in Client ID and Redirect URL, respectively. -
In the Token URL field, enter
https://www.googleapis.com/oauth2/v4/token
. -
In the API URL field, enter
https://gmail.googleapis.com/
. -
In the Scopes field, enter:
https://www.googleapis.com/auth/userinfo.email https://mail.google.com/
-
Click Next.
-
Review the summary of the data that you entered, and click Add.
Result
As result, you can view a notification that states that the application was added successfully. You can also see the application in the list of applications.
If it fails, you can also view a notification. In this case, review the data that you entered and retry to create the application.
What to do next
-
Create connections
Create connections to authorize an application. For more information, see Connections. -
Edit an application
To edit an application click Applications in the main menu, then click the vertical ellipsis button ⋮ > Edit.⚠ Attention: If you change the application data, you must reauthorize the connection that is bound to it.
- On IBM RPA Control Center, click the Connections menu.
- On the connection, click the vertical ellipsis button ⋮ > Re-authorize.
-
Make application obsolete
To make an application obsolete, click Applications in the main menu, then click the vertical ellipsis button ⋮ > Make obsolete.⚠ Attention: Marking an application as obsolete does not permanently remove it. All existing connections that use that application remain active, although you cannot create new connections to it.
-
Reactivate obsolete applications
To reactivate an obsolete application, in the Applications menu, click the vertical ellipsis button ⋮ > Reactivate. -
Delete applications
To delete applications that do not have connections attached to it or applications that are obsolete, in the Applications menu, click the vertical ellipsis button ⋮ > Delete.⚠ Attention: This permanently removes the application from the system.