microsoftgraph / php-connect-rest-sample

[ARCHIVED] Use Microsoft Graph to access a user’s Microsoft account data from within a php web application. This sample gets OAuth tokens from the Azure AD v2.0 endpoint and uses REST calls directly to Microsoft Graph.

[ARCHIVED] PHP Connect sample using Microsoft Graph

IMPORTANT

This project is being archived and replaced with the Build PHP apps with Microsoft Graph. As part of the archival process, we're closing all open issues and pull requests.

You can continue to use this sample "as-is", but it won't be maintained moving forward. We apologize for any inconvenience.

Connecting to Microsoft Graph is the first step every app must take to start working with Office 365 services and data. This sample shows how to connect and then call one API through Microsoft Graph and uses the Office Fabric UI to create an Office 365 experience.

Try out the Microsoft Graph Quick Start page which simplifies registration so you can get this sample running faster.

Note: For an in-depth look at the code, see [Call Microsoft Graph in a PHP app] (http://graph.microsoft.io/docs/platform/php).

Prerequisites

To use the PHP Connect sample, you need the following:

• PHP is required to run the sample on a development server. The instructions in this sample use the PHP 5.4 built-in web server. However, the sample has also been tested on Internet Information Services and Apache Server.
  • Client URL (cURL) module. The web application uses cURL to issue requests to REST endpoints.
  • Composer, dependency manager for PHP

Register and configure the app

1. Sign into the App Registration Portal using either your personal or work or school account.

2. Select Add an app under Converged applications.

3. Enter a name for the app, and select Create application.

   The registration page displays, listing the properties of your app.

4. Under Platforms, select Add platform.

5. Select Web.

6. Add the following to the list of Redirect URIs:

   http://localhost:8000/oauth.php
   

7. Under Application Secrets click Generate New Password.

8. Copy the New password generated and Application Id, you'll need them in the next section.

9. Click Save.

Configure and run the app

1. Using your favorite IDE, open Constants.php in the src folder.

2. Replace ENTER_YOUR_CLIENT_ID with the application id from the previous section.

3. Replace ENTER_YOUR_SECRET with the password from the previous section.

4. Install the dependencies with the following command:

   composer install
   

5. Start the built-in web server with the following command:

   php -S 0.0.0.0:8000 -t app
   

6. Navigate to http://localhost:8000 in your web browser.

Troubleshooting

Error: Unable to get local issuer certificate

You receive the following error after providing your credentials to the sign in page.

SSL certificate problem: unable to get local issuer certificate

cURL can't verify the validity of the Microsoft certificate when trying to issue a request call to get tokens. You must configure cURL to use a certificate when issuing https requests by following these steps:

1. Download the cacert.pem file from cURL website.

• In Chrome, right-click the cacert.pem link and choose Save link as.
• In Microsoft Edge, right-click the cacert.pem link and choose Save target as. Then rename the saved file's htm extension to pem.

2. Open your php.ini file and add the following line:

   curl.cainfo = "absolute_path_to_cacert/cacert.pem"
   

3. Restart the server.

Contributing

If you'd like to contribute to this sample, see CONTRIBUTING.MD.

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.

Questions and comments

We'd love to get your feedback about the PHP Connect sample. You can send your questions and suggestions to us in the Issues section of this repository.

Questions about Microsoft Graph development in general should be posted to Stack Overflow. Make sure that your questions or comments are tagged with [MicrosoftGraph] and [API].

Additional resources

• Microsoft Graph
• Other PHP samples for Microsoft Graph
• Office UI Fabric

Copyright

Copyright (c) 2016 Microsoft. All rights reserved.

php-connect-rest-sample's Issues

Something went wrong, couldn't get tokens: invalid_client

`Notice: Use of undefined constant clientId - assumed 'clientId' in C:\xampp\htdocs\app\oauth.php on line 30

Notice: Use of undefined constant clientSecret - assumed 'clientSecret' in C:\xampp\htdocs\app\oauth.php on line 31

Notice: Use of undefined constant redirectUri - assumed 'redirectUri' in C:\xampp\htdocs\app\oauth.php on line 32

Notice: Use of undefined constant urlAuthorize - assumed 'urlAuthorize' in C:\xampp\htdocs\app\oauth.php on line 33

Notice: Use of undefined constant urlAccessToken - assumed 'urlAccessToken' in C:\xampp\htdocs\app\oauth.php on line 34

Notice: Use of undefined constant urlResourceOwnerDetails - assumed 'urlResourceOwnerDetails' in C:\xampp\htdocs\app\oauth.php on line 35

Notice: Use of undefined constant scopes - assumed 'scopes' in C:\xampp\htdocs\app\oauth.php on line 36

Notice: Use of undefined constant code - assumed 'code' in C:\xampp\htdocs\app\oauth.php on line 59
Something went wrong, couldn't get tokens: invalid_client`

I just started a new project, what is wrong here ? I logged in with a buisness microsoft account, and then these erroes appear.

Integrating into Website (PHP)

I wanted to integrate provided API in my Angular JS project with php as backend. I am unable to integrate it due to some issues. Can someone guide as to which steps I need to follow in order to integrate it in my website. Thanks

issue in outh.php

after passing on my credentials and signing in ,i'm getting error in outh.php

Notice: Use of undefined constant clientId - assumed 'clientId' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 34

Notice: Use of undefined constant clientSecret - assumed 'clientSecret' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 35

Notice: Use of undefined constant redirectUri - assumed 'redirectUri' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 36

Notice: Use of undefined constant urlAuthorize - assumed 'urlAuthorize' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 37

Notice: Use of undefined constant urlAccessToken - assumed 'urlAccessToken' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 38

Notice: Use of undefined constant urlResourceOwnerDetails - assumed 'urlResourceOwnerDetails' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 39

Notice: Use of undefined constant scopes - assumed 'scopes' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 40

Notice: Use of undefined constant code - assumed 'code' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\app\oauth.php on line 65

Fatal error: Uncaught exception 'GuzzleHttp\Exception\RequestException' with message 'cURL error 60: SSL certificate problem: unable to get local issuer certificate (see http://curl.haxx.se/libcurl/c/libcurl-errors.html)' in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\vendor\guzzlehttp\guzzle\src\Handler\CurlFactory.php:187 Stack trace: #0 C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\vendor\guzzlehttp\guzzle\src\Handler\CurlFactory.php(150): GuzzleHttp\Handler\CurlFactory::createRejection(Object(GuzzleHttp\Handler\EasyHandle), Array) #1 C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\vendor\guzzlehttp\guzzle\src\Handler\CurlFactory.php(103): GuzzleHttp\Handler\CurlFactory::finishError(Object(GuzzleHttp\Handler\CurlHandler), Object(GuzzleHttp\Handler\EasyHandle), Object(GuzzleHttp\Handler\CurlFactory)) #2 C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\vendor\guzzlehttp\guzzle\src\Handler\CurlHandler.php(43): GuzzleHttp\Handler\CurlF in C:\xampp\htdocs\project\microsoft\phpconnect\php-connect-rest-sample\vendor\guzzlehttp\guzzle\src\Handler\CurlFactory.php on line 187

could you please help

Errors With API

Hi there, I'm looking to use the Graph API with PHP, however I'm running into a few errors. When I first set up my account and run the oauth loop, it works properly. I'm directed to the /sendmail.php. When I click to send a mail message as myself, without modifying the code, I get an error back:

array(1) { ["error"]=> array(3) { ["code"]=> string(10) "BadRequest" ["message"]=> string(114) "Unable to read JSON request payload. Please ensure Content-Type header is set and payload is of valid JSON format." ["innerError"]=> array(2) { ["request-id"]=> string(36) "1dfc3c80-674e-4234-a62a-92a45b519a4c" ["date"]=> string(19) "2016-12-12T16:52:31" } } } array(26) { ["url"]=> string(44) "https://graph.microsoft.com/v1.0/me/sendmail" ["content_type"]=> string(16) "application/json" ["http_code"]=> int(400) ["header_size"]=> int(495) ["request_size"]=> int(1331) ["filetime"]=> int(-1) ["ssl_verify_result"]=> int(0) ["redirect_count"]=> int(0) ["total_time"]=> float(0.365301) ["namelookup_time"]=> float(0.072895) ["connect_time"]=> float(0.104058) ["pretransfer_time"]=> float(0.288482) ["size_upload"]=> float(2579) ["size_download"]=> float(310) ["speed_download"]=> float(848) ["speed_upload"]=> float(7059) ["download_content_length"]=> float(-1) ["upload_content_length"]=> float(2579) ["starttransfer_time"]=> float(0.322992) ["redirect_time"]=> float(0) ["redirect_url"]=> string(0) "" ["primary_ip"]=> string(13) "157.56.28.135" ["certinfo"]=> array(0) { } ["primary_port"]=> int(443) ["local_ip"]=> string(15) "192.168.231.202" ["local_port"]=> int(57747) }

I've dumped out the curl opts / headers and they all look correct. So, moving on.

I attempted to use Guzzle to make a request with the existing oauth token to see if I could list users or something, so I tried this:

<?php

require_once('../autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Microsoft\Graph\Connect\Constants;

if (session_status() == PHP_SESSION_NONE) {
    session_start();
}

$client = new GuzzleHttp\Client;

try {
    $response = $client->request('GET', Constants::RESOURCE_ID . Constants::USERS_ENDPOINT, [
        'headers' => [
            'Authorization' => 'Bearer ' . $_SESSION['access_token'],
            'Content-Type' => 'application/json'
        ]
    ]);

} catch (Exception $e) {
    var_dump(json_decode($e->getResponse()->getBody()->getContents()));
}

var_dump($response->getBody());

die();

Which gives me an error:

["error"]=> object(stdClass)#30 (3) { ["code"]=> string(12) "UnknownError" ["message"]=> string(122) "{"Status":500,"Message":"All the offeractions povided in the property bag cannot be validated for the token.\u000d\u000a"}" ["innerError"]=> object(stdClass)#17 (2) { ["request-id"]=> string(36) "bff1baa2-db7c-412c-99a4-42f5f9b3bfb4" ["date"]=> string(19) "2016-12-12T16:54:57" } }

Obviously this is an internal error on the Microsoft API, however I have no clue how to interpret that or handle it. It's not even spelled properly either. Just wondering what I can do to get this simple example working?

How do I generate a new access_token using refresh_token?

Thanks in advance!

PHP Library

Is Microsoft plannng to convert this to a maintained library (like azure-activedirectory-library-for-python or Android SDK), or is it up to PHP developers to create their own libraries to access Microsoft's REST API?

a little outdated

Hello,

how about updating this example to the newest laravel 5.5LTS version?
The current version is 5.2

Getting ErrorInvalidRecipients Error

Hi

I set up this project as suggested in https://github.com/microsoftgraph/php-connect-sample it works fine till authorization but when using send mail code it gives me invalid recipient error

ClientException in RequestException.php line 111:
Client error: POST https://graph.microsoft.com/v1.0/me/sendMail resulted in a 400 Bad Request response:
{
"error": {
"code": "ErrorInvalidRecipients",
"message": "At least one recipient isn't valid., A message c (truncated...)
in RequestException.php line 111
at RequestException::create(object(Request), object(Response)) in Middleware.php line 65
at Middleware::GuzzleHttp{closure}(object(Response)) in Promise.php line 203
at Promise::callHandler('1', object(Response), array(object(Promise), object(Closure), null)) in Promise.php line 156
at Promise::GuzzleHttp\Promise{closure}() in TaskQueue.php line 47
at TaskQueue->run(true) in Promise.php line 246
at Promise->invokeWaitFn() in Promise.php line 223
at Promise->waitIfPending() in Promise.php line 266
at Promise->invokeWaitList() in Promise.php line 225
at Promise->waitIfPending() in Promise.php line 62
at Promise->wait() in Client.php line 129
at Client->request('POST', 'v1.0/me/sendMail', array('body' => '{"message":{}}', 'stream' => null, 'timeout' => '0')) in GraphRequest.php line 247
at GraphRequest->execute() in EmailController.php line 109
at EmailController->sendEmail()
at call_user_func_array(array(object(EmailController), 'sendEmail'), array()) in compiled.php line 9567
at Controller->callAction('sendEmail', array()) in compiled.php line 9594
at ControllerDispatcher->dispatch(object(Route), object(EmailController), 'sendEmail') in compiled.php line 8648
at Route->runController() in compiled.php line 8629
at Route->run(object(Request)) in compiled.php line 8338
at Router->Illuminate\Routing{closure}(object(Request)) in Pipeline.php line 53
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 10160
at SubstituteBindings->handle(object(Request), object(Closure)) in compiled.php line 10052
at Pipeline->Illuminate\Pipeline{closure}(object(Request)) in Pipeline.php line 33
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 3309
at VerifyCsrfToken->handle(object(Request), object(Closure)) in compiled.php line 10052
at Pipeline->Illuminate\Pipeline{closure}(object(Request)) in Pipeline.php line 33
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 13725
at ShareErrorsFromSession->handle(object(Request), object(Closure)) in compiled.php line 10052
at Pipeline->Illuminate\Pipeline{closure}(object(Request)) in Pipeline.php line 33
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 12131
at StartSession->handle(object(Request), object(Closure)) in compiled.php line 10052
at Pipeline->Illuminate\Pipeline{closure}(object(Request)) in Pipeline.php line 33
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 13471
at AddQueuedCookiesToResponse->handle(object(Request), object(Closure)) in compiled.php line 10052
at Pipeline->Illuminate\Pipeline{closure}(object(Request)) in Pipeline.php line 33
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 13408
at EncryptCookies->handle(object(Request), object(Closure)) in compiled.php line 10052
at Pipeline->Illuminate\Pipeline{closure}(object(Request)) in Pipeline.php line 33
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 10037
at Pipeline->then(object(Closure)) in compiled.php line 8339
at Router->runRouteWithinStack(object(Route), object(Request)) in compiled.php line 8330
at Router->dispatchToRoute(object(Request)) in compiled.php line 8321
at Router->dispatch(object(Request)) in compiled.php line 2575
at Kernel->Illuminate\Foundation\Http{closure}(object(Request)) in Pipeline.php line 53
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 3371
at CheckForMaintenanceMode->handle(object(Request), object(Closure)) in compiled.php line 10052
at Pipeline->Illuminate\Pipeline{closure}(object(Request)) in Pipeline.php line 33
at Pipeline->Illuminate\Routing{closure}(object(Request)) in compiled.php line 10037
at Pipeline->then(object(Closure)) in compiled.php line 2519
at Kernel->sendRequestThroughRouter(object(Request)) in compiled.php line 2503
at Kernel->handle(object(Request)) in index.php line 54
at require_once('D:\xampp\htdocs\outlook\public\index.php') in server.php line 21

Hung Up on oAuth.php

I'm not sure if this is the same issue as the other one I created, but I tried moving the files onto the webserver, since working locally was giving me directory issues.

It goes through sign in at microsoft's website fine, but when it heads back to oauth.php, it gets stuck. I simply get a white page and the url is:

[url excluded]/oauth.php?code=OAQABAAIAAABnfiG-mA6NTae7CdWW7QfdVfRourtTf2VjH18UHuhTKX10t5VaJ3g1EE2rmr7AAObOAWWxiDng1TtjSmSNKx4zSiSvwlG911lwNz9EJuWcHSzNBktq1JCfR6vIKFQPE9lWp9FqUblRGNL41EMtcPiZf1Op_XTpb9j5JHYlXiwE1k8SUhqYr8bBLuNTU_bBDcCWGI8kmEk2yH7Lp0xovD_9-pp7todzCqVXpHeYXbghOLhowSJgJSyjw2Ji6InB4VRNRngWbSGkcEdT-MftO1y-7kPGfhFSbHffvsZNXKMD_1iNqIgSo5EyoA-rCw8e72t0CsnQwmF-aA0s_vINqt8yxGFU-NwxpuUa3NEyxfVHasrvt5EmLX0d1FWSDzfaTCoA4jVcHKci5Yq3lgd_up6Bv5s-OdgPSqF5fgRmoNPrKtAy_og6XM-slgMW1c-3G6l96ZePjYIJ7X_pZVaOpcH64PIAhwgFNArUPCDQgrvQM_2XkRN2my76UzrreRTPUK-VBd492ATVVIV-O1Jhjx8cbIJt5GdeM-9x4L-2tu876soqP9f6AucJC-HgW7zxlF-1_0KZcPssV5cZD_ks1VIbYaTqfFbaFukPJzGTQ2qHfJVvub8DN94nYVloiBd0FUjsX1ZG6dLKyydc9OONtPuk6ts8dmztI33H-yfw4JLqSmSJMEsji0dwNJp1bIMej7AGP6zmulyg8xhnMj_ybSZb-UJqfv_1ghhYPOuJ2mMG1xAa7x0GH5sLiRcR7OJOf5YgAA&state=83q4SjNsuXA134yleKoGPqWitxflC51T&session_state=9d56121d-40ab-4d62-9e8b-f570391dcd01

About logined user's reconnecting.

Hello,
From what i understand, this code is just connects and checks the token and extract connected user's information to session. What if a connected user is revisits this page, how to validate the session-saved token from microsoft? Could you please add this funcionality to the oauth.php page please.
Thanks,
Kambaa

Refresh token is missing from access token generation.

Hi there! Thanks for providing this PHP sample, it's really helpful.

I have debugged the oauth.php and realised that the refresh-token is not included within the $accessToken object.

How can one fetch a refresh token along with the other data?

Thanks in advance,

Alex

Constants.php in the app folder.

Configure and run the app

Using your favorite IDE, open Constants.php in the app folder.

There is no constants.php in the app folder......

Is there a way to manually validate the access_token before making a REST API call?

Thanks in advance!

PHP 7.0.8

Running this example on php 7.0.8, instead of getting the microsoft login page, you get:
Warning: Cannot modify header information - headers already sent by (output started at /home/vagrant/phpgraphazuremaster/app/oauth.php:34) in /home/vagrant/phpgraphazuremaster/app/oauth.php on line 47

Unquoted array indexes in oauth.php

in oauth.php

$provider = new GenericProvider([ 'clientId' => Constants::CLIENT_ID, 'clientSecret' => Constants::CLIENT_SECRET, 'redirectUri' => Constants::REDIRECT_URI, 'urlAuthorize' => Constants::AUTHORITY_URL . Constants::AUTHORIZE_ENDPOINT, 'urlAccessToken' => Constants::AUTHORITY_URL . Constants::TOKEN_ENDPOINT, 'urlResourceOwnerDetails' => '', 'scopes' => Constants::SCOPES ]);

note how the array indexes need to be quoted. After installing the sample, quotes around clientId, clientSecret, etc... are missing

Same here:
// Get an access token using the authorization code grant $accessToken = $provider->getAccessToken('authorization_code', [ 'code' => $_GET['code'] ]);

Quotes around index 'code' are missing.

Which OAuth2 grant?

I've successfully extended this example to read and write user details like this, this and this but when trying to write a profile photo of a user in my organisation like this I get
[code] => ErrorAccessDenied
[message] => AccessDeniedException

The only clue I have right now is the following note on the page

Note To update the photo of any user in the organization, your app must have the User.ReadWrite.All application permission and call this API under its own identity, not on behalf of a user.

I'm suspecting this has something to do with different types of grants (Client credentials vs Authorization code) but I don't really understand much of this and how this example is set up.

Can you please help me, I'm becoming insane?!

Unable to create User

@jamescro Hi! I'm trying to create User with POST request to the MS Graph.
And the response is always:

{ "error": { "code": "UnknownError", "message": "{\"Status\":500,\"Message\":\"All the offeractions povided in the property bag cannot be validated for the token.\\u000d\\u000a\"}", "innerError": { "request-id": "566c5644-5a6c-4e99-9ed9-f0052abf18a3", "date": "2017-05-12T07:55:22" } } }

This is the response from MS Graph explorer.
I'm sendind the Authorization header with code (which works for getting calendar data for example), the example of request body (with content-type json) is taken from the MS Graph explorer
{ "accountEnabled": true, "city": "Seattle", "country": "United States", "department": "Sales & Marketing", "displayName": "Melissa Darrow", "givenName": "Melissa", "jobTitle": "Marketing Director", "mailNickname": "MelissaD", "passwordPolicies": "DisablePasswordExpiration", "passwordProfile": { "password": "Test1234", "forceChangePasswordNextSignIn": false }, "officeLocation": "131/1105", "postalCode": "98052", "preferredLanguage": "en-US", "state": "WA", "streetAddress": "9256 Towne Center Dr., Suite 400", "surname": "Darrow", "mobilePhone": "[phone]", "usageLocation": "US", "userPrincipalName": "[email protected]" }

Please, help(

Download pdf from a word file in onedrive

when use the same format of the onedrive api of download a file in pdf format with ?format=pdf at the end of a download file request, doesnt create a pdf download link in the header, create the same link to the word file, and in the graph documentation, is not the file format section only in https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get_content_format

Perhaps isnt implemented, but the onedrive api docu utilizes the graph oauth

example of the request
createRequest("GET", "/me/drive/items/".$itemid.'/content?format=pdf')->execute();
maked with the graph php api

oAuth Issue

I am getting the following errors:

( ! ) Notice: Use of undefined constant clientId - assumed 'clientId' in C:\wamp\impact-research\files\app\oauth.php on line 30

( ! ) Notice: Use of undefined constant clientSecret - assumed 'clientSecret' in C:\wamp\impact-research\files\app\oauth.php on line 31

( ! ) Notice: Use of undefined constant redirectUri - assumed 'redirectUri' in C:\wamp\impact-research\files\app\oauth.php on line 32

( ! ) Notice: Use of undefined constant urlAuthorize - assumed 'urlAuthorize' in C:\wamp\impact-research\files\app\oauth.php on line 33

( ! ) Notice: Use of undefined constant urlAccessToken - assumed 'urlAccessToken' in C:\wamp\impact-research\files\app\oauth.php on line 34

( ! ) Notice: Use of undefined constant urlResourceOwnerDetails - assumed 'urlResourceOwnerDetails' in C:\wamp\impact-research\files\app\oauth.php on line 35

( ! ) Notice: Use of undefined constant scopes - assumed 'scopes' in C:\wamp\impact-research\files\app\oauth.php on line 36

( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp\impact-research\files\app\oauth.php:34) in C:\wamp\impact-research\files\app\oauth.php on line 46

I already tried the fix mentioned here: Issue #30 But it didn't seem to help.