SCIM Provisioning with AD
API change historyThis API allows Safefood 360 SCIM endpoint provisioning with Azure Active Directory.
| URL | https://api.safefood360.com/scim |
| Methods supported | GET,POST,PUT,PATCH,DELETE |
| Operations |
ServiceProviderConfig: Returns ServiceProviderConfig Schemas: Returns Schemas Schemas/{Name}: Returns Schemas by Name or Id ResourceTypes: Returns ResourceTypes ResourceTypes/{Name}: Returns details on a specific ResourceTypes Groups: Returns a list of Roles Groups: Returns a list of Roles based on filters Groups/{Id}: Returns details on a specific Role Groups: Add / Match the existing role Groups/{Id}: Updates an existing Role Groups/{Id}: Updates an existing Role by Patch operation Users: Returns a list of Users Users: Add User Users/{Id}: Returns details on a specific User Users/{Id}: Updates an existing User Users/{Id}: Updates an existing User by Patch operation Users/{Id}: Delete an existing User |
Schemas/{Name}
Returns a JSON structure that contains information about resource schemas supported by the SCIM service provider and any supported schema extensions.
Try itRequest
Request URL
Request parameters
-
String
The unique identifier for Schemas – specified as a string following the endpoint name e.g. /Group or /User
Request headers
-
string
Authorization
Request body
Responses
200 OK
Representations
{
"name": "Group",
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"description": "Group",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"attributes": [
{
"referenceTypes": [],
"name": "displayName",
"type": "string",
"multiValued": false,
"description": "A human-readable name for the Group.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"referenceTypes": [],
"subAttributes": [
{
"referenceTypes": [],
"name": "value",
"type": "string",
"multiValued": false,
"description": "Identifier of the member of this Group.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
},
{
"referenceTypes": [],
"name": "display",
"type": "string",
"multiValued": false,
"description": "The name of the User.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
},
{
"referenceTypes": [
"Group",
"User"
],
"name": "$ref",
"type": "reference",
"multiValued": false,
"description": "The URI corresponding to a SCIM resource that is a member of this Group.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
},
{
"referenceTypes": [],
"name": "type",
"type": "string",
"multiValued": false,
"description": "A label indicating the type of resource, e.g., 'User' or 'Group'.",
"required": false,
"canonicalValues": [
"User",
"Group"
],
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
}
],
"name": "members",
"type": "complex",
"multiValued": true,
"description": "A list of members of the Group.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
}
],
"meta": {
"created": "2018-10-30T14:18:38.6727836Z",
"lastModified": "2018-10-30T14:18:38.6727836Z",
"location": "https://api.safefood360.com/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group",
"resourceType": "Schema"
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.safefood360.com/scim/Schemas/{Name}"
-H "Authorization: "
--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("Authorization", "");
var uri = "https://api.safefood360.com/scim/Schemas/{Name}?" + 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://api.safefood360.com/scim/Schemas/{Name}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "");
// 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://api.safefood360.com/scim/Schemas/{Name}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
},
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://api.safefood360.com/scim/Schemas/{Name}";
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:@"GET"];
// Request headers
[_request setValue:@"" 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://api.safefood360.com/scim/Schemas/{Name}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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
'Authorization': '',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.safefood360.com')
conn.request("GET", "/scim/Schemas/{Name}?%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
'Authorization': '',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.safefood360.com')
conn.request("GET", "/scim/Schemas/{Name}?%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://api.safefood360.com/scim/Schemas/{Name}')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# 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