Identity
API change historyCreate role-based users with varying levels of access to databases and applications. Clients can add, delete and update existing identities and their specific roles.
Check if user is logged into the system.
List of recipients and additional information: command. NextUrl: The URL after log in is complete. command. IsSuccess: Check if log in is a success. command. LoginError: Error message in case log in is not a success. command. NextUrl: The Url after log in is complete. command. Roles: User roles who can log in. command. UserName: User name of the log in account. command. DisplayName: Display name of the log in account. command. UserId: User Id of the log in account. command. FirstTimeLogIn: Check if this is the first time user has logged in. command. PhoneNumber: Contact number of the user.
Try itRequest
Request URL
Request parameters
-
(optional)string
Request headers
Request body
Responses
200 OK
Success
Representations
{
"IsSuccess": true,
"LogInError": {
"Code": 0,
"Message": "string"
},
"NextUrl": "string",
"Roles": [
"string"
],
"UserName": "string",
"DisplayName": "string",
"UserId": "string",
"FirstTimeLogIn": true,
"StatusCode": 0,
"PhoneNumber": "string"
}
{
"type": "object",
"properties": {
"IsSuccess": {
"type": "boolean",
"readOnly": true
},
"LogInError": {
"type": "object",
"properties": {
"Code": {
"type": "integer",
"format": "int32"
},
"Message": {
"type": "string"
}
},
"additionalProperties": false
},
"NextUrl": {
"type": "string"
},
"Roles": {
"type": "array",
"items": {
"type": "string"
}
},
"UserName": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"UserId": {
"type": "string"
},
"FirstTimeLogIn": {
"type": "boolean"
},
"StatusCode": {
"type": "integer",
"format": "int32"
},
"PhoneNumber": {
"type": "string"
}
},
"additionalProperties": false
}
{
"IsSuccess": true,
"LogInError": {
"Code": 0,
"Message": "string"
},
"NextUrl": "string",
"Roles": [
"string"
],
"UserName": "string",
"DisplayName": "string",
"UserId": "string",
"FirstTimeLogIn": true,
"StatusCode": 0,
"PhoneNumber": "string"
}
{
"type": "object",
"properties": {
"IsSuccess": {
"type": "boolean",
"readOnly": true
},
"LogInError": {
"type": "object",
"properties": {
"Code": {
"type": "integer",
"format": "int32"
},
"Message": {
"type": "string"
}
},
"additionalProperties": false
},
"NextUrl": {
"type": "string"
},
"Roles": {
"type": "array",
"items": {
"type": "string"
}
},
"UserName": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"UserId": {
"type": "string"
},
"FirstTimeLogIn": {
"type": "boolean"
},
"StatusCode": {
"type": "integer",
"format": "int32"
},
"PhoneNumber": {
"type": "string"
}
},
"additionalProperties": false
}
Code samples
@ECHO OFF
curl -v -X GET "https://stg-ecap.azure-api.net/identity/Identity/Authentication/IsLoggedin?NextUrl={string}"
-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}");
// Request parameters
queryString["NextUrl"] = "{string}";
var uri = "https://stg-ecap.azure-api.net/identity/Identity/Authentication/IsLoggedin?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // 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/identity/Identity/Authentication/IsLoggedin");
builder.setParameter("NextUrl", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
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
"NextUrl": "{string}",
};
$.ajax({
url: "https://stg-ecap.azure-api.net/identity/Identity/Authentication/IsLoggedin?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// 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/identity/Identity/Authentication/IsLoggedin";
NSArray* array = @[
// Request parameters
@"entities=true",
@"NextUrl={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_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/identity/Identity/Authentication/IsLoggedin');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'NextUrl' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// 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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'NextUrl': '{string}',
})
try:
conn = httplib.HTTPSConnection('stg-ecap.azure-api.net')
conn.request("GET", "/identity/Identity/Authentication/IsLoggedin?%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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'NextUrl': '{string}',
})
try:
conn = http.client.HTTPSConnection('stg-ecap.azure-api.net')
conn.request("GET", "/identity/Identity/Authentication/IsLoggedin?%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/identity/Identity/Authentication/IsLoggedin')
query = URI.encode_www_form({
# Request parameters
'NextUrl' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# 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