Skip to content

Latest commit

 

History

History
156 lines (125 loc) · 8.17 KB

README.md

File metadata and controls

156 lines (125 loc) · 8.17 KB
Raw
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.
office-teams
office
office-365
csharp
samples
29-11-2021 17:00:25

Send task approvals using activity feed notification (Graph APIs)

This sample shows a feature where:

  1. Requester : Can request for any task approval from manager by sending activity feed notification and can see his request status.
  2. 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:

  • Send request to the manger for task approval.

    Request from user

  • Request status

    Request status

Manager Persona:

  • Activity feed notification of approval request.

    Notification

  • Pending task approval request.

    Pending request list

Prerequisites

  • .NET Core SDK version 3.1

    determine dotnet version

    dotnet --version

  • Ngrok (For local environment testing) Latest (any other tunneling software can also be used)

    run ngrok locally

    ngrok http -host-header=localhost 3978

  • Teams Microsoft Teams is installed and you have an account

To try this sample

Register your Teams Auth SSO with Azure AD

  1. Register a new application in the Azure Active Directory – App Registrations portal.
  2. 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.
  3. 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.
  4. Under Manage, select Expose an API.
  5. 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.
  6. Select the Add a scope button. In the panel that opens, enter access_as_user as the Scope name.
  7. Set Who can consent? to Admins and users
  8. 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.
  9. Ensure that State is set to Enabled
  10. 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.
  11. 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)
  12. 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
    • Directory.ReadWrite.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.

  1. 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

  2. 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.

  3. Clone the repository

git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  1. Open the code in Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to folder where repository is cloned then samples/tab-request-approval/csharp/TabRequestApproval.sln

  1. Run ngrok - point to port 3978

    # ngrok http -host-header=rewrite 3978

  2. Setup and run the bot from Visual Studio: Modify the appsettings.json and fill in the following details:

  • MicrosoftAppId - Generated from Step 3 (Application (client) ID)is the application app id
  • TenantId - Generated from Step 3(Directory (tenant) ID) is the tenant id
  • MicrosoftAppPassword - Generated from Step 14, also referred to as Client secret
  • {Base_URL} - Your application's base url. E.g. https://12345.ngrok.io if you are using ngrok.
  • Press F5 to run the project
  1. Modify the manifest.json in the /AppPackage folder and replace the following details:
  • {{Microsoft-App-Id}} with Application id generated from Step 3
  • {Base_URL} - Your application's base url. E.g. https://12345.ngrok.io if you are using ngrok.
  • {{domain-name}} with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok.io then your domain-name will be 1234.ngrok.io.

  1. Zip the contents of AppPackage folder into a manifest.zip, and use the manifest.zip to deploy in app store or add to Teams using step 19.

  2. Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

  • Go to Microsoft Teams and then go to side panel, select Apps
  • Choose Upload a custom App
  • Go to your project directory, the ./AppPackage folder, select the zip folder, and choose Open.
  • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

Note: App should be installed for user's manager also to get task approval notification.

Further reading