@factset/sdk-procuretopayapiscim
v0.23.2
Published
Procure to Pay API: SCIM client library for JavaScript
Downloads
23
Readme
Procure to Pay API: SCIM client library for JavaScript
FactSet's SCIM API implementation.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 2.6.0
- SDK version: 0.23.2
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- Node.js >= 18
Installation
npm
npm install @factset/sdk-utils @factset/[email protected]yarn
yarn add @factset/sdk-utils @factset/[email protected]Usage
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=18. If you're using nvm:
nvm install 18 nvm use 18(optional) Install yarn.
- Install dependencies.
- Run the following:
[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
const { ApiClient, FederationsApi } = require('@factset/sdk-procuretopayapiscim');
const { ConfidentialClient } = require('@factset/sdk-utils');
const apiClient = ApiClient.instance;
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');
// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';
const apiInstance = new FederationsApi();
const id = "id_example"; // String | ID of resource.
const opts = {
'attributes': ["null"], // [String] | Attribute whitelist filter string. A comma-separated list of resource attribute names to be returned in the response, overriding the set of attributes that would be returned by default. Attribute names must be specified in standard attribute notation (see [RFC 7644 section 3.10](https://datatracker.ietf.org/doc/html/rfc7644#section-3.10).) This parameter cannot be used with the *excludedAttributes* or *additionalAttributes* parameters.
'excludedAttributes': ["null"], // [String] | Attribute blacklist filter string. A comma-separated list of resource attribute names to be excluded in the response, overriding the set of attributes that would be returned by default. Attribute names must be specified in standard attribute notation (see [RFC 7644 section 3.10](https://datatracker.ietf.org/doc/html/rfc7644#section-3.10).) This parameter cannot be used with the *attributes* or *additionalAttributes* parameters.
'additionalAttributes': ["null"] // [String] | Non-standard attribute filter string. A comma-separated list of resource attribute names to be included in the response, complementing the set of attributes that would be returned by default. Attribute names must be specified in standard attribute notation (see [RFC 7644 section 3.10](https://datatracker.ietf.org/doc/html/rfc7644#section-3.10).) This parameter cannot be used with the *attributes* or *excludedAttributes* parameters.
};
// Call api endpoint
apiInstance.getFederation(id, opts).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
Using a Proxy
To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:
const { ApiClient } = require('@factset/sdk-procuretopayapiscim');
const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');Documentation for API Endpoints
All URIs are relative to https://api.factset.com/scim/v2
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- procuretopayapiscim.FederationsApi | getFederation | GET /Federations/{id} | Get a federation. procuretopayapiscim.FederationsApi | getFederations | GET /Federations | Get a list of federations. procuretopayapiscim.FederationsApi | modifyFederation | PATCH /Federations/{id} | Patch a federation. procuretopayapiscim.FederationsApi | replaceFederation | PUT /Federations/{id} | Replace a federation. procuretopayapiscim.FileManagerAuditApi | getFileManagerAudit | GET /FileManagerAudit | Get File Manager audit data. procuretopayapiscim.FirmDescriptionsApi | getFirmDescription | GET /FirmDescriptions/{id} | Get a firm description. procuretopayapiscim.FirmDescriptionsApi | getFirmDescriptions | GET /FirmDescriptions | Get a list of firm descriptions. procuretopayapiscim.GroupsApi | getGroup | GET /Group/{id} | Get a group. procuretopayapiscim.GroupsApi | getGroups | GET /Groups | Get a list of groups. procuretopayapiscim.GroupsApi | modifyGroup | PATCH /Group/{id} | Patch a group. procuretopayapiscim.GroupsApi | replaceGroup | PUT /Group/{id} | Replace a group. procuretopayapiscim.LocationsApi | createLocation | POST /Locations | Create a location. procuretopayapiscim.LocationsApi | getLocation | GET /Locations/{id} | Get a location. procuretopayapiscim.LocationsApi | getLocations | GET /Locations | Get a list of locations. procuretopayapiscim.LocationsApi | modifyLocation | PATCH /Locations/{id} | Patch a location. procuretopayapiscim.LocationsApi | replaceLocation | PUT /Locations/{id} | Replace a location. procuretopayapiscim.ProductsApi | getProduct | GET /Products/{id} | Get a product. procuretopayapiscim.ProductsApi | getProducts | GET /Products | Get a list of products. procuretopayapiscim.SchemasApi | getSchema | GET /Schemas/{id} | Get a schema. procuretopayapiscim.SchemasApi | getSchemas | GET /Schemas | Get a list of schemas. procuretopayapiscim.ServiceProviderConfigurationApi | getServiceProviderConfig | GET /ServiceProviderConfig | Get service provider configuration. procuretopayapiscim.UserClassesApi | getUserClass | GET /UserClasses/{id} | Get a user class. procuretopayapiscim.UserClassesApi | getUserClasses | GET /UserClasses | Get a list of user classes. procuretopayapiscim.UserPositionsApi | getUserPosition | GET /UserPositions/{id} | Get a user position. procuretopayapiscim.UserPositionsApi | getUserPositions | GET /UserPositions | Get a list of user positions. procuretopayapiscim.UsersApi | createUser | POST /Users | Create a user. procuretopayapiscim.UsersApi | deleteUser | DELETE /Users/{id} | Delete a user. procuretopayapiscim.UsersApi | getUser | GET /Users/{id} | Get a user. procuretopayapiscim.UsersApi | getUsers | GET /Users | Get a list of users. procuretopayapiscim.UsersApi | modifyUser | PATCH /Users/{id} | Patch a user. procuretopayapiscim.UsersApi | replaceUser | PUT /Users/{id} | Replace a user.
Documentation for Models
- procuretopayapiscim.AuthenticationScheme
- procuretopayapiscim.Error
- procuretopayapiscim.FederationResource
- procuretopayapiscim.FederationResourceList
- procuretopayapiscim.FederationResourceLocation
- procuretopayapiscim.FederationResourceReference
- procuretopayapiscim.FederationResourceReferenceAssertionValue
- procuretopayapiscim.FederationResourceUser
- procuretopayapiscim.FederationResourceUserAssertionValue
- procuretopayapiscim.FileManagerAuditItem
- procuretopayapiscim.FileManagerAuditItemAdditionalProperty
- procuretopayapiscim.FileManagerAuditItemAdditionalPropertyEntity
- procuretopayapiscim.FileManagerAuditItemAdditionalPropertyPermissionOverride
- procuretopayapiscim.FileManagerAuditItemAdditionalPropertyPermissions
- procuretopayapiscim.FirmDescriptionResource
- procuretopayapiscim.FirmDescriptionResourceList
- procuretopayapiscim.FirmDescriptionResourceMeta
- procuretopayapiscim.FirmDescriptionResourceReference
- procuretopayapiscim.GroupResource
- procuretopayapiscim.GroupResourceList
- procuretopayapiscim.GroupResourceMember
- procuretopayapiscim.GroupResourceMeta
- procuretopayapiscim.GroupResourceUrnScimSchemasExtensionFactSetEnterpriseHosting10Group
- procuretopayapiscim.GroupResourceUrnScimSchemasExtensionFactSetVRS10Group
- procuretopayapiscim.InlineResponse429
- procuretopayapiscim.LocationResource
- procuretopayapiscim.LocationResourceCompanyAgreementUrl
- procuretopayapiscim.LocationResourceFirmDescription
- procuretopayapiscim.LocationResourceList
- procuretopayapiscim.LocationResourceMainLocation
- procuretopayapiscim.LocationResourceManagingLocation
- procuretopayapiscim.LocationResourceMeta
- procuretopayapiscim.LocationResourceReference
- procuretopayapiscim.Patch
- procuretopayapiscim.PatchOperation
- procuretopayapiscim.PatchOperationValue
- procuretopayapiscim.PendingProductOrder
- procuretopayapiscim.ProductResource
- procuretopayapiscim.ProductResourceList
- procuretopayapiscim.ProductResourceMeta
- procuretopayapiscim.ProductResourceReference
- procuretopayapiscim.ProductResourceReferenceWithRapidActivationInfo
- procuretopayapiscim.Schema
- procuretopayapiscim.SchemaAttribute
- procuretopayapiscim.SchemaList
- procuretopayapiscim.SchemaMeta
- procuretopayapiscim.SchemaSubAttribute
- procuretopayapiscim.ServiceProviderConfig
- procuretopayapiscim.ServiceProviderConfigBulk
- procuretopayapiscim.ServiceProviderConfigChangePassword
- procuretopayapiscim.ServiceProviderConfigEtag
- procuretopayapiscim.ServiceProviderConfigFilter
- procuretopayapiscim.ServiceProviderConfigPatch
- procuretopayapiscim.ServiceProviderConfigSort
- procuretopayapiscim.UserClassResource
- procuretopayapiscim.UserClassResourceList
- procuretopayapiscim.UserClassResourceMeta
- procuretopayapiscim.UserClassResourceReference
- procuretopayapiscim.UserPositionResource
- procuretopayapiscim.UserPositionResourceList
- procuretopayapiscim.UserPositionResourceMeta
- procuretopayapiscim.UserPositionResourceReference
- procuretopayapiscim.UserResource
- procuretopayapiscim.UserResourceGroup
- procuretopayapiscim.UserResourceList
- procuretopayapiscim.UserResourceMeta
- procuretopayapiscim.UserResourceName
- procuretopayapiscim.UserResourcePhoneNumber
- procuretopayapiscim.UserResourceUrnScimSchemasExtensionFactSetCore10User
- procuretopayapiscim.UserResourceUrnScimSchemasExtensionFactSetCore10UserUserTaxonomyData
- procuretopayapiscim.UserResourceUrnScimSchemasExtensionFactSetVRS10User
- procuretopayapiscim.UserResourceVRSDomainData
- procuretopayapiscim.UserResourceVRSDomainDataTenancies
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2025 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
