- SECTIONS
Overview
Manage users, groups, products, and other FactSet resources.
Adheres to the following SCIM RFC documents:
Authentication methods for the API include FactSet's API key system as well as OAuth 2.0. OAuth SDKs are available here.
Please note that the API tries to service all requests within a reasonable time frame but should a request take longer than expected, an HTTP 500 response advising the client to check the resource later may be returned.
Please note that the Try it out features do not function. You must authenticate against the API and make requests directly against the endpoints.
API Definition
API Documentation
- Procure-To-Pay-SCIM.pdf869.46 KB
Code Snippet
/*
* Create a FactSet core user using the RestSharp library.
*/
var client = new RestClient("https://api.factset.com/scim/v2/Users");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic API_KEY"); // TODO Replace API_KEY with your Base64-encoded FactSet API key
var body = @"
{
""schemas"": [
""urn:ietf:params:scim:schemas:core:2.0:User"",
""urn:scim:schemas:extension:FactSet:Core:1.0:User""
],
""externalId"": ""71040123-085B-4FC5-B311-FD5E30DE083F"",
""name"": {
""familyName"": ""John"",
""givenName"": ""Doe""
},
""email"": ""JohnDoe@domain.com"",
""urn:scim:schemas:extension:FactSet:Core:1.0:User"": {
""username"": ""FDS_P2P_API"",
""location"": {
""value"": ""1598276""
},
""roleName"": ""Wealth Manager"",
""assertionValue"": ""JDOE999""
}
}
";
request.AddParameter("application/scim+json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
/*
* Add products to a FactSet core user using the RestSharp library.
*/
var client = new RestClient("https://api.factset.com/scim/v2/Users/FDS_P2P_API-1353966");
client.Timeout = -1;
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Basic API_KEY"); // TODO Replace API_KEY with your Base64-encoded FactSet API key
var body = @"
{
""schemas"": [
""urn:ietf:params:scim:api:messages:2.0:PatchOp""
],
""Operations"": [
{
""op"": ""add"",
""path"": ""urn:scim:schemas:extension:FactSet:Core:1.0:User:products"",
""value"": [
{
""value"": ""5457""
},
{
""value"": ""7167""
},
]
}
]
}
";
request.AddParameter("application/scim+json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
/*
* Remove product from a FactSet core user using the RestSharp library.
*/
var client = new RestClient("https://api.factset.com/scim/v2/Users/FDS_P2P_API-1353966");
client.Timeout = -1;
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Basic API_KEY"); // TODO Replace API_KEY with your Base64-encoded FactSet API key
var body = @"
{
""schemas"": [
""urn:ietf:params:scim:api:messages:2.0:PatchOp""
],
""Operations"": [
{
""op"": ""remove"",
""path"": ""urn:scim:schemas:extension:FactSet:Core:1.0:User:products[value eq \""5457\""]""
}
]
}
";
request.AddParameter("application/scim+json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
Changelog
v.2022-02-01
Summary
* Initial Release 2022-02-01
v.2022-04-21:
Summary
* Released 2022-04-21
Functionality Additions
* Added File Manager Audit Endpoint
v.2022-05-13:
Summary
* Released 2022-05-13
Functionality Additions
* Added White label parameter for Products schema
v.2023-02-16:
Summary
* Released 2023-02-16
Changes
* Moved the /VermilionUsers endpoint into FactSet:VRS:1.0:User Schema
* Moved the /VermilionGroups endpoint into FactSet:VRS:1.0:Group Schema
V2023-05-05:
Summary
* Released 2023-05-05
Functionality Additions
* Orderable” parameter added to FactSet:Core:1.0:Product schema
V2023-05-05:
Summary
* Released 2023-05-05
Functionality Additions
* Added /POST Locations endpoint
* Addition of firmDescription, usernames, managedLocations, managingLocations, emailDomains, partnerAssertedEntityId and CompanyAgreementsURLs to locations schema
* Addition of UserTaxonomyData and royaltyClass to FactSet user schema
* Addition of /FirmDescriptions, /UserClasses, /UserPositions resources and endpoints
V2024-08-04:
Summary
* Released 2024-08-04
Functionality Additions
* Added FactSet:Core:1.0:Federation schema and accompanying endpoints
Changes
* “assertionValue” as a discrete user attribute deprecated in favor of Federation Schema