page_type | description | products | languages | extensions | contentType | createdDate | ||||
---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample shows a feature where requester can request for any task approval from manager and manager can see the pending request by user on the click of activity feed notification and can approve or reject the request. |
|
|
samples |
26-11-2021 14:00:00 |
This sample shows a feature where:
- Requester : Can request for any task approval from manager by sending activity feed notification and can see his request status.
- Manager : Can see the pending approval request raised by user on the click of activity feed notification and can approve or reject the request.
User Persona:
Manager Persona:
-
Activity feed notification of approval request.
-
On click of notification a task module will open, redirecting the user to the request.
- Register a new application in the Azure Active Directory – App Registrations portal.
- Select New Registration and on the register an application page, set following values:
- Set name to your app name.
- Choose the supported account types (any account type will work)
- Leave Redirect URI empty.
- Choose Register.
- On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the appsettings.json.
- Under Manage, select Expose an API.
- Select the Set link to generate the Application ID URI in the form of
api://{AppID}
. Insert your fully qualified domain name (with a forward slash "/" appended to the end) between the double forward slashes and the GUID. The entire ID should have the form of:api://fully-qualified-domain-name/{AppID}
- ex:
api://%ngrokDomain%.ngrok.io/00000000-0000-0000-0000-000000000000
.
- ex:
- Select the Add a scope button. In the panel that opens, enter
access_as_user
as the Scope name. - Set Who can consent? to
Admins and users
- Fill in the fields for configuring the admin and user consent prompts with values that are appropriate for the
access_as_user
scope:- Admin consent title: Teams can access the user’s profile.
- Admin consent description: Allows Teams to call the app’s web APIs as the current user.
- User consent title: Teams can access the user profile and make requests on the user's behalf.
- User consent description: Enable Teams to call this app’s APIs with the same rights as the user.
- Ensure that State is set to Enabled
- Select Add scope
- The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with
/access_as_user
appended to the end:- `api://[ngrokDomain].ngrok.io/00000000-0000-0000-0000-000000000000/access_as_user.
- The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with
- In the Authorized client applications section, identify the applications that you want to authorize for your app’s web application. Each of the following IDs needs to be entered:
1fec8e78-bce4-4aaf-ab1b-5451cc387264
(Teams mobile/desktop application)5e3ce6c0-2b1f-4285-8d4b-75ee78787346
(Teams web application)
- Navigate to API Permissions, and make sure to add the follow permissions:
- Select Add a permission
- Select Microsoft Graph -> Delegated permissions.
User.Read
(enabled by default)Directory.Read.All
ChatMessage.Send
Chat.ReadWrite
TeamsActivity.Send
TeamsAppInstallation.ReadForUser.All
.
Note Your need to add TeamsActivity.Send
and Directory.Read.All
as Application level permissions too.
- Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
-
Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app. Set a redirect URI:
- Select Add a platform.
- Select web.
- Enter the redirect URI for the app in the following format:
https://{Base_Url}/Auth/end
,https://{Base_Url}/Auth/Start
. This will be the page where a successful implicit grant flow will redirect the user. Again - Select Single page application.
- Enter the redirect URI for the app in the following format:
https://{Base_Url}/tabAuth
Enable implicit grant by checking the following boxes:
✔ ID Token
✔ Access Token -
Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description(Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the appsettings.json.
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In the folder where repository is cloned navigate to
samples/tab-request-approval/nodejs
-
Install node modules
Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same in Visual studio code terminal by opening the project in Visual studio code
npm install
-
Run ngrok - point to port 3978
ngrok http -host-header=rewrite 3978
-
Open the
.env
configuration file in your project folder (or in Visual Studio Code) and update theClientId
andClientSecret
,TenantId
with your tenant id. For e.g., your ngrok url. (Note the ClientId is the AppId created in step 1 (Setup for Bot), the ClientSecret is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.) -
Run your app
npm start
-
Manually update the manifest.json
- Edit the
manifest.json
contained in theappPackage/
folder to replace with your MicrosoftAppId (that was created in step1.1 and is the same value of MicrosoftAppId in.env
file) everywhere you see the place holder string{MicrosoftAppId}
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Zip up the contents of the
appPackage/
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the left-bottom Apps view, click "Upload a custom app")
- Edit the
Note: App should be installed for user's manager also to get task approval notification.