Kazi Identifying API
API change historyThis document describes the Identifying API specifications of Kazi
Request
Request URL
Request parameters
-
string
Format - uuid. The partner for who you want to get the users
-
(optional)string
The unique identifier of the user at partner side
-
(optional)boolean
Whether user should have competences or not
-
(optional)boolean
Whether the returned users should include competences or not
-
(optional)string
Format - uuid. The Ats Client id
-
(optional)string
A comma separated list of team role competence ids to filter on
-
(optional)string
A comma separated list of work value competence ids
-
(optional)integer
Format - int32. The offset used for pagination
-
(optional)integer
Format - int32. The number of records to return. Standard set to 100
-
(optional)string
The fields to order by, comma separated
-
(optional)string
The search string that is used to search on name and email. Partial matches are allowed.
Request headers
-
stringOAuth 2.0 access token obtained from Kazi User login authorisatie. Supported grant types: Authorization code.
Request body
Responses
200 OK
Returns a list of users linked to the specified partner
Representations
[
{
"id": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"ssoUserId": "string",
"displayName": "string",
"active": true,
"createdOn": "string",
"phone": "string",
"nationality": "string",
"atsClientId": "string",
"createdByClientId": "string",
"clusterIds": [
"string"
],
"domainIds": [
"string"
],
"schoolIds": [
"string"
],
"competences": [
{
"competenceId": "string",
"score": 0.0,
"outDated": true,
"rank": 0
}
]
}
]
{
"uniqueItems": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"externalId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"ssoUserId": {
"type": "string"
},
"displayName": {
"type": "string"
},
"active": {
"type": "boolean"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"phone": {
"type": "string"
},
"nationality": {
"type": "string"
},
"atsClientId": {
"format": "uuid",
"type": "string"
},
"createdByClientId": {
"format": "uuid",
"type": "string"
},
"clusterIds": {
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"domainIds": {
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"schoolIds": {
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"competences": {
"uniqueItems": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"competenceId": {
"format": "uuid",
"type": "string"
},
"score": {
"format": "double",
"type": "number"
},
"outDated": {
"type": "boolean"
},
"rank": {
"format": "int32",
"type": "integer"
}
}
}
}
}
}
}
400 Bad Request
Bad Request
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://kazi-dev.azure-api.net/identifying/partners/{partnerId}/users?externalId={string}&competences={boolean}&includeCompetences={boolean}&atsClientId={string}&teamRoleIds={string}&workValueIds={string}&offset=0&count=100&sort={string}&search={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"
--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}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
// Request parameters
queryString["externalId"] = "{string}";
queryString["competences"] = "{boolean}";
queryString["includeCompetences"] = "{boolean}";
queryString["atsClientId"] = "{string}";
queryString["teamRoleIds"] = "{string}";
queryString["workValueIds"] = "{string}";
queryString["offset"] = "0";
queryString["count"] = "100";
queryString["sort"] = "{string}";
queryString["search"] = "{string}";
var uri = "https://kazi-dev.azure-api.net/identifying/partners/{partnerId}/users?" + 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://kazi-dev.azure-api.net/identifying/partners/{partnerId}/users");
builder.setParameter("externalId", "{string}");
builder.setParameter("competences", "{boolean}");
builder.setParameter("includeCompetences", "{boolean}");
builder.setParameter("atsClientId", "{string}");
builder.setParameter("teamRoleIds", "{string}");
builder.setParameter("workValueIds", "{string}");
builder.setParameter("offset", "0");
builder.setParameter("count", "100");
builder.setParameter("sort", "{string}");
builder.setParameter("search", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// 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
"externalId": "{string}",
"competences": "{boolean}",
"includeCompetences": "{boolean}",
"atsClientId": "{string}",
"teamRoleIds": "{string}",
"workValueIds": "{string}",
"offset": "0",
"count": "100",
"sort": "{string}",
"search": "{string}",
};
$.ajax({
url: "https://kazi-dev.azure-api.net/identifying/partners/{partnerId}/users?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
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://kazi-dev.azure-api.net/identifying/partners/{partnerId}/users";
NSArray* array = @[
// Request parameters
@"entities=true",
@"externalId={string}",
@"competences={boolean}",
@"includeCompetences={boolean}",
@"atsClientId={string}",
@"teamRoleIds={string}",
@"workValueIds={string}",
@"offset=0",
@"count=100",
@"sort={string}",
@"search={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 setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// 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://kazi-dev.azure-api.net/identifying/partners/{partnerId}/users');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'externalId' => '{string}',
'competences' => '{boolean}',
'includeCompetences' => '{boolean}',
'atsClientId' => '{string}',
'teamRoleIds' => '{string}',
'workValueIds' => '{string}',
'offset' => '0',
'count' => '100',
'sort' => '{string}',
'search' => '{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}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
# Request parameters
'externalId': '{string}',
'competences': '{boolean}',
'includeCompetences': '{boolean}',
'atsClientId': '{string}',
'teamRoleIds': '{string}',
'workValueIds': '{string}',
'offset': '0',
'count': '100',
'sort': '{string}',
'search': '{string}',
})
try:
conn = httplib.HTTPSConnection('kazi-dev.azure-api.net')
conn.request("GET", "/identifying/partners/{partnerId}/users?%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}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'externalId': '{string}',
'competences': '{boolean}',
'includeCompetences': '{boolean}',
'atsClientId': '{string}',
'teamRoleIds': '{string}',
'workValueIds': '{string}',
'offset': '0',
'count': '100',
'sort': '{string}',
'search': '{string}',
})
try:
conn = http.client.HTTPSConnection('kazi-dev.azure-api.net')
conn.request("GET", "/identifying/partners/{partnerId}/users?%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://kazi-dev.azure-api.net/identifying/partners/{partnerId}/users')
query = URI.encode_www_form({
# Request parameters
'externalId' => '{string}',
'competences' => '{boolean}',
'includeCompetences' => '{boolean}',
'atsClientId' => '{string}',
'teamRoleIds' => '{string}',
'workValueIds' => '{string}',
'offset' => '0',
'count' => '100',
'sort' => '{string}',
'search' => '{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 headers
request['Authorization'] = '{access token}'
# 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