ForeSee Developer Portal

Everything you need to set up and optimize your ForeSee product. Home of developer documentation, implementation guides, and question/answer forums.

Blueprint

Client Credentials Grant

 

This is the API endpoint for obtaining an access token to the ForeSee API.

Read an overview of the API at this link.

Token Endpoint

 
posthttps://api.foresee.com/v1/token
curl --request POST \
  --url 'https://api.foresee.com/v1/token?scope=r_cx_basic&grant_type=client_credentials' \
  --header 'authorization: Basic akhGY0VGN3h4UzRnU1pTNjZ0aldCcTFzblh6UzA4dDg6aGsyQmF2YmJZQ0xpMTNscE5hUXk=' \
  --header 'content-type: application/json'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.foresee.com/v1/token',
  qs: 
   { scope: 'r_cx_basic',
     grant_type: 'client_credentials' },
  headers: 
   { authorization: 'Basic akhGY0VGN3h4UzRnU1pTNjZ0aldCcTFzblh6UzA4dDg6aGsyQmF2YmJZQ0xpMTNscE5hUXk=',
     'content-type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.foresee.com/v1/token?scope=r_cx_basic&grant_type=client_credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'Basic akhGY0VGN3h4UzRnU1pTNjZ0aldCcTFzblh6UzA4dDg6aGsyQmF2YmJZQ0xpMTNscE5hUXk='

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.foresee.com/v1/token?scope=r_cx_basic&grant_type=client_credentials");
xhr.setRequestHeader("content-type", "application/json");
xhr.setRequestHeader("authorization", "Basic akhGY0VGN3h4UzRnU1pTNjZ0aldCcTFzblh6UzA4dDg6aGsyQmF2YmJZQ0xpMTNscE5hUXk=");

xhr.send(data);
import requests

url = "https://api.foresee.com/v1/token"

querystring = {"scope":"r_cx_basic","grant_type":"client_credentials"}

headers = {
    'content-type': "application/json",
    'authorization': "Basic akhGY0VGN3h4UzRnU1pTNjZ0aldCcTFzblh6UzA4dDg6aGsyQmF2YmJZQ0xpMTNscE5hUXk="
    }

response = requests.request("POST", url, headers=headers, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

scope
string
required

The scope for authorization request

grant_type
string
required

The grant type of authorization request

Headers

Content-Type
string
required

The media type of the body of the request

Authorization
string
required

HTTP basic authentication credentials

Response

Successful response

access_tokenstring

The access token is used by the client to make authenticated requests.

token_typestring

Representation of how the access token will be generated and presented for resource access calls.

expires_instring

The number of seconds left in the life time of the access token.

scopestring

Limitation of the authorization granted.

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an encoded client credentials provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Consumption

 

Here are the data consumption APIs

Measures List

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.foresee.com/v1/measures
curl --request GET \
  --url https://api.foresee.com/v1/measures \
  --header 'accept: application/json'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.foresee.com/v1/measures',
  headers: { accept: 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.foresee.com/v1/measures")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.foresee.com/v1/measures");
xhr.setRequestHeader("accept", "application/json");

xhr.send(data);
import requests

url = "https://api.foresee.com/v1/measures"

headers = {'accept': 'application/json'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Headers

Accept
string
required

Content-Types that are acceptable for the response

Response

Successful response

hasMoreboolean

indicates if there are more responses to be obtained for items array

linksarray
itemsarray

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Measure Definition

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.foresee.com/v1/measures/measurementKey/definition
curl --request GET \
  --url https://api.foresee.com/v1/measures/measurementKey/definition \
  --header 'accept: application/json'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.foresee.com/v1/measures/measurementKey/definition',
  headers: { accept: 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.foresee.com/v1/measures/measurementKey/definition")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.foresee.com/v1/measures/measurementKey/definition");
xhr.setRequestHeader("accept", "application/json");

xhr.send(data);
import requests

url = "https://api.foresee.com/v1/measures/measurementKey/definition"

headers = {'accept': 'application/json'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

measurementKey
int32
required

The measurement key for the measure

Query Params

excludeQuestions
boolean

Allows excluding questions

excludeAnswers
boolean

Allows excluding answers

Headers

Accept
string
required

Content-Types that are acceptable for the response

Response

Successful response

linksarray
CQarray
CPParray
EPParray
MQobject

List of measured questions

MQ.latentsarray

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There was no resource found for the specified identifier

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Measure Data

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.foresee.com/v1/measures/measurementKey/data
curl --request GET \
  --url 'https://api.foresee.com/v1/measures/measurementKey/data?from=from&to=to' \
  --header 'accept: application/json'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.foresee.com/v1/measures/measurementKey/data',
  qs: 
   { from: 'from',
     to: 'to' },
  headers: { accept: 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.foresee.com/v1/measures/measurementKey/data?from=from&to=to")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.foresee.com/v1/measures/measurementKey/data?from=from&to=to");
xhr.setRequestHeader("accept", "application/json");

xhr.send(data);
import requests

url = "https://api.foresee.com/v1/measures/measurementKey/data"

querystring = {"from":"from","to":"to"}

headers = {'accept': 'application/json'}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

measurementKey
int32
required

The measurement key for the measure

Query Params

from
date
required

The start date for the query. Should be in YYYY-MM-DD format

to
date
required

The end date for the query. Should be in YYYY-MM-DD format

excludeResponseDetails
boolean

Allows excluding details of questions and answers for every respondent

excludeMQ
boolean

Allows excluding measured questions

excludeCQ
boolean

Allows excluding custom questions

excludePassedParams
boolean

Allows excluding CPPs and EPPs

excludeLatentScores
boolean

Allows excluding latent scores from respondent detail as well as from the summary

offset
integer

0 based integer that indicates the page number

limit
integer

1 based integer that indicates the page size. Max allowed is 100

Headers

Accept
string
required

Content-Types that are acceptable for the response

Response

Successful response

hasMoreboolean

Indicates if there are additional respondents to be queried for. Applicable during paging

itemsarray

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There was no resource found for the specified identifier

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

SCIM

 

Obtain available SCIM specification features

An HTTP GET to this endpoint will return a JSON structure that describes the SCIM specification features available on a service provider

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
get/ServiceProviderConfig
curl --request GET \
  --url http://example.com/ServiceProviderConfig \
  --header 'accept: Accept'
var request = require("request");

var options = { method: 'GET',
  url: 'http://example.com/ServiceProviderConfig',
  headers: { accept: 'Accept' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/ServiceProviderConfig")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["accept"] = 'Accept'

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/ServiceProviderConfig");
xhr.setRequestHeader("accept", "Accept");

xhr.send(data);
import requests

url = "http://example.com/ServiceProviderConfig"

headers = {'accept': 'Accept'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Headers

Accept
string
required

The content type to pass

Response

schemasarray
authenticationSchemesarray
documentationUristring

An HTTP-addressable URL pointing to the service provider's human-consumable help documentation

patchobject
patch.supportedboolean
changePasswordobject
changePassword.supportedboolean
bulkobject
bulk.supportedboolean
bulk.maxOperationsinteger
bulk.maxPayloadSizeinteger
filterobject
filter.supportedboolean
filter.maxResultsinteger

An integer value specifying the maximum number of resources

sortobject
sort.supportedboolean
etagobject
etag.supportedboolean

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Obtain types of SCIM resources available

An HTTP GET to this endpoint is used to discover the types of resources available on a SCIM service provider (e.g., Users and Groups). Each resource type defines the endpoints, the core schema URI that defines the resource, and any supported schema extensions.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
getexample.com/ResourceTypes
curl --request GET \
  --url http://example.com/ResourceTypes \
  --header 'accept: Accept'
var request = require("request");

var options = { method: 'GET',
  url: 'http://example.com/ResourceTypes',
  headers: { accept: 'Accept' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/ResourceTypes")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["accept"] = 'Accept'

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/ResourceTypes");
xhr.setRequestHeader("accept", "Accept");

xhr.send(data);
import requests

url = "http://example.com/ResourceTypes"

headers = {'accept': 'Accept'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Headers

Accept
string
required

The content type to pass

Response

schemasarray
idstring

The resource type's server unique id. This is often the same value as the 'name' attribute

namestring

The resource type name

descriptionstring

The resource type's human-readable description

endpointstring

The resource type's HTTP-addressable endpoint relative to the Base URL of the service provider

schemaExtensionsarray

A list of URIs of the resource type's schema extensions

schemastring

The resource type's primary/base schema URI

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Obtain supported SCIM resource schemas

An HTTP GET to this endpoint is used to retrieve information about resource schemas supported by a SCIM service provider

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
getexample.com/Schemas
curl --request GET \
  --url http://example.com/Schemas \
  --header 'accept: Accept'
var request = require("request");

var options = { method: 'GET',
  url: 'http://example.com/Schemas',
  headers: { accept: 'Accept' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/Schemas")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["accept"] = 'Accept'

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/Schemas");
xhr.setRequestHeader("accept", "Accept");

xhr.send(data);
import requests

url = "http://example.com/Schemas"

headers = {'accept': 'Accept'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Headers

Accept
string
required

The content type to pass

Response

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

/Users/.search

Search users based on search criteria in body

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
postexample.com/Users/.search
curl --request POST \
  --url http://example.com/Users/.search
var request = require("request");

var options = { method: 'POST', url: 'http://example.com/Users/.search' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/Users/.search")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://example.com/Users/.search");

xhr.send(data);
import requests

url = "http://example.com/Users/.search"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

schemas
array of objects
filter
string

The filter string used to request a subset of resources. The filter string MUST be a valid filter (Section 3.4.2.2) expression

sortBy
string

A string indicating the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation

startIndex
integer

An integer indicating the 1-based index of the first query result.

count
integer

An integer indicating the desired maximum number of query results per page.

Response

ListResponse object containing resource list along with meta-data

schemasarray
totalResultsinteger

The total number of results returned by the list or query operation. The value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available

startIndexinteger

The 1-based index of the first result in the current set of list results

itemsPerPageinteger

The number of resources returned in a list response page

resourcesarray

A multi-valued list of complex objects containing the requested resources

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

/Users

Search for users according to supported parameters

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
getexample.com/Users
curl --request GET \
  --url http://example.com/Users
var request = require("request");

var options = { method: 'GET', url: 'http://example.com/Users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/Users")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/Users");

xhr.send(data);
import requests

url = "http://example.com/Users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

filter
string

Clients MAY request a subset of resources by specifying this query parameter containing a filter expression. When specified, only those resources matching the filter expression SHALL be returned. The expression language that is used with the filter parameter supports references to attributes and literals.Attribute names and attribute operators used in filters are case insensitive.We will support the search on userName using eq operator, name.givenName and name.familyName using co,sw and ew operators. For multiple expressions only and is supported. For more details on operators refer to https://tools.ietf.org/html/rfc7644#section-3.4.2.2

count
integer

Non-negative integer. Specifies the desired maximum number of query results per page, e.g.10. A negative value SHALL be interpreted as 0. A value of 0 indicates that no resource are to be returned except for totalResults

startIndex
integer

The 1-based index of the first result in the current set of list results

Response

ListResponse object containing resource list along with meta-data

schemasarray
totalResultsinteger

The total number of results returned by the list or query operation. The value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available

startIndexinteger

The 1-based index of the first result in the current set of list results

itemsPerPageinteger

The number of resources returned in a list response page

resourcesarray

A multi-valued list of complex objects containing the requested resources

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

/Users

Create a new user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
postexample.com/Users
curl --request POST \
  --url http://example.com/Users
var request = require("request");

var options = { method: 'POST', url: 'http://example.com/Users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/Users")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://example.com/Users");

xhr.send(data);
import requests

url = "http://example.com/Users"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

schemas
array of strings
required
id
integer

Unique identifier for a user in the Foresee system

userName
string
required
externalId
string

Customers can pass us their unique identifier if needed

active
boolean

Used to indicate whether this user is Active or Suspended. De provisioning will be performed by marking active as false

name
object
required
 
name.givenName
string

This would typically be the first name

name.familyName
string

This would typically be the last name

emails
array of objects
required
value
type
primary
phoneNumbers
array of objects
value
type
urn:ietf:params:scim:schemas:extension:foresee:1.0:User
object
 
urn:ietf:params:scim:schemas:extension:foresee:1.0:User.clientId
integer

Unique internal identifier for customer of Foresee

urn:ietf:params:scim:schemas:extension:foresee:1.0:User.authenticationProvider
string

Unique internal identifier for customer of Foresee

meta
object
required
 
meta.resourceType
string
meta.created
date
meta.lastModified
date
meta.version
string
meta.location
string

Response

OK

schemasarray
idnumber

Unique identifier for a user in the Foresee system

userNamestring
externalIdstring

Customers can pass us their unique identifier if needed

activeboolean

Used to indicate whether this user is Active or Suspended. De provisioning will be performed by marking active as false

nameobject
name.givenNamestring

This would typically be the first name

name.familyNamestring

This would typically be the last name

emailsarray
phoneNumbersarray
urn:ietf:params:scim:schemas:extension:foresee:1.0:Userobject
urn:ietf:params:scim:schemas:extension:foresee:1.0:User.clientIdinteger

Unique internal identifier for customer of Foresee

urn:ietf:params:scim:schemas:extension:foresee:1.0:User.authenticationProviderstring

Unique internal identifier for customer of Foresee

metaobject
meta.resourceTypestring
meta.createdstring
meta.lastModifiedstring
meta.versionstring
meta.locationstring

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

/Users/{id}

Get a user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
getexample.com/Users/id
curl --request GET \
  --url http://example.com/Users/id
var request = require("request");

var options = { method: 'GET',
  url: 'http://example.com/Users/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/Users/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/Users/id");

xhr.send(data);
import requests

url = "http://example.com/Users/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

id
string
required

The unique identifier for a resource corresponding to the external id. When external id is not present you can supply the internal Foresee id

Response

User profile related to a user id

schemasarray
idnumber

Unique identifier for a user in the Foresee system

userNamestring
externalIdstring

Customers can pass us their unique identifier if needed

activeboolean

Used to indicate whether this user is Active or Suspended. De provisioning will be performed by marking active as false

nameobject
name.givenNamestring

This would typically be the first name

name.familyNamestring

This would typically be the last name

emailsarray
phoneNumbersarray
urn:ietf:params:scim:schemas:extension:foresee:1.0:Userobject
urn:ietf:params:scim:schemas:extension:foresee:1.0:User.clientIdinteger

Unique internal identifier for customer of Foresee

urn:ietf:params:scim:schemas:extension:foresee:1.0:User.authenticationProviderstring

Unique internal identifier for customer of Foresee

metaobject
meta.resourceTypestring
meta.createdstring
meta.lastModifiedstring
meta.versionstring
meta.locationstring

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

/Users/{id}

Support patch operations

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
patchexample.com/Users/id
curl --request PATCH \
  --url http://example.com/Users/id
var request = require("request");

var options = { method: 'PATCH',
  url: 'http://example.com/Users/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/Users/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "http://example.com/Users/id");

xhr.send(data);
import requests

url = "http://example.com/Users/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

id
string
required

The unique identifier for a resource corresponding to the external id. When external id is not present you can supply the internal Foresee id

Body Params

schemas
array of strings
operations
array of objects
op
path
value 

Response

OK

schemasarray
idnumber

Unique identifier for a user in the Foresee system

userNamestring
externalIdstring

Customers can pass us their unique identifier if needed

activeboolean

Used to indicate whether this user is Active or Suspended. De provisioning will be performed by marking active as false

nameobject
name.givenNamestring

This would typically be the first name

name.familyNamestring

This would typically be the last name

emailsarray
phoneNumbersarray
urn:ietf:params:scim:schemas:extension:foresee:1.0:Userobject
urn:ietf:params:scim:schemas:extension:foresee:1.0:User.clientIdinteger

Unique internal identifier for customer of Foresee

urn:ietf:params:scim:schemas:extension:foresee:1.0:User.authenticationProviderstring

Unique internal identifier for customer of Foresee

metaobject
meta.resourceTypestring
meta.createdstring
meta.lastModifiedstring
meta.versionstring
meta.locationstring

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

/Users/{id}

Update a user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
putexample.com/Users/id
curl --request PUT \
  --url http://example.com/Users/id
var request = require("request");

var options = { method: 'PUT',
  url: 'http://example.com/Users/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/Users/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "http://example.com/Users/id");

xhr.send(data);
import requests

url = "http://example.com/Users/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

id
string
required

The unique identifier for a resource corresponding to the external id. When external id is not present you can supply the internal Foresee id

Body Params

schemas
array of strings
required
id
integer

Unique identifier for a user in the Foresee system

userName
string
required
externalId
string

Customers can pass us their unique identifier if needed

active
boolean

Used to indicate whether this user is Active or Suspended. De provisioning will be performed by marking active as false

name
object
required
 
name.givenName
string

This would typically be the first name

name.familyName
string

This would typically be the last name

emails
array of objects
required
value
type
primary
phoneNumbers
array of objects
value
type
urn:ietf:params:scim:schemas:extension:foresee:1.0:User
object
 
urn:ietf:params:scim:schemas:extension:foresee:1.0:User.clientId
integer

Unique internal identifier for customer of Foresee

urn:ietf:params:scim:schemas:extension:foresee:1.0:User.authenticationProvider
string

Unique internal identifier for customer of Foresee

meta
object
required
 
meta.resourceType
string
meta.created
date
meta.lastModified
date
meta.version
string
meta.location
string

Response

OK

schemasarray
idnumber

Unique identifier for a user in the Foresee system

userNamestring
externalIdstring

Customers can pass us their unique identifier if needed

activeboolean

Used to indicate whether this user is Active or Suspended. De provisioning will be performed by marking active as false

nameobject
name.givenNamestring

This would typically be the first name

name.familyNamestring

This would typically be the last name

emailsarray
phoneNumbersarray
urn:ietf:params:scim:schemas:extension:foresee:1.0:Userobject
urn:ietf:params:scim:schemas:extension:foresee:1.0:User.clientIdinteger

Unique internal identifier for customer of Foresee

urn:ietf:params:scim:schemas:extension:foresee:1.0:User.authenticationProviderstring

Unique internal identifier for customer of Foresee

metaobject
meta.resourceTypestring
meta.createdstring
meta.lastModifiedstring
meta.versionstring
meta.locationstring

Bad request - one or more request parameters or payload attributes is not valid

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

There is either not an Oauth2 token provided or it is provided incorrectly or what is provided is invalid or expired. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller does not have access to the requested API resource either by way of scopes or more fine grained access control violations. Examine the details for more information

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The content type supplied in Accepts is not an acceptable content type

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

Caller exceeded the throttling limits set for the API and / or the account

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured on the server. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

The service is unavailable. Caller is requested to refer to maintenance notifications or contact support

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors

An unexpected error occured downstream. Caller is requested to retry

timestampstring

The timestamp of the error

statusnumber

This will be an HTTP Status Code will correspond to the HTTP status code in response header

messagestring

The exact error message shown

errorCodestring

This could be an error code that can help uniquely identify the issue

detailedErrorsarray

An array of additional messages that describe the error. Will be only populated when there is a need E.g. for bad data errors