Integrate the OneDrive API into your iOS app!
- Install Cocoapods - Follow the getting started guide to install Cocoapods.
- Add the following to your Podfile :
pod 'OneDriveSDK'
- Run the command
pod install
to install the latest OneDriveSDK pod. - Add
#import <OneDriveSDK/OneDriveSDK.h>
to all files that need to reference the SDK.
If you are targeting iOS 9 with XCode 7, you need to temporarily enable PFS exceptions for the following domains:
- login.live.com
- login.microsoftonline.com
- login.windows.net
- secure.aadcdn.microsoftonline-p.com
To do this, add the following to your Info.plist :
<key>NSAppTransportSecurity</key>
<dict>
<key>NSExceptionDomains</key>
<dict>
<key>login.windows.net</key>
<dict/>
<key>NSIncludeSubdomains</key>
<true/>
<key>NSExceptionRequiresForwardSecrecy</key>
<false/>
<key>secure.aadcdn.microsoftonline-p.com</key>
<dict>
<key>NSIncludeSubmdomains</key>
<true/>
<key>NSExceptionRequiresForwardSecrecy</key>
<false/>
</dict>
<key>login.microsoftonline.com</key>
<dict>
<key>NSIncludeSubmdomains</key>
<true/>
<key>NSExceptionRequiresForwardSecrecy</key>
<false/>
</dict>
<key>login.live.com</key>
<dict>
<key>NSIncludeSubmdomains</key>
<true/>
<key>NSExceptionRequiresForwardSecrecy</key>
<false/>
</dict>
</dict>
</dict>
You can also see OneDriveAPIExplorer for an example.
These domains enable MSA and standard AAD authentication. It's possible that an AAD domain has a multifactor auth flow or ADFS integration would send you to another domain. If you're targeting a customer set, you'll need to add exceptions for those domains to your app or disable ATS all together. To disable ATFS entirely add the following to your Info.plist:
Warning This it not the recommended approach and is only necessary if you wish to target all tenants that do not use standard AAD authentication and do not support Transport Layer Security v1.2.
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowArbitraryLoads</key>
<true/>
</dict>
Register your application by following these steps.
-
You can set your application Id and scopes directly on the ODClient object.
-
For applications targeting OneDrive call the class method
[ODClient setMicrosoftAccountAppId:<applicationId> scopes:<scopes>]
with a specified<applicationId>
and<scopes>
. For more info about scopes, see Authentication scopes. -
For applications targeting OneDrive for Business call the class method
[ODClient setActiveDirectoryAppId:<applicationId> redirectURL:<redirectURL>]
with specified<applicationId>
and<redirectURL>
. Note: the redirect URL must match the redirect URL that you specified in the Azure Management Portal.
-
Once you have set the correct application Id and scopes, you must get an ODClient object to make requests against the service. The SDK will store the account information for you, but when a user logs on for the first time, it will invoke UI to get the user's account information.
-
Get an authenticated ODClient via the clientWithCompletion method:
[ODClient clientWithCompletion:^(ODClient *client, NSError *error){
if (!error){
self.odClient = client;
}
}];
Once you have an ODClient that is authenticated you can begin to make calls against the service. The requests against the service look like our REST API.
To retrieve a user's drive:
[[[odClient drive] request] getWithCompletion:^(ODDrive *drive, NSError *error){
//Returns an ODDrive object or an error if there was one
}];
To get a user's root folder of their drive:
[[[[odClient drive] items:@"root"] request] getWithCompletion:^(ODItem *item, NSError *error){
//Returns an ODItem object or an error if there was one
}];
For a general overview of how the SDK is designed, see overview.
For a complete sample application, see OneDriveAPIExplorer.
For a more detailed documentation see:
- Overview
- [Auth] (docs/auth.md)
- Items
- Collections
- Errors
For known issues, see issues.