- Release Notes
- Overview
- Getting Started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams Scope
- Create Team
- Create Team From Group
- Get Team
- Get Teams
- Channels
- Create Channel
- Delete Channel
- Get Channel
- Get Channels
- Update Channel
- Chats
- Get Chat
- Get Chats
- Get Chat Members
- Messages
- Get Message
- Get Messages
- Get Message Replies
- Reply To Message
- Send Message
- Events
- Create Event
- Delete Event
- Get Event
- Get Events
- Users
- Get User Presence
- How It Works
- Technical References
- Get Started
- About
- Setup
- Technical References
- Azure Form Recognizer Scope
- Activities
- Analyze Form
- Analyze Form Async
- Get Analyze Form Result
- Analyze Receipt
- Analyze Receipt Async
- Get Analyze Receipt Result
- Analyze Layout
- Analyze Layout Async
- Get Analyze Layout Result
- Train Model
- Get Models
- Get Model Keys
- Get Model Info
- Delete Model
- Connectors
- How to Create Activities
- Build Your Integration
Microsoft Teams Scope
The Microsoft Teams activities use the Microsoft identity platform to establish an authenticated connection between UiPath and your Microsoft Teams application via the Microsoft Scope activity. This connection enables a Robot to call the Microsoft Graph API to read and write resources on your behalf.
To establish your authenticated connection, you first register your Microsoft Teams application in your Azure Active Directory (using your personal, work, and/or school Microsoft Office 365 account). When registering your application, you assign the Microsoft Graph API permissions that specify the resources a Robot can access on your behalf.
After registering your Microsoft Teams application, Azure Active Directory assigns a unique application (client) ID that you enter in the Microsoft Teams Scope activity. The ApplicationID is used to collect the necessary information about your registered app to initiate authentication.
The following steps and message sequence diagram is an example how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Teams Scope activity to your project.
-
Enter values for the Authentication, Input, and Unattended (if applicable) properties.
The Microsoft Teams Scope activity has three different authentication flows (AuthenticationTypes) that you can choose from when adding the activity to your project. Your selection is dependent on the type of automation mode you plan to run (unattended or attended) and your application authentication requirements (consult with your administrator if you're unsure which authentication requirements apply to your application).
|
AuthenticationType |
Attended |
Unattended |
|---|---|---|
|
InteractiveToken |
X | |
|
IntegratedWindowsAuthentication |
X |
X |
|
UsernameAndPassword |
X |
X |
Interactive Token
The InteractiveToken authentication type can be used for attended automation and when multi-factor authentication (MFA) is required. This is the default option and what we use in our examples. If you're interested in "playing around" with the activity package, this option is easy to configure and works well for personal accounts (using the default redirect URI noted in step 7 of the Register your application section of the Setup guide).
When the Microsoft Teams Scope activity is run for the first time using this authentication type, you are prompted to authorize access to the resources (you granted permissions to when registering your app) via a consent dialogue box.
If you select this option, the Username,Password, and Tenant properties should be left empty.
This authentication type follows the OAuth 2.0 authorization code flow.
Integrated Windows Authentication
The IntegratedWindowsAuthentication authentication type can be used for both attended and unattended automation. This option can apply to Windows hosted applications running on computers joined to a Windows domain or Azure Active Directory.
You should only select this option if your registered application is configured to support Integrated Windows Authentication (additional information can be found on GitHub ).
If you select this option, the Username,Password, and Tenant properties should be left empty.
Username and Password
The UsernameAndPassword authentication type can be used for both attended (when mutli-factor authentication is not required) and unattended automation.
Though it's not recommended by Microsoft, you can use this authentication type in public client applications. Using this authentication type imposes constraints on your application. For instance, apps using this flow won't be able to sign in a user who needs to perform multi-factor authentication (conditional access). It won't enable your application to benefit from single sign-on either. Authentication with username/password goes against the principles of modern authentication and is only provided for legacy reasons (additional information can be found on GitHub ).
If you select this option, the Username and Password properties are required and the Tenant property is optional for single-tenant applications (required for multi-tenant applications).
The values for the following properties are specified when adding this activity to your project in UiPath Studio.
DisplayName
The display name of the activity.
|
Attributes |
Details |
|---|---|
|
Type |
|
|
Required |
Yes |
|
Default value |
Microsoft Teams Scope |
|
Allowed values |
Enter a
String or
String variable.
|
|
Notes |
N/A |
ApplicationID
The unique application (client) ID assigned by the Azure Active Directory when you registered your app during Setup.
|
Attributes |
Details |
|---|---|
|
Type |
|
|
Required |
Yes |
|
Default value |
Empty |
|
Allowed values |
Enter a
String or
String variable.
|
|
Notes |
|
AuthenticationType
The type of authentication required for your registered application.
|
Attributes |
Details |
|---|---|
|
Type |
Drop-down selection |
|
Required |
Yes |
|
Default value |
InteractiveToken |
|
Allowed values |
Select one of the three options: InteractiveToken IntegratedWindowsAuthentication UsernameAndPassword |
|
Notes |
For more information about these options and which one to select, see the Unattended and Attended Automation section above. |
Tenant
The unique directory (tenant) ID assigned by the Azure Active Directory when you registered your app during .
|
Attributes |
Details |
|---|---|
|
Type |
|
|
Required |
No (required for multi-tenant applications) |
|
Default value |
Empty |
|
Allowed values |
Enter a
String or
String variable.
|
|
Notes |
The directory (tenant) ID can be found in the overview page of your registered application (under the application (client) ID). |
OAuthApplication
Indicates the application (client) to be used.
|
Attributes |
Details |
|---|---|
|
Type |
|
|
Required |
No |
|
Default value |
Custom |
|
Allowed values |
Custom, UiPath |
|
Notes |
If 'UiPath' is selected, ApplicationId and Tenant are ignored. |
These properties apply when you run unattended automation only. When specifying values for these properties, be sure the AuthenticationType property is set to UsernameAndPassword. For more information, see the Username and Password section above.
Password
The password of your Microsoft Office 365 account.
|
Attributes |
Details |
|---|---|
|
Type |
|
|
Required |
No (required if AuthenticationType is UsernameAndPassword) |
|
Default value |
Empty |
|
Allowed values |
Enter a
String or
String variable.
|
|
Notes |
N/A |
SecurePassword
The password of your Microsoft Office 365 account.
|
Attributes |
Details |
|---|---|
|
Type |
|
|
Required |
No (required if AuthenticationType is UsernameAndPassword) and Password is null. |
|
Default value |
Empty |
|
Allowed values |
Enter a
SecureString or
SecureString variable.
|
|
Notes |
N/A |
Username
The username of your Microsoft Office 365 account.
|
Attributes |
Details |
|---|---|
|
Type |
|
|
Required |
No (required if AuthenticationType is UsernameAndPassword) |
|
Default value |
Empty |
|
Allowed values |
Enter a
String or
String variable.
|
|
Notes |
N/A |
