Package: fds.sdk.ProcuretoPaySCIM
Procure to Pay SCIM client library for PythonFactSet's SCIM API implementation.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.0.0Package version: 0.20.0Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.6InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.ProcuretoPaySCIMpippipinstallfds.sdk.utilsfds.sdk.ProcuretoPaySCIMUsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.6+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.Run the following:fromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.ProcuretoPaySCIMfromfds.sdk.ProcuretoPaySCIM.apiimportgroups_apifromfds.sdk.ProcuretoPaySCIM.model.errorimportErrorfromfds.sdk.ProcuretoPaySCIM.model.group_resourceimportGroupResourcefromfds.sdk.ProcuretoPaySCIM.model.group_resource_listimportGroupResourceListfromfds.sdk.ProcuretoPaySCIM.model.patchimportPatchfrompprintimportpprint# 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# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication# for more information on using the ConfidentialClient classconfiguration=fds.sdk.ProcuretoPaySCIM.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.ProcuretoPaySCIM.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.ProcuretoPaySCIM.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=groups_api.GroupsApi(api_client)id="id_example"# str | ID of resource.# Get responsetry:# Get a group.api_response=api_instance.group_id_get(id)pprint(api_response)exceptfds.sdk.ProcuretoPaySCIM.ApiExceptionase:print("Exception when calling GroupsApi->group_id_get:%s\n"%e)# Get response, http status code and response headers# try:#     # Get a group.#     api_response, http_status_code, response_headers = api_instance.group_id_get_with_http_info(id)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.ProcuretoPaySCIM.ApiException as e:#     print("Exception when calling GroupsApi->group_id_get: %s\n" % e)# Get response asynchronous# try:#     # Get a group.#     async_result = api_instance.group_id_get_async(id)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.ProcuretoPaySCIM.ApiException as e:#     print("Exception when calling GroupsApi->group_id_get: %s\n" % e)# Get response, http status code and response headers asynchronous# try:#     # Get a group.#     async_result = api_instance.group_id_get_with_http_info_async(id)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.ProcuretoPaySCIM.ApiException as e:#     print("Exception when calling GroupsApi->group_id_get: %s\n" % e)Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/scim/v2ClassMethodHTTP requestDescriptionGroupsApigroup_id_getGET/Group/{id}Get a group.GroupsApigroup_id_patchPATCH/Group/{id}Patch a group (add, replace, or remove attributes of a group.)GroupsApigroup_id_putPUT/Group/{id}Replace a group.GroupsApigroups_getGET/GroupsGet a list of groups.LocationsApilocations_getGET/LocationsGet a list of locations.LocationsApilocations_id_getGET/Locations/{id}Get a location.LocationsApilocations_id_patchPATCH/Locations/{id}Patch a location (add, replace, or remove attributes of a location.)LocationsApilocations_id_putPUT/Locations/{id}Replace a location.ProductsApiproducts_getGET/ProductsGet a list of products.ProductsApiproducts_id_getGET/Products/{id}Get a product.SchemasApischemas_getGET/SchemasGet a list of schemas.SchemasApischemas_id_getGET/Schemas/{id}Get a schema.ServerConfigurationApiservice_provider_config_getGET/ServiceProviderConfigGet server configuration.UsersApiusers_getGET/UsersGet a list of users.UsersApiusers_id_deleteDELETE/Users/{id}Delete a userUsersApiusers_id_getGET/Users/{id}Get a user.UsersApiusers_id_patchPATCH/Users/{id}Patch a user (add, replace, or remove attributes of a user.)UsersApiusers_id_putPUT/Users/{id}Replace a user.UsersApiusers_postPOST/UsersCreate a user.VermilionGroupsApivermilion_groups_getGET/VermilionGroupsGet a list of Vermilion groups.VermilionGroupsApivermilion_groups_id_getGET/VermilionGroups/{id}Get a Vermilion group.VermilionGroupsApivermilion_groups_id_patchPATCH/VermilionGroups/{id}Patch a Vermilion group (add, replace, or remove attributes of a Vermilion group.)VermilionGroupsApivermilion_groups_id_putPUT/VermilionGroups/{id}Replace a Vermilion group.VermilionUsersApivermilion_users_getGET/VermilionUsersGet a list of Vermilion users.VermilionUsersApivermilion_users_id_deleteDELETE/VermilionUsers/{id}Delete a Vermilion userVermilionUsersApivermilion_users_id_getGET/VermilionUsers/{id}Get a Vermilion user.VermilionUsersApivermilion_users_id_patchPATCH/VermilionUsers/{id}Patch a Vermilion user (add, replace, or remove attributes of a Vermilion user.)VermilionUsersApivermilion_users_id_putPUT/VermilionUsers/{id}Replace a Vermilion user.VermilionUsersApivermilion_users_postPOST/VermilionUsersCreate a Vermilion user.Documentation For ModelsErrorGroupResourceGroupResourceListGroupResourceMembersGroupResourceMetaGroupResourceUrnScimSchemasExtensionFactSetEnterpriseHosting10GroupLocationResourceLocationResourceListLocationResourceMetaLocationResourceReferencePatchPatchOperationsPendingProductOrderProductResourceProductResourceListProductResourceMetaProductResourceReferenceSchemaSchemaAttributesSchemaListSchemaSubAttributesServiceProviderConfigServiceProviderConfigAuthenticationSchemesServiceProviderConfigBulkServiceProviderConfigChangePasswordServiceProviderConfigEtagServiceProviderConfigFilterServiceProviderConfigPatchServiceProviderConfigSortUserResourceUserResourceGroupsUserResourceListUserResourceMetaUserResourceNameUserResourcePhoneNumbersUserResourceUrnScimSchemasExtensionCoreFactset10VermilionGroupResourceVermilionGroupResourceListVermilionGroupResourceMembersVermilionGroupResourceMetaVermilionUserResourceVermilionUserResourceEmailsVermilionUserResourceEntitlementsVermilionUserResourceGroupsVermilionUserResourceListVermilionUserResourceMetaVermilionUserResourceNameVermilionUserResourcePhoneNumbersVermilionUserResourcePhotosVermilionUserResourceRolesDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.ProcuretoPaySCIM.apis and fds.sdk.ProcuretoPaySCIM.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.ProcuretoPaySCIM.api.default_api import DefaultApifrom fds.sdk.ProcuretoPaySCIM.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import fds.sdk.ProcuretoPaySCIM
from fds.sdk.ProcuretoPaySCIM.apis import *
from fds.sdk.ProcuretoPaySCIM.models import *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed 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 athttp://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.