fds.sdk.ProcuretoPayAPISCIM 0.23.2

Procure to Pay API: SCIM client library for Python

Procure to Pay API: SCIM client library for Python

FactSet's SCIM API implementation.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2.6.0
• SDK version: 0.23.2
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.ProcuretoPayAPISCIM==0.23.2

pip

pip install fds.sdk.utils fds.sdk.ProcuretoPayAPISCIM==0.23.2

Usage

1. Generate authentication credentials.
2. Setup Python environment.

   1. Install and activate python 3.7+. If you're using pyenv:

      pyenv install 3.9.7
      pyenv shell 3.9.7
      

   2. (optional) Install poetry.

3. Install dependencies.
4. 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

from fds.sdk.utils.authentication import ConfidentialClient

import fds.sdk.ProcuretoPayAPISCIM
from fds.sdk.ProcuretoPayAPISCIM.api import federations_api
from fds.sdk.ProcuretoPayAPISCIM.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.

# 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-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.ProcuretoPayAPISCIM.Configuration(
    fds_oauth_client=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
# configuration = fds.sdk.ProcuretoPayAPISCIM.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.ProcuretoPayAPISCIM.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = federations_api.FederationsApi(api_client)
    id = "id_example" # str | ID of resource.
    attributes = [
        "attributes_example",
    ] # [str] | 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. (optional)
    excluded_attributes = [
        "excludedAttributes_example",
    ] # [str] | 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. (optional)
    additional_attributes = [
        "additionalAttributes_example",
    ] # [str] | 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. (optional)

    try:
        # Get a federation.
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.get_federation(id, attributes=attributes, excluded_attributes=excluded_attributes, additional_attributes=additional_attributes)

        pprint(api_response)
    except fds.sdk.ProcuretoPayAPISCIM.ApiException as e:
        print("Exception when calling FederationsApi->get_federation: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Get a federation.
    #     api_response, http_status_code, response_headers = api_instance.get_federation_with_http_info(id, attributes=attributes, excluded_attributes=excluded_attributes, additional_attributes=additional_attributes)


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.ProcuretoPayAPISCIM.ApiException as e:
    #     print("Exception when calling FederationsApi->get_federation: %s\n" % e)

    # # Get response asynchronous
    # try:
    #     # Get a federation.
    #     async_result = api_instance.get_federation_async(id, attributes=attributes, excluded_attributes=excluded_attributes, additional_attributes=additional_attributes)
    #     api_response = async_result.get()


    #     pprint(api_response)
    # except fds.sdk.ProcuretoPayAPISCIM.ApiException as e:
    #     print("Exception when calling FederationsApi->get_federation: %s\n" % e)

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Get a federation.
    #     async_result = api_instance.get_federation_with_http_info_async(id, attributes=attributes, excluded_attributes=excluded_attributes, additional_attributes=additional_attributes)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.ProcuretoPayAPISCIM.ApiException as e:
    #     print("Exception when calling FederationsApi->get_federation: %s\n" % e)

Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.

import pandas as pd

response_dict = api_response.to_dict()['data']

simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)

Debugging

The SDK uses the standard library logging module.

Setting debug to True on an instance of the Configuration class sets the log-level of related packages to DEBUG and enables additional logging in Pythons HTTP Client.

Note: This prints out sensitive information (e.g. the full request and response). Use with care.

import logging
import fds.sdk.ProcuretoPayAPISCIM

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.ProcuretoPayAPISCIM.Configuration(...)
configuration.debug = True

Configure a Proxy

You can pass proxy settings to the Configuration class:

• proxy: The URL of the proxy to use.
• proxy_headers: a dictionary to pass additional headers to the proxy (e.g. Proxy-Authorization).

import fds.sdk.ProcuretoPayAPISCIM

configuration = fds.sdk.ProcuretoPayAPISCIM.Configuration(
    # ...
    proxy="http://secret:password@localhost:5050",
    proxy_headers={
        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
    }
)

Custom SSL Certificate

TLS/SSL certificate verification can be configured with the following Configuration parameters:

• ssl_ca_cert: a path to the certificate to use for verification in PEM format.
• verify_ssl: setting this to False disables the verification of certificates. Disabling the verification is not recommended, but it might be useful during local development or testing.

import fds.sdk.ProcuretoPayAPISCIM

configuration = fds.sdk.ProcuretoPayAPISCIM.Configuration(
    # ...
    ssl_ca_cert='/path/to/ca.pem'
)

Request Retries

In case the request retry behaviour should be customized, it is possible to pass a urllib3.Retry object to the retry property of the Configuration.

from urllib3 import Retry
import fds.sdk.ProcuretoPayAPISCIM

configuration = fds.sdk.ProcuretoPayAPISCIM.Configuration(
    # ...
)

configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/scim/v2

Class	Method	HTTP request	Description
FederationsApi	get_federation	GET /Federations/{id}	Get a federation.
FederationsApi	get_federations	GET /Federations	Get a list of federations.
FederationsApi	modify_federation	PATCH /Federations/{id}	Patch a federation.
FederationsApi	replace_federation	PUT /Federations/{id}	Replace a federation.
FileManagerAuditApi	get_file_manager_audit	GET /FileManagerAudit	Get File Manager audit data.
FirmDescriptionsApi	get_firm_description	GET /FirmDescriptions/{id}	Get a firm description.
FirmDescriptionsApi	get_firm_descriptions	GET /FirmDescriptions	Get a list of firm descriptions.
GroupsApi	get_group	GET /Group/{id}	Get a group.
GroupsApi	get_groups	GET /Groups	Get a list of groups.
GroupsApi	modify_group	PATCH /Group/{id}	Patch a group.
GroupsApi	replace_group	PUT /Group/{id}	Replace a group.
LocationsApi	create_location	POST /Locations	Create a location.
LocationsApi	get_location	GET /Locations/{id}	Get a location.
LocationsApi	get_locations	GET /Locations	Get a list of locations.
LocationsApi	modify_location	PATCH /Locations/{id}	Patch a location.
LocationsApi	replace_location	PUT /Locations/{id}	Replace a location.
ProductsApi	get_product	GET /Products/{id}	Get a product.
ProductsApi	get_products	GET /Products	Get a list of products.
SchemasApi	get_schema	GET /Schemas/{id}	Get a schema.
SchemasApi	get_schemas	GET /Schemas	Get a list of schemas.
ServiceProviderConfigurationApi	get_service_provider_config	GET /ServiceProviderConfig	Get service provider configuration.
UserClassesApi	get_user_class	GET /UserClasses/{id}	Get a user class.
UserClassesApi	get_user_classes	GET /UserClasses	Get a list of user classes.
UserPositionsApi	get_user_position	GET /UserPositions/{id}	Get a user position.
UserPositionsApi	get_user_positions	GET /UserPositions	Get a list of user positions.
UsersApi	create_user	POST /Users	Create a user.
UsersApi	delete_user	DELETE /Users/{id}	Delete a user.
UsersApi	get_user	GET /Users/{id}	Get a user.
UsersApi	get_users	GET /Users	Get a list of users.
UsersApi	modify_user	PATCH /Users/{id}	Patch a user.
UsersApi	replace_user	PUT /Users/{id}	Replace a user.

Documentation For Models

• AuthenticationScheme
• Error
• FederationResource
• FederationResourceList
• FederationResourceLocation
• FederationResourceReference
• FederationResourceReferenceAssertionValue
• FederationResourceUser
• FederationResourceUserAssertionValue
• FileManagerAudit
• FileManagerAuditItem
• FileManagerAuditItemAdditionalProperty
• FileManagerAuditItemAdditionalPropertyEntity
• FileManagerAuditItemAdditionalPropertyPermissionOverride
• FileManagerAuditItemAdditionalPropertyPermissions
• FirmDescriptionResource
• FirmDescriptionResourceList
• FirmDescriptionResourceMeta
• FirmDescriptionResourceReference
• GroupResource
• GroupResourceList
• GroupResourceMember
• GroupResourceMeta
• GroupResourceUrnScimSchemasExtensionFactSetEnterpriseHosting10Group
• GroupResourceUrnScimSchemasExtensionFactSetVRS10Group
• InlineResponse429
• LocationResource
• LocationResourceCompanyAgreementUrl
• LocationResourceFirmDescription
• LocationResourceList
• LocationResourceMainLocation
• LocationResourceManagingLocation
• LocationResourceMeta
• LocationResourceReference
• Patch
• PatchOperation
• PatchOperationValue
• PendingProductOrder
• ProductResource
• ProductResourceList
• ProductResourceMeta
• ProductResourceReference
• ProductResourceReferenceWithRapidActivationInfo
• Schema
• SchemaAttribute
• SchemaList
• SchemaMeta
• SchemaSubAttribute
• ServiceProviderConfig
• ServiceProviderConfigBulk
• ServiceProviderConfigChangePassword
• ServiceProviderConfigEtag
• ServiceProviderConfigFilter
• ServiceProviderConfigPatch
• ServiceProviderConfigSort
• UserClassResource
• UserClassResourceList
• UserClassResourceMeta
• UserClassResourceReference
• UserPositionResource
• UserPositionResourceList
• UserPositionResourceMeta
• UserPositionResourceReference
• UserResource
• UserResourceGroup
• UserResourceList
• UserResourceMeta
• UserResourceName
• UserResourcePhoneNumber
• UserResourceUrnScimSchemasExtensionFactSetCore10User
• UserResourceUrnScimSchemasExtensionFactSetCore10UserUserTaxonomyData
• UserResourceUrnScimSchemasExtensionFactSetVRS10User
• UserResourceVRSDomainData
• UserResourceVRSDomainDataTenancies

Documentation For Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fds.sdk.ProcuretoPayAPISCIM.apis and fds.sdk.ProcuretoPayAPISCIM.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from fds.sdk.ProcuretoPayAPISCIM.api.default_api import DefaultApi
• from fds.sdk.ProcuretoPayAPISCIM.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import fds.sdk.ProcuretoPayAPISCIM
from fds.sdk.ProcuretoPayAPISCIM.apis import *
from fds.sdk.ProcuretoPayAPISCIM.models import *

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.0

Unless 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.