Adding a OneDrive application
Learn how to add a OneDrive application to IBM RPA.
Before you begin
The following list shows the prerequisites to create a OneDrive application:
- IBM RPA on premises only.
- User with permission to manage applications. See the Checking user permissions topic to learn how to check your user permissions.
- Microsoft Azure🡥 account.
Procedure
Follow the steps to create a OneDrive™ application:
- Create your OneDrive application
- Add API permissions to the app
- Get the Client ID and Client secret
- Add the application
Create your OneDrive application
-
Navigate to the Azure Portal🡥 website.
-
Log in with your account.
-
Under Azure services, click More services.
-
Search for Microsoft Entra ID and select it.
-
On the left side menu, click App registrations.
-
Click the New registration button.
-
Name your app, such as
IBM RPA Storage
. -
In Supported account types, select the option Accounts in this organizational directory only (Single tenant).
-
In Redirect URI, select Web and enter the URL to your IBM RPA's API, such as
https://192.51.100.38:7790/integration/oauth2
, where192.51.100.38
is the server IP 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://192.51.100.38:7790/integration/oauth2
https://api.example.com/integration/oauth2
🛈 Remember: Replace the URL with the appropriate server API URL.
-
Click Register to create the credentials.
Add API permissions to the app
After you register the app, you must add the API permissions required to create the connection:
- From the app overview page, go to the app's API permissions page.
- Click Add a permission, and select
Microsoft Graph
in the flyout. - Select Delegated permissions, and use the search box to find and select the following permissions:
openid
email
offline_access
files.readwrite
Get the Client ID and Client secret
- On the Overview page, click Add a certificate or secret.
- Click the New client secret button.
- Enter a Description for your credential, and set the expiration date for the credential.
- Click Add.
- The Client secret is listed on the table under the Secret ID column.
- Go to the Overview page on the left side menu.
- The Client ID is next to the Application (client) ID field.
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 credentials page, such as
https://192.51.100.38:7790/integration/oauth2
. -
In the Authorization URL field, enter
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
. -
In the Authorization Template Parameter field, enter the following code snippet:
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 Token URL field, enter
https://login.microsoftonline.com/common/oauth2/v2.0/token
. -
In API URL field, enter
https://graph.microsoft.com/v1.0/
. -
In Scopes field, enter:
openid email offline_access files.readwrite
-
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.