2 Factor Authentication (2FA)
API change historyTwo Factor Authentication is a verification method using two different types of information. For example, a user can prove his/her identity using a password and an email verification link. Generally, email or sms is used alongside the username and password to cross-check and confirm the user’s identity.
Send two factor authentication code before accessing portal.
param name="command"
command.PersonId : Person ID.
command.Language : Language of the sms or email sent to the person.
command.ContextId : Context ID.
command.TwoFactorId : Two factor authentication ID.
command.Medium : The medium in which the two factor authentication code will be sent- email or sms. If not provided, the default option is sms.
Try it
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"PersonId": "string",
"Language": "string",
"ContextId": "string",
"TwoFactorId": "string",
"Medium": "string"
}
{
"type": "object",
"properties": {
"PersonId": {
"type": "string"
},
"Language": {
"type": "string"
},
"ContextId": {
"type": "string"
},
"TwoFactorId": {
"type": "string"
},
"Medium": {
"type": "string"
}
},
"additionalProperties": false
}
{
"PersonId": "string",
"Language": "string",
"ContextId": "string",
"TwoFactorId": "string",
"Medium": "string"
}
{
"type": "object",
"properties": {
"PersonId": {
"type": "string"
},
"Language": {
"type": "string"
},
"ContextId": {
"type": "string"
},
"TwoFactorId": {
"type": "string"
},
"Medium": {
"type": "string"
}
},
"additionalProperties": false
}
{
"PersonId": "string",
"Language": "string",
"ContextId": "string",
"TwoFactorId": "string",
"Medium": "string"
}
{
"type": "object",
"properties": {
"PersonId": {
"type": "string"
},
"Language": {
"type": "string"
},
"ContextId": {
"type": "string"
},
"TwoFactorId": {
"type": "string"
},
"Medium": {
"type": "string"
}
},
"additionalProperties": false
}
Responses
200 OK
Success
Representations
{
"Hint": "string",
"Errors": {
"IsValid": true,
"Errors": [
{
"PropertyName": "string",
"ErrorMessage": "string",
"AttemptedValue": {},
"CustomState": {},
"Severity": 0,
"ErrorCode": "string",
"FormattedMessageArguments": [
{}
],
"FormattedMessagePlaceholderValues": {},
"ResourceName": "string"
}
],
"RuleSetsExecuted": [
"string"
]
},
"ErrorMessages": [
"string"
],
"StatusCode": 0,
"RequestUri": "string",
"ExternalError": "string",
"HttpStatusCode": 100
}
{
"type": "object",
"properties": {
"Hint": {
"type": "string"
},
"Errors": {
"type": "object",
"properties": {
"IsValid": {
"type": "boolean",
"readOnly": true
},
"Errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PropertyName": {
"type": "string"
},
"ErrorMessage": {
"type": "string"
},
"AttemptedValue": {
"type": "object"
},
"CustomState": {
"type": "object"
},
"Severity": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"ErrorCode": {
"type": "string"
},
"FormattedMessageArguments": {
"type": "array",
"items": {
"type": "object"
}
},
"FormattedMessagePlaceholderValues": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"ResourceName": {
"type": "string"
}
},
"additionalProperties": false
},
"readOnly": true
},
"RuleSetsExecuted": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
},
"additionalProperties": false
},
"ErrorMessages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"StatusCode": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"RequestUri": {
"type": "string"
},
"ExternalError": {
"type": "string"
},
"HttpStatusCode": {
"enum": [
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
],
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
{
"Hint": "string",
"Errors": {
"IsValid": true,
"Errors": [
{
"PropertyName": "string",
"ErrorMessage": "string",
"AttemptedValue": {},
"CustomState": {},
"Severity": 0,
"ErrorCode": "string",
"FormattedMessageArguments": [
{}
],
"FormattedMessagePlaceholderValues": {},
"ResourceName": "string"
}
],
"RuleSetsExecuted": [
"string"
]
},
"ErrorMessages": [
"string"
],
"StatusCode": 0,
"RequestUri": "string",
"ExternalError": "string",
"HttpStatusCode": 100
}
{
"type": "object",
"properties": {
"Hint": {
"type": "string"
},
"Errors": {
"type": "object",
"properties": {
"IsValid": {
"type": "boolean",
"readOnly": true
},
"Errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PropertyName": {
"type": "string"
},
"ErrorMessage": {
"type": "string"
},
"AttemptedValue": {
"type": "object"
},
"CustomState": {
"type": "object"
},
"Severity": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"ErrorCode": {
"type": "string"
},
"FormattedMessageArguments": {
"type": "array",
"items": {
"type": "object"
}
},
"FormattedMessagePlaceholderValues": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"ResourceName": {
"type": "string"
}
},
"additionalProperties": false
},
"readOnly": true
},
"RuleSetsExecuted": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
},
"additionalProperties": false
},
"ErrorMessages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"StatusCode": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"RequestUri": {
"type": "string"
},
"ExternalError": {
"type": "string"
},
"HttpStatusCode": {
"enum": [
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
],
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Code samples
@ECHO OFF
curl -v -X POST "https://stg-ecap.azure-api.net/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://stg-ecap.azure-api.net/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://stg-ecap.azure-api.net/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://stg-ecap.azure-api.net/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://stg-ecap.azure-api.net/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://stg-ecap.azure-api.net/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('stg-ecap.azure-api.net')
conn.request("POST", "/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('stg-ecap.azure-api.net')
conn.request("POST", "/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://stg-ecap.azure-api.net/2fa/2FactorAuthentication/TwoFaCommand/Send2FactorAuthenticationCodeToPerson')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body