-->
In this sample, we show you how to integrate with school roles/roster data as well as O365 services available via the Graph API.
Step #4 - Set the Application Key. The Application Key, or APPKEY in your.env file, is used by Laravel for security. Most notable is its usage in the Cross-Site Request Forgery (CSRF) protection, so it's a good idea for us to set this application key once we have our project installed. To do this, we can use an Artisan command to generate a. In laravel, artisan is a file under root/protected page. For example, c:xampphtdocsmyprojectprotectedartisan. You can view the content of 'artisan' file with any text editor, it's a php command syntax. So when we type. We tell php to run php script in 'artisan' file. For example: php artisan change.
School data is kept in sync in O365 Education tenants by Microsoft School Data Sync.
- The artisan command has to be parsed through a php interpreter, thats why you call it like php artisan. I think, you have to use the php.exe to make it work on Windows. Some thing like c:pathtophp.exe artisan command. Read through the documentation and the Code happy book by Dayle Rees, to understand the public folder and how to setup a Virtual host for your.
- Oct 22, 2014 php artisan key:generate -env=local Open C:xampphtdocssnipe-it in Windows Explorer. Right Click and select Composer Install. This will install the dependencies. Once completed move to next step; Right Click and select Use Composer here; Type php artisan app:install and follow the prompts.
Table of contents
Sample Goals
The sample demonstrates:
- Calling Graph APIs, including:
- Linking locally-managed user accounts and Office 365 (Azure Active Directory) user accounts.After linking accounts, users can use either local or Office 365 accounts to log into the sample website and use it.
- Getting schools, sections, teachers, and students from Office 365 Education:
The sample is implemented with the PHP language and the Laravel framework.
Laravel is a PHP web application framework with expressive, elegant syntax. It attempts to take the pain out of development by easing common tasks used in the majority of web projects.
Laravel is accessible, yet powerful, providing tools needed for large, robust applications. A superb combination of simplicity, elegance, and innovation give you tools you need to build any application with which you are tasked.
Prerequisites
Deploying and running this sample requires:
- An Azure subscription with permissions to register a new application, and deploy the web app.
- An O365 Education tenant with Microsoft School Data Sync enabled
- One of the following browsers: Edge, Internet Explorer 9, Safari 5.0.6, Firefox 5, Chrome 13, or a later version of one of these browsers.
Additionally: Developing/running this sample locally requires the following:- Familiarity with PHP and Laravel.
Register the application in Azure Active Directory
- Sign into the new Azure portal: https://portal.azure.com/.
- Choose your Azure AD tenant by selecting your account in the top right corner of the page:
- Click Azure Active Directory -> App registrations -> +Add.
- Input a Name, and select Web app / API as Application Type.Input Sign-on URL Download pes 2017 key generator for pc. : http://localhost.Click Create.
- Once completed, the app will show in the list.
- Click it to view its details.
- Click All settings, if the setting window did not show.
- Click Properties, then set Multi-tenanted to Yes.Copy aside Application ID, then Click Save.
- Click Required permissions. Add the following permissions:
API Application Permissions Delegated Permissions Microsoft Graph Read directory data Read all users' full profiles
Read directory data
Read directory data
Access directory as the signed in user
Sign users inWindows Azure Active Directory Sign in and read user profile
Read and write directory data - Click Keys, then add a new key:Click Save, then copy aside the VALUE of the key.
Close the Settings window.
Run the sample locally
Follow the steps below to run this sample on a windows server: https://hawaiikeen227.weebly.com/generate-public-and-private-key-online.html.
- Download XAMPP and install it to a local folder, for example c:xmapp. Notice: the minimal PHP version is 7.0. Add C:xamppphp to environment variables.
- Download and install Composer.
- Download the source code from Github and extra to a local folder like C:O365-EDU-PHP-Samples.
- Open command window on the folder C:O365-EDU-PHP-Samples and run composer update.
- Create the .env file in the local folder and configure the values:
- APP_KEY: use 'php artisan key:generate' command to generate a new key.
- CLIENT_ID: use the Client Id of the app registration you created earlier.
- CLIENT_SECRET: use the Key value of the app registration you created earlier.
- SOURCECODEREPOSITORYRL: use the URL of this repository.
- Edit httpd-vhosts.conf under C:xamppapacheconfextra. Add below content in green square and make the path in read square match to the path in step 3.
- Restart xmapp server and visit http://localhost.
Deploy the sample to Azure
GitHub Authorization
- Generate Token
- Open https://github.com/settings/tokens in your web browser.
- Sign into your GitHub account where you forked this repository.
- Click Generate New Token
- Enter a value in the Token description text box
- Select the followings (your selections should match the screenshot below):
- repo (all) -> repo:status, repo_deployment, public_repo
- admin:repo_hook -> read:repo_hook
- Click Generate token
- Copy the token
- Add the GitHub Token to Azure in the Azure Resource Explorer
- Open https://resources.azure.com/providers/Microsoft.Web/sourcecontrols/GitHub in your web browser.
- Log in with your Azure account.
- Selected the correct Azure subscription.
- Select Read/Write mode.
- Click Edit.
- Paste the token into the token parameter.
- Click PUT
Deploy the Azure Components from GitHub
- Check to ensure that the build can run in local environment.
- Fork this repository to your GitHub account.
- Click the Deploy to Azure Button:
- Fill in the values in the deployment page and select the I agree to the terms and conditions stated above checkbox.
- Resource group: we suggest you create a new group.
- Site Name: please input a name. Like EDUGraphAPICanviz or EDUGraphAPI993.Note: If the name you input is taken, you will get some validation errors:Click it you will get more details like storage account is already in other resource group/subscription.In this case, please use another name.
- Source Code Repository URL: replace
o365UserId and o365Email are used to connect the local user with an O365 user.UserRoles Contains users' role. Three roles are used in this sample: admin, teacher, and student. Organizations A row in this table represents a tenant in AAD.
isAdminConsented column records than if the tenant consented by an administrator.TokenCache Contains the users' access/refresh tokens. ClassroomSeatingArrangements Contains the classroom seating arrangements. ControllersBelow are the main controllers used by the sample.Controller Description LoginController contains actions for local users to log in. O365AuthController contains actions for O365 users to log in LinkController implements the Local/O365 Login Authentication Flow. Please check Authentication Flows section for more details. AdminController contains the admin actions SchoolsController contains actions to show schools and classes. SchoolsService
class is mainly used by this controller. Please check Office 365 Education API section for more details.All the controllers are under the app/Http/Controller folder.MiddlewaresWe create several middlewares for authentication and authorization.Middleware Description AdminOnlyMiddleware Only allows admin to access the protected routes. It is mainly used for AdminController. LinkRequiredMiddleware Redirects unlinked users to /link. It is mainly used for the SchoolsController. SocializeAuthMiddleware Integrate O365 user with PHP authentication framework. The current O365 user could be got through Auth:user()
.All the middleware are in the app/Http/Middleware.ServicesBelow are the main services used by the sample:Service Description AADGraphService Contains methods used to access AAD Graph REST APIs. MSGraphService Contains methods used to access MS Graph REST APIs. EducationService Contains methods like get user information, get schools/classes/users, get/update seating arrangements. CookieService Contains methods that used to manage cookies. TokenCacheService Contains methods used to get and update token cache from the database. UserService Contains methods used to manipulate users in the database. AdminService Contains administrative methods like consent tenant, manage linked accounts. All the services are in the app/Services folder.Multi-tenant appThis web application is a multi-tenant app. In the AAD, we enabled the option:Users from any Azure Active Directory tenant can access this app. Some permissions used by this app require an administrator of the tenant to consent before users can use the app. Otherwise, users will see this error:For more information, see Build a multi-tenant SaaS web application using Azure AD & OpenID Connect.Office 365 Education API
The Office 365 Education APIs return data from any Office 365 tenant which has been synced to the cloud by Microsoft School Data Sync. The APIs provide information about schools, sections, teachers, students, and rosters. The Schools REST API provides access to school entities in Office 365 for Education tenants.In this sample, theAppServicesEducationService
class encapsulates the Office 365 Education API.Get schoolsOpenvpn connect client. Get classesGet usersBelow are some screenshots of the sample app that show the education data.Authentication Flows
There are 4 authentication flows in this project.The first 2 flows (Local Login/O365 Login) enable users to login in with either a local account or an Office 365 account, then link to the other type account. This procedure is implemented in the LinkController.Local Login Authentication FlowNew generate online wireless key new ssid. O365 Login Authentication FlowAdmin Login Authentication FlowThis flow shows how an administrator logs into the system and performs administrative operations.After logging into the app with an Office 365 account, the administrator will be asked to link to a local account. This step is not required and can be skipped.As mentioned earlier, the web app is a multi-tenant app which uses some application permissions, so tenant administrator must consent the app first.This flow is implemented in the AdminController.Two Kinds of Graph APIs
There are two distinct Graph APIs used in this sample:Azure AD Graph API Microsoft Graph API Description The Azure Active Directory Graph API provides programmatic access to Azure Active Directory through REST API endpoints. Apps can use the Azure AD Graph API to perform create, read, update, and delete (CRUD) operations on directory data and directory objects, such as users, groups, and organizational contacts A unified API that also includes APIs from other Microsoft services like Outlook, OneDrive, OneNote, Planner, and Office Graph, all accessed through a single endpoint with a single access token. Client Install-Package Microsoft.Azure.ActiveDirectory.GraphClient Install-Package Microsoft.Graph End Point https://graph.windows.net https://graph.microsoft.com API Explorer https://graphexplorer.cloudapp.net/ https://graph.microsoft.io/graph-explorer IMPORTANT NOTE: Microsoft is investing heavily in the new Microsoft Graph API, and they are not investing in the Azure AD Graph API anymore (except fixing security issues).Therefore, please use the new Microsoft Graph API as much as possible and minimize how much you use the Azure AD Graph API.Below is a piece of code shows how to get 'me' from the Microsoft Graph API.Note that in the AAD Application settings, permissions for each Graph API are configured separately:Questions and comments
- If you have any trouble running this sample, please log an issue.
- Questions about GraphAPI development in general should be posted to Stack Overflow. Make sure that your questions or comments are tagged with [microsoftgraph].
Contributing
We encourage you to contribute to our samples. For guidelines on how to proceed, see our contribution guide.This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.Key Generate Software
Copyright (c) 2017 Microsoft. All rights reserved.