Using the Multi-Factor Authentication SDK
Published: May 20, 2013
Updated: March 23, 2015
The Windows Azure Multi-Factor Authentication Software Development Kit (SDK) lets you build telephone call and text message verification directly into the sign-in or transaction processes of applications in your Windows Azure AD tenant.
The Multi-Factor Authentication SDK is available for C#, Visual Basic (.NET), Java, Perl, PHP and Ruby. The SDK provides a thin wrapper around multi-factor authentication. It includes everything you need to write your code, including commented source code files, example files, and a detailed ReadMe file. Each SDK also includes a certificate and private key for encrypting transactions that is unique to your Multi-Factor Authentication Provider. As long as you have a provider, you can download the SDK in as many languages and formats as you need.
The Multi-Factor Authentication SDK supports verification by telephone call and SMS text messages, but it does not support Multi-Factor Authentication mobile apps.
To see a sample code that uses the SDK, see Code Sample: Standard Mode Phone Verification.
To download the Multi-Factor Authentication SDK, you must have a Windows Azure subscription, a Windows Azure AD tenant and you must create a Windows Azure Multi-Factor Authentication Provider. For details, including information about purchasing Multi-Factor Authentication for users, see Azure Multi-Factor Authentication.
Because the APIs do not have access to users registered in Windows Azure Active Directory, you must provide user information, such as phone numbers and PIN codes, in a file or database. Also, the APIs do not provide enrollment or user management features, so you need to build these processes into your application.
Before you download the Multi-Factor Authentication SDK, you need to create a Multi-Factor Authentication provider. For instructions, see Creating a Multi-Factor Authentication Provider in the TechNet Library.
To download a Multi-Factor Authentication SDK, use the Windows Azure Multi-Factor Authentication Management Portal. The SDK is available in several different popular web programming languages.
Go to the Windows Azure Management Portal (https://manage.WindowsAzure.com) and sign in.
Click All Items, click a multi-factor authentication provider, and then click Manage. Or, click Active Directory, click Multi-Factor Auth Providers, click a multi-factor authentication provider, and then click Manage.
The Windows Azure Multi-Factor Authentication Portal opens.
In the left navigation menu, click SDK.
Select a programming language and file format and then click Download.
Save and extract the files in your SDK.
Familiarize yourself with the contents of the Multi-Factor Authentication SDK. Each SDK includes the following files.
README. Explains how to use the Multi-Factor Authentication APIs in a new or existing application.
Source file(s) for Multi-Factor Authentication
Client certificate that you use to communicate with the Multi-Factor Authentication service
Private key for the certificate
Call results. A list of call result codes. To open this file, use an application with text formatting, such as WordPad. Use the call result codes to test and troubleshoot the implementation of Multi-Factor Authentication in your application. They are not authentication status codes.
Examples. Sample code for a basic working implementation of Multi-Factor Authentication.
|The client certificate is a unique private certificate that was generated especially for you. Do not share or lose this file. It’s your key to ensuring the security of your communications with the Multi-Factor Authentication service.|