SCIM API
API change historySCIM V2 API implemented by WorkSpan
Request
Request URL
Request headers
-
string
Format: bearer $
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "scim_user@test.com",
"name": {
"givenName": "scim user",
"familyName": "scim family"
},
"emails": [
{
"primary": true,
"value": "scim_user@test.com",
"type": "work"
}
],
"displayName": "scim_user_display_name",
"meta": {
"resourceType": "User"
},
"active": true,
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "Sales"
}
}
{
"type": "object",
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"enum": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
},
"example": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
},
"userName": {
"type": "string",
"example": "scim_user@test.com"
},
"name": {
"type": "object",
"properties": {
"givenName": {
"type": "string",
"example": "scim user"
},
"familyName": {
"type": "string",
"example": "scim family"
}
}
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"primary": {
"type": "boolean",
"example": true
},
"value": {
"type": "string",
"example": "scim_user@test.com"
},
"type": {
"type": "string",
"example": "work"
}
}
}
},
"displayName": {
"type": "string",
"example": "scim_user_display_name"
},
"meta": {
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"example": "User"
}
}
},
"active": {
"type": "boolean",
"example": true
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"type": "object",
"properties": {
"department": {
"type": "string",
"example": "Sales"
}
}
}
}
}
Responses
201 Created
Created
Representations
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "scim_user@test.com",
"name": {
"givenName": "scim user",
"familyName": "scim family"
},
"emails": [
{
"primary": true,
"value": "scim_user@test.com",
"type": "work"
}
],
"displayName": "scim_user_display_name",
"meta": {
"resourceType": "User"
},
"id": "Ws-Person_workspan_generated_id",
"active": true,
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "Sales"
}
}
{
"type": "object",
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"enum": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
},
"example": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
},
"userName": {
"type": "string",
"example": "scim_user@test.com"
},
"name": {
"type": "object",
"properties": {
"givenName": {
"type": "string",
"example": "scim user"
},
"familyName": {
"type": "string",
"example": "scim family"
}
}
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"primary": {
"type": "boolean",
"example": true
},
"value": {
"type": "string",
"example": "scim_user@test.com"
},
"type": {
"type": "string",
"example": "work"
}
}
}
},
"displayName": {
"type": "string",
"example": "scim_user_display_name"
},
"meta": {
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"example": "User"
}
}
},
"id": {
"type": "string",
"example": "Ws-Person_workspan_generated_id"
},
"active": {
"type": "boolean",
"example": true
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"type": "object",
"properties": {
"department": {
"type": "string",
"example": "Sales"
}
}
}
}
}
400 Bad Request
Bad Request
Representations
401 Unauthorized
Authorization Error
Representations
403 Forbidden
permissions denied
Representations
404 Not Found
WorkSpan object not found
Representations
500 Internal Server Error
Internal Server Error
Representations
Code samples
@ECHO OFF
curl -v -X POST "https://api-sandbox.workspan.com/api/scim/v2/Users"
-H "Authorization: "
-H "Content-Type: application/json"
--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-sandbox.workspan.com/api/scim/v2/Users?" + 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://api-sandbox.workspan.com/api/scim/v2/Users");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Authorization", "");
request.setHeader("Content-Type", "application/json");
// 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-sandbox.workspan.com/api/scim/v2/Users?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Content-Type","application/json");
},
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://api-sandbox.workspan.com/api/scim/v2/Users";
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:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
// 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-sandbox.workspan.com/api/scim/v2/Users');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Content-Type' => 'application/json',
);
$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
'Authorization': '',
'Content-Type': 'application/json',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api-sandbox.workspan.com')
conn.request("POST", "/api/scim/v2/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
'Authorization': '',
'Content-Type': 'application/json',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api-sandbox.workspan.com')
conn.request("POST", "/api/scim/v2/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://api-sandbox.workspan.com/api/scim/v2/Users')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# 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