138 lines
7.7 KiB
Markdown
138 lines
7.7 KiB
Markdown
---
|
|
page_type: sample
|
|
products:
|
|
- office-365
|
|
- office-sp
|
|
languages:
|
|
- javascript
|
|
- typescript
|
|
extensions:
|
|
contentType: samples
|
|
technologies:
|
|
- SharePoint Framework
|
|
- Azure AD
|
|
platforms:
|
|
- AngularJs
|
|
createdDate: 1/1/2016 12:00:00 AM
|
|
---
|
|
# Call custom Web API secured with AAD from SharePoint Framework client-side web part using Angular v1.x
|
|
|
|
## Summary
|
|
|
|
Sample SharePoint Framework client-side web part illustrating communication with a custom Web API secured with Azue Active Directory using Angular v1.x
|
|
|
|
|
|
|
|
|
|
## Compatibility
|
|
|
|
| :warning: Important |
|
|
|:---------------------------|
|
|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|
|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
|
|
|
|
|
|
|
|
|
|
|
|
-Compatible-green.svg)
|
|
|
|
|
|
|
|
|
|
|
|
## Applies to
|
|
|
|
* [SharePoint Framework Developer Preview](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
|
* [Office 365 developer tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
|
|
|
## Contributors
|
|
|
|
- [David Hartman](https://github.com/davidhartman)
|
|
|
|
## Version history
|
|
|
|
Version|Date|Comments
|
|
-------|----|--------
|
|
1.1|March 21, 2017|Updated to GA
|
|
1.0|December 21, 2016|Initial release
|
|
|
|
|
|
## Configuration Bliss
|
|
|
|
- clone this repo
|
|
|
|
### Create custom Web API site
|
|
|
|
- in the Azure Management Portal at https://portal.azure.com create a new API App
|
|
|
|
### Secure custom Web API with AAD
|
|
|
|
- in the Azure Management Portal at https://manage.windowsazure.com navigate to Azure Active Directory and register a new web application:
|
|
- as the name use anything you want
|
|
- as the sign-in URL use the URL of the previously created API App
|
|
- from the **api** folder, in Visual Studio open the **api.securecall.sln** file
|
|
- update the web.config file with your tenant name i.e. **contoso.onmicrosoft.com** and the audience with the application uri i.e. **https://contoso.onmicrosoft.com/WebPAPI**
|
|
- build the solution
|
|
- deploy the **api.securecall.sln** project to the newly created API App
|
|
- confirm that the API is secured with AAD by in your web browser navigating to **https://your-api-app.azurewebsites.net/api/item**. You should be not be allowed access to the endpoint
|
|
- in the Azure Management Portal at https://manage.windowsazure.com navigate to Azure Active Directory and register a new web application
|
|
- as the name use anything you want
|
|
- as the sign-in URL use **https://your-sharepoint-tenant/sites/my-team-site/documents/workbench.aspx**
|
|
- add permissions to other applications
|
|
- add Graph API
|
|
- in the list of **Delegated Permissions** add **Read users full-profile**
|
|
- change the filter to show all applications
|
|
- from the list of applications select **Your Custom Web API**
|
|
- in the list of **Delegated Permissions** select **Access You Custom Web API**
|
|
- copy the application ID
|
|
|
|
### Configure the web part
|
|
|
|
- in the command line change the working directory to the **webpart** folder
|
|
- in the command line run `npm i`
|
|
- in your code editor open the **webpart** folder
|
|
- in the **./src/webparts/angularSecureCall/app.module.ts** file
|
|
- replace the tenant with your tenant name
|
|
- replace the GUID in the **clientId** property with the application ID of the Client Application you registered with AAD
|
|
- in the **endpoints** property, replace the URL of the API with the URL of your API App
|
|
- in the **./src/webparts/angularSecureCall/app/webAPIService.ts** file
|
|
- in line 13 replace the url with url endpoint of you Web API Application **https://your-api-app.azurewesites.net/api/item**
|
|
- in the **./src/weparts/angularSecureCall/app/elevatedprivileges/elevatedprivilegesController.ts** file
|
|
- in lines 41 and 50 replace the application url with the application url of your Web API Application
|
|
- in the command line execute `gulp serve`
|
|
- add the web part to SharePoint workbench
|
|
- in the web part sign in with your organizational account
|
|
- you will need to click the acquire token buttons before you can make the calls to the Graph API and You Custom API
|
|
|
|
> Note: When you first login, the screen will refresh several times. I tried using the popUp feature with adal,
|
|
> however, this caused a infinite digest loop. Also ideally you should be able to make the calls to both the Graph
|
|
> API and your custom Web API without having to acquire the bearer tokens first, however, what happens is the app
|
|
> acquires the bearer token and then never finishes the call, I believe that is because the app is reloading, not quite
|
|
> sure how to fix that yet. There is definitely room to improved the user experience but the main logic and functionality
|
|
> is here. Thanks!
|
|
|
|
## Help
|
|
|
|
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
|
|
|
|
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
|
|
|
|
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A"sample%3A%20angular-aad-webapi" ) to see if anybody else is having the same issues.
|
|
|
|
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=angular-aad-webapi) and see what the community is saying.
|
|
|
|
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20angular-aad-webapi&template=bug-report.yml&sample=angular-aad-webapi&authors=@davidhartman&title=angular-aad-webapi%20-%20).
|
|
|
|
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20angular-aad-webapi&template=question.yml&sample=angular-aad-webapi&authors=@davidhartman&title=angular-aad-webapi%20-%20).
|
|
|
|
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20angular-aad-webapi&template=question.yml&sample=angular-aad-webapi&authors=@davidhartman&title=angular-aad-webapi%20-%20).
|
|
|
|
|
|
## Disclaimer
|
|
|
|
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
|
|
|
|
|
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/angular-aad-webapi" />
|