Microsoft 365 Scope

UiPath.MicrosoftOffice365.Activities.Office365ApplicationScope

Description

Uses the Microsoft identity platform to establish an authenticated connection between UiPath and your Microsoft 365 application. This authenticated connection enables a Robot to call the Microsoft Graph API to read and write resources on your behalf.

Important: Starting with version 2.5.5, you can use the newer Microsoft 365 activities inside the Scope activity. To learn how to use the Integration Service activities with Microsoft 365 Scope, see How to use Microsoft 365 activities without Integration Service connections.

Project compatibility

Windows - Legacy | Windows

Configuration

Tip: This page explains the authentication parameters available in the Microsoft 365 Scope activity. For more details regarding each authentication option, see the How to connect to Microsoft 365 activities guide.

To start configuring this activity, you must first select a connection method. Depending on the selected method, different fields are then displayed in the Properties panel.

• Connection method - Select the connection method you want to use. Options available in the dropdown menu are:
  • Properties Panel - Configure the connection details in the Properties panel.
  • Asset - Use Orchestrator credential assets. We recommend you use this option.

Asset connection method

Note: When you select this option, most of the authentication fields usually displayed in the Properties panel are hidden, because the authentication information is stored inside the asset.

• Connection assets - Browse Orchestrator folders to select an asset. This field supports IResource variables. Select the Manage Assets button to open Orchestrator. The list of available assets depends on the Orchestrator your Studio and Robot are connected to.
  • Use the Plus button menu to select Reload Assets if you've updated your assets in Orchestrator. Note that if you add a new asset in Orchestrator while using Studio Desktop, it will not be available straightaway in the Scope activity.

• See the asset format in How to use Microsoft 365 activities without Integration Service connections.

Depending on the authentication type configured in the asset, you must also configure the following fields available in the Properties panel:

Authentication

• Impersonated User Email Address - The email address of the impersonated user. Used for Application ID and Secret and Application ID and Certificate authentication methods.

Username and Password (Unattended)

• Username - The username of your Microsoft 365 account. Used for Username and Password authentication method.
• Password - The password of your Microsoft 365 account.

Common

• TimeoutMS - Specifies the amount of time to wait (in milliseconds) for the interactive authentication (consent dialogue box) to complete before an error is thrown. This field supports only integer and Int32 variables. The default value is 30000ms (30 seconds).

Runtime

• Runtime connection assets - Browse to select an asset. This field allows you to select a different asset for runtime. Use the Plus button menu to select Relative path and enter the full path of the Orchestrator asset containing connection details.

Properties Panel connection method

Note: When you select this option, you must configure the authentication fields available in the Properties panel.

First, configure the following fields:

• Connections - Select an account from the list. You can add, delete, and choose what connections to use.
• Authentication Scopes - See the Using the Authentication Scopes wizard section below.

Using the Authentication Scopes wizard

Note: This wizard replaces the Services parameter available in previous versions of this package. The Authentication Scopes wizard is available when you use Interactive token authentication.

The Scope activity incorporates a universal permissions selector, offering a clear picture of all the used authentication scopes, which the activities need in order to work correctly.

All children activities included in the Microsoft 365 Scope activity are automatically detected as required scopes.

If no scopes are manually selected from the Scopes wizard, the Auto-detect function is applied by default at runtime, and the need for configuring the wizard is eliminated. All the minimum required scopes are selected at runtime.

You can also add a scope manually after adding a child activity to Microsoft 365 Scope.

Next, you must select the Authentication Type from the Properties panel and configure the fields required for your preferred authentication method. The sections below list the fields available under each menu.

Authentication

• Authentication Type - The type of authentication required for your registered application. Select one of the five options: Interactive token, Integrated Windows Authentication (IWA), Username and Password, Application ID and Secret, or Application ID and Certificate. The default value is Interactive Token.
• Environment - The environment. Either Azure Global or national clouds that are unique and separate environments from Azure Global. Select one of the five options: Default, Global, China, Germany or USGovernment. The default value is Global.
• Application ID - The unique application (client) ID assigned by the Azure Active Directory when you registered your app during setup. The application (client) ID represents an instance of a Microsoft 365 application.
• Tenant - The unique directory (tenant) ID assigned by the Azure Active Directory when you registered your app during setup. Required for multi-tenant applications and Integrated Windows Authentication. The directory (tenant) ID can be found in the overview page of your registered application (under the application (client) ID).
• Impersonated User Email Address - The email address of the impersonated user. Used in unattended scenarios (for Application ID and Secret and Application ID and Certificate authentication methods).

Interactive token

Note: This is the same authentication method supported in Integration Service, either through the public UiPath App or a private custom application (Bring your own app method).

For details, see Interactive token.

• OAuth Application - Indicates the application (client) to be used. This field supports only OAuthApplication variables. Select one of the two options:
  • UiPath - Default. When you want to use the application created by UiPath (UiPath Public App registration). If selected, the ApplicationID and Tenant fields provided in the Authentication section are ignored.
  • Custom - When you want to create your own application with specific permissions. In this case, you must set a value for the Application ID field. See How to create an application for Microsoft 365 Scope connections.

Application ID and Certificate (Unattended)

For details, see Application ID and Certificate.

• Certificate As Base64 - The Base64 representation of the certificate.

• Certificate Password - An optional password that may be required to use the certificate, as a Secure String.

Application ID and Secret (Unattended)

For details, see Application ID and Secret.

• Application Secret - The secret string that the application uses to provide its identity.
• Secure Application Secret - The Application (client) secret, as a SecureString.

Username and Password (Unattended)

For details, see Username and Password.

Important: Microsoft has deprecated Basic Authentication for Exchange online. This impacts some of our activities, such as Microsoft Office365 Scope. We recommend using the OAuth protocol in the activities that support it.

• Password - The password of your Microsoft 365 account.
• Secure Password - The password of your Microsoft 365 account, as a SecureString.
• Username - The username of your Microsoft 365 account.

Common

• TimeoutMS - Specifies the amount of time to wait (in milliseconds) for the interactive authentication (consent dialogue box) to complete before an error is thrown. This field supports only integers and Int32 variables. The default value is 30000ms (30 seconds) (not shown).
• ContinueOnError - If set, continue executing the remaining activities even if the current activity has failed.

Troubleshooting

If you encounter any issues with authentication, see Troubleshooting - Authentication.