| ℹ️ Information |
|---|
| This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements. |
This HelloID Service Automation Delegated Form can manage the groupmemberships for Azure users. The following options are available:
- Search and select the target team
- Choose the users to add or remove
- After confirmation the memberhips of the selected team are updated
| Version | Description | Date |
|---|---|---|
| 1.0.0 | Initial release | 2022/06/22 |
- Description
- Versioning
- Table of Contents
- Introduction
- Requirements
- Getting the Teams graph API access
- All-in-one PowerShell setup script
- Post-setup configuration
- Manual resources
- Getting help
- HelloID Docs
The interface to communicate with Microsoft Teams is through the Microsoft Graph API.
This script uses the Microsoft Graph API and requires an App Registration with App permissions:
- Read and write all users' full profiles by using User.ReadWrite.All
- Read and write all groups by using Group.ReadWrite.All
- Add and remove members from all teams by using TeamMember.ReadWrite.All
By using this connector you will have the ability to manage the memberships of a Microsoft Team.
The first step to connect to Graph API and make requests, is to register a new Azure Active Directory Application. The application is used to connect to the API and to manage permissions.
- Navigate to App Registrations in Azure, and select “New Registration” (Azure Portal > Azure Active Directory > App Registration > New Application Registration).
- Next, give the application a name. In this example we are using “HelloID PowerShell” as application name.
- Specify who can use this application (Accounts in this organizational directory only).
- Specify the Redirect URI. You can enter any url as a redirect URI value. In this example we used http://localhost because it doesn't have to resolve.
- Click the “Register” button to finally create your new application.
Some key items regarding the application are the Application ID (which is the Client ID), the Directory ID (which is the Tenant ID) and Client Secret.
The Microsoft Graph documentation provides details on which permission are required for each permission type.
To assign your application the right permissions, navigate to Azure Portal > Azure Active Directory >App Registrations. Select the application we created before, and select “API Permissions” or “View API Permissions”. To assign a new permission to your application, click the “Add a permission” button. From the “Request API Permissions” screen click “Microsoft Graph”. For this connector the following permissions are used as Application permissions:
- Read and Write all user’s full profiles by using User.ReadWrite.All
- Read and Write all groups in an organization’s directory by using Group.ReadWrite.All
- Add and remove members from all teams by using TeamMember.ReadWrite.All
Some high-privilege permissions can be set to admin-restricted and require an administrators consent to be granted.
To grant admin consent to our application press the “Grant admin consent for TENANT” button.
There are multiple ways to authenticate to the Graph API with each has its own pros and cons, in this example we are using the Authorization Code grant type.
- First we need to get the Client ID, go to the Azure Portal > Azure Active Directory > App Registrations.
- Select your application and copy the Application (client) ID value.
- After we have the Client ID we also have to create a Client Secret.
- From the Azure Portal, go to Azure Active Directory > App Registrations.
- Select the application we have created before, and select "Certificates and Secrets".
- Under “Client Secrets” click on the “New Client Secret” button to create a new secret.
- Provide a logical name for your secret in the Description field, and select the expiration date for your secret.
- It's IMPORTANT to copy the newly generated client secret, because you cannot see the value anymore after you close the page.
- At least we need to get is the Tenant ID. This can be found in the Azure Portal by going to Azure Active Directory > Custom Domain Names, and then finding the .onmicrosoft.com domain.
The PowerShell script "createform.ps1" contains a complete PowerShell script using the HelloID API to create the complete Form including user defined variables, tasks and data sources.
Please note that this script asumes none of the required resources do exists within HelloID. The script does not contain versioning or source control
Please follow the documentation steps on HelloID Docs in order to setup and run the All-in one Powershell Script in your own environment.
After the all-in-one PowerShell script has run and created all the required resources. The following items need to be configured according to your own environment
- Update the following user defined variables
| Variable name | Description | Notes |
|---|---|---|
| AADtenantID | Id of the Azure tenant | Define as Global Varaible |
| AADAppId | Id of the Azure app | Define as Global Varaible |
| AADAppSecret | Secret of the Azure app | Define as Global Varaible |
This Delegated Form uses the following resources in order to run
If you need help, feel free to ask questions on our forum
The official HelloID documentation can be found at: https://docs.helloid.com/