PkgFoundry
Catalog PyPI
PACKAGE EXPLORERView in registry

acre_api

PyPI

Acre Platform User API

acreapiopenapiopenapi-generatorplatformuser
Versions collected1
Direct dependencies4From release 1.2.3
Last observed20 Oct, 18:25 UTC

README

Version 1.2.3 documentation

acre-api

CORS

CORS is implemented by all Acre API endpoints and only certain hostnames are allowed for each deployment of the API. If your use case requires calling the Acre User API from a browser, please contact Acre to arrange the appropriate configuration.

API Authentication

The primary method of authentication for users of the Acre API is with the use of JSON Web Tokens (JWTs), which are suplemented by an application specific API Key. The API key must be provided through the X-API-KEY HTTP header and will be provided by your Acre Customer Success Manager. The JWT must be provided through a cookie with key of authorization. The JWT must be generated and signed as per the following section.

Generating JWTs

JWT must either be generated by a third-party such as Azure ADB2C that has been configured for the appropriate service and/or user account, or alternatively can be generated locally and signed by an private key for which the public key has been made available to Acre via a JWKS URL. In addition to being signed by your private key, the JWT will also need to contain at a minimum:

  • An issuer iss, which must be a valid URI previously agreed with Acre.
  • A subject sub, which must be a unique identifier for the user and/or service account previously agreed with Acre.
  • An expiry time exp which must not be more than four hours in the future.
  • A not before time nbf which must be in the past, but not greater than six hours in the past. The JWT should be signed using RS256.

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

  • API version: 1.0
  • Package version: 1.0.0
  • Generator version: 7.12.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import acre_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import acre_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import acre_api
from acre_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = acre_api.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with acre_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = acre_api.AuthenticationApi(api_client)
    authentication_provider = acre_api.CdmAuthenticationProvider() # CdmAuthenticationProvider | Details of the authentication provider to be created. Required.

    try:
        # Create a new authentication provider.
        api_response = api_instance.create_authentication_provider(authentication_provider)
        print("The response of AuthenticationApi->create_authentication_provider:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->create_authentication_provider: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AuthenticationApicreate_authentication_providerPOST /v1/acre/auth_providerCreate a new authentication provider.
AuthenticationApidelete_authentication_providerDELETE /v1/acre/auth_provider/{authentication_provider.authentication_provider_id}Delete an authentication provider.
AuthenticationApiget_authentication_providerGET /v1/acre/auth_providerGet the authentication provider details.
AuthenticationApiget_user_auth_urlGET /v1/acre/user/auth_urlGet a user-specific URL for the user to authenticate.
AuthenticationApireplace_authentication_providerPUT /v1/acre/auth_provider/{authentication_provider.authentication_provider_id}Replace replaces an authentication provider.
AuthenticationApiupdate_authentication_providerPATCH /v1/acre/auth_provider/{authentication_provider.authentication_provider_id}Update an existing authentication provider.
CaseApibulk_assign_casePOST /v1/acre/case/assignBulk assign case owner and bulk add related users
CaseApibulk_create_lead_casesPOST /v1/acre/case/leadsBulk create lead cases from complete cases.
CaseApicreate_casePOST /v1/acre/caseCreate a new case.
CaseApicreate_case_flagPOST /v1/acre/case/{flag.case_id}/flagCreate case flag.
CaseApicreate_case_flag_reviewPOST /v1/acre/case/{case_id}/flag/{flag_id}/reviewCreate case flag review.
CaseApicreate_case_referralPOST /v1/acre/case/referralCreate a new case from an existing one.
CaseApicreate_case_versionPOST /v1/acre/case/{case_id}/versionCreate a case version.
CaseApidescribe_case_verificationGET /v1/acre/case/verificationDescribe all installed verifications for cases.
CaseApiget_caseGET /v1/acre/caseGet cases with their latest version.
CaseApiget_case_surveyGET /v1/acre/case/{case_id}/surveyGet case survey.
CaseApiget_case_verificationsGET /v1/acre/case/{case_id}/verificationsRetrieve verifications of an existing case.
CaseApiget_case_versionGET /v1/acre/case/{case_id}/version/{version}Get a case, specifying a version (use zero for latest).
CaseApiget_hydrated_caseGET /v1/acre/case/{case_id}/hydratedGet hydrated case.
CaseApilist_case_versionGET /v1/acre/case/{case_id}/versionList case versions.
CaseApireplace_casePUT /v1/acre/case/{case.case_id}Replace (PUT) an existing case and current mutable version.
CaseApiupdate_casePATCH /v1/acre/case/{case.case_id}Update (PATCH) an existing case and current mutable version.
CaseApiupdate_case_statusPOST /v1/acre/case/{case_id}/case_transitionUpdate a case's status.
ClientApicreate_clientPOST /v1/acre/clientCreate a new client.
ClientApicreate_client_organisation_relationshipPOST /v1/acre/client/{client_id}/organisation_relationship/{organisation_id_or_ext}Create a client organisation relationship.
ClientApicreate_client_versionPOST /v1/acre/client/{client_id}/versionCreate a client version.
ClientApidelete_client_dataDELETE /v1/acre/client/{client_id}
ClientApidelete_client_health_dataDELETE /v1/acre/client/{client_id}/health_data
ClientApideprecated_get_client_organisation_relationshipGET /v1/acre/client/{client_id}/organisation_relationshipDeprecated - Get client organisation relationship.
ClientApiget_clientGET /v1/acre/clientGet clients with their latest version.
ClientApiget_client_linked_dataGET /v1/acre/client/{client_id}/delete_data
ClientApiget_client_organisation_relationshipGET /v1/acre/client/{client_id}/organisation_relationship/{organisation_id_or_ext}Get client organisation relationship.
ClientApiget_client_verificationsGET /v1/acre/client/{client_id}/verificationsRetrieve verifications of an existing client.
ClientApiget_client_versionGET /v1/acre/client/{client_id}/version/{version}Get a client, specifying a version (use zero for latest).
ClientApilist_client_versionGET /v1/acre/client/{client_id}/versionList client versions.
ClientApireplace_clientPUT /v1/acre/client/{client.client_id}Replace (PUT) an existing client and current mutable version.
ClientApirun_id_verificationPOST /v1/acre/client/{client_id}/identity/request_verificationRequest eIDV check of an existing client.
ClientApiupdate_clientPATCH /v1/acre/client/{client.client_id}Update (PATCH) an existing client and current mutable version.
ClientApiupdate_client_organisation_relationshipPATCH /v1/acre/client/{client_id}/organisation_relationship/{organisation_id_or_ext}Update (PATCH) an existing client organisation relationship.
CommissionStructureApicreate_commission_structurePOST /v1/acre/commission_structureCreate Commission Structure.
CommissionStructureApiget_commission_structureGET /v1/acre/commission_structureRetrieve Commission Structure.
CommissionStructureApiupdate_commission_structurePATCH /v1/acre/commission_structure/{commission_structure.commission_structure_id}Update (PATCH) Commission Structure.
DocumentApiadd_case_documentPOST /v1/acre/document/{document_id}/caseAdd a document to an existing case.
DocumentApicreate_document_verificationPOST /v1/acre/document/{document_id}/verificationCreate a document verification.
DocumentApidelete_case_documentDELETE /v1/acre/document/{document_id}/case/{case_id}Delete (DELETE) document from an existing case.
DocumentApidelete_documentDELETE /v1/acre/document/{document_id}Delete (DELETE) document.
DocumentApiget_documentGET /v1/acre/document/{document.document_id}Get a document.
DocumentApiget_document_summariesGET /v1/acre/documentGet summaries for multiple documents. No document details are returned.
DocumentApiget_document_verificationGET /v1/acre/document/{document_id}/verificationGet a document verification.
DocumentApirender_templatePOST /v1/acre/document/render_templateRender a template to generate a document and (optionally) store it.
DocumentApireplace_documentPUT /v1/acre/document/{document.document_id}Replace (PUT) an existing document.
DocumentApitemplate_ctxPOST /v1/acre/document/render_template/ctxReturn the context a given template would have been rendered with.
DocumentApitest_render_templatePOST /v1/acre/document/render_template/testTest rendering a template without having to store it, by passing the code.
DocumentApiupdate_documentPATCH /v1/acre/document/{document.document_id}Update (PATCH) an existing document.
DocumentApiupload_documentPOST /v1/acre/documentUpload a document.
DocumentRequirementApicreate_document_requirementPOST /v1/acre/requirementCreate a new document requirement.
DocumentRequirementApiget_document_requirementsGET /v1/acre/requirementGet document requirements.
DocumentRequirementApiupdate_document_requirementPATCH /v1/acre/requirement/{document_requirement.requirement_id}Update document requirement.
GeneralInsuranceProductApiadd_general_insurance_product_casePOST /v1/acre/general_insurance_product/{general_insurance_product_id}/caseAdd a general insurance product to an existing case.
GeneralInsuranceProductApicreate_general_insurance_productPOST /v1/acre/general_insurance_productCreate a general insurance product.
GeneralInsuranceProductApidelete_general_insurance_product_caseDELETE /v1/acre/general_insurance_product/{general_insurance_product_id}/case/{case_id}Delete a general insurance product from an existing case.
GeneralInsuranceProductApiget_general_insurance_productGET /v1/acre/general_insurance_productGet general insurance products.
GeneralInsuranceProductApiupdate_general_insurance_productPATCH /v1/acre/general_insurance_product/{general_insurance_product.general_insurance_product_id}Update (PATCH) an existing general insurance product.
GroupApicreate_groupPOST /v1/acre/groupCreate a new group.
GroupApiget_groupGET /v1/acre/groupGet the group details.
GroupApireplace_groupPUT /v1/acre/group/{group.group_id}Replace (PUT) an existing group.
GroupApiupdate_groupPATCH /v1/acre/group/{group.group_id}Update (PATCH) an existing group.
InternalApiget_hydrated_caseGET /v1/acre/case/{case_id}/hydratedGet hydrated case.
MortgageSourcingApiget_mortgage_product_detailsGET /v1/acre/mortgage_product/source/{product_code}Get mortgage product details for sourced product.
MortgageSourcingApirun_sourcePOST /v1/acre/mortgage_product/sourceRun mortgage product sourcing.
MortgageMortgageProductApiadd_mortgage_casePOST /v1/acre/mortgage/{mortgage_id}/caseAdd a mortgage to an existing case.
MortgageMortgageProductApiadd_mortgage_productPOST /v1/acre/mortgage/{mortgage_id}/productAdd a mortgage product to an existing mortgage.
MortgageMortgageProductApicreate_acre_mortgage_productPOST /v1/acre/mortgage_productCreate a mortgage product stored within Acre.
MortgageMortgageProductApicreate_mortgagePOST /v1/acre/mortgageCreate a new mortgage.
MortgageMortgageProductApicreate_mortgage_versionPOST /v1/acre/mortgage/{mortgage_id}/versionCreate a Mortgage version.
MortgageMortgageProductApicreate_mortgage_with_productPOST /v1/acre/mortgage_with_productCreate a new mortgage with a product and link it to a case.
MortgageMortgageProductApidelete_mortgage_caseDELETE /v1/acre/mortgage/{mortgage_id}/case/{case_id}Delete (DELETE) mortgage from an existing case.
MortgageMortgageProductApidelete_mortgage_productDELETE /v1/acre/mortgage/{mortgage_id}/product/{product_id}Delete (DELETE) mortgage product from an existing mortgage.
MortgageMortgageProductApiget_acre_mortgage_productGET /v1/acre/mortgage_product/{product_id}Get mortgage product details for a mortgage product stored in Acre.
MortgageMortgageProductApiget_mortgageGET /v1/acre/mortgageGet the details of existing mortgages.
MortgageMortgageProductApiget_mortgage_versionGET /v1/acre/mortgage/{mortgage_id}/version/{version}Get a mortgage, specifying a version (use zero for latest).
MortgageMortgageProductApireplace_mortgagePUT /v1/acre/mortgage/{mortgage.mortgage_id}Replace (PUT) an existing mortgage.
MortgageMortgageProductApiupdate_mortgagePATCH /v1/acre/mortgage/{mortgage.mortgage_id}Update (PATCH) an existing mortgage.
MortgageMortgageProductApiupdate_mortgage_with_productPATCH /v1/acre/mortgage_with_product/{mortgage_with_product.mortgage.mortgage_id}Update (PATCH) an existing mortgage and its product
NoteApicreate_notePOST /v1/acre/noteCreate a note.
NoteApiget_noteGET /v1/acre/noteRetrieve note.
NoteApiupdate_notePATCH /v1/acre/note/{note.note_id}Update a note.
OrganisationApicreate_organisationPOST /v1/acre/organisationCreate a new organisation.
OrganisationApiget_organisationGET /v1/acre/organisationGet the details of existing organisations.
OrganisationApireplace_organisationPUT /v1/acre/organisation/{organisation_id_or_ext}Replace (PUT) an existing organisation.
OrganisationApiupdate_organisationPATCH /v1/acre/organisation/{organisation_id_or_ext}Update (PATCH) an existing organisation.
PermissionApicreate_permission_assignmentPOST /v1/acre/permission_assignmentCreate a new permission assignment.
PermissionApicreate_permission_assignmentsPOST /v1/acre/permission_assignment/bulkCreate new permission assignments. If one fails the call, none will be applied. Note that this endpoint must be defined after /v1/acre/permission_assignment/{permission_assignment.permission_assignment_id}, otherwise requests to /v1/acre/permission_assignment/bulk will be handled as if `bulk` is permission_assignment_id
PermissionApiget_permissionGET /v1/acre/permissionGet permission details. Permissions are populated using a default configuration, and cannot be manipulated via API.
PermissionApiget_permission_assignmentGET /v1/acre/permission_assignmentGet the permission assignment details.
PermissionApireplace_permission_assignmentPUT /v1/acre/permission_assignment/{permission_assignment.permission_assignment_id}Replace (PUT) a permission assignment.
PermissionApiresolve_permissionPOST /v1/acre/resolve_permissionCheck permissions with the given scopes.
PermissionApiupdate_permission_assignmentPATCH /v1/acre/permission_assignment/{permission_assignment.permission_assignment_id}Update (PATCH) a permission assignment. Note that this endpoint must be defined before /v1/acre/permission_assignment/bulk, otherwise requests to /v1/acre/permission_assignment/bulk will be handled as if `bulk` is permission_assignment_id
PermissionApiupdate_permission_assignmentsPATCH /v1/acre/permission_assignment/bulkUpdate (PATCH) permission assignments. If one fails the call, none will be applied.
PropertyApicreate_propertyPOST /v1/acre/propertyCreate a new property.
PropertyApicreate_property_versionPOST /v1/acre/property/{property_id}/versionCreate a property version.
PropertyApiget_propertyGET /v1/acre/propertyGet properties with their latest version.
PropertyApiget_property_versionGET /v1/acre/property/{property_id}/version/{version}Get a property, specifying a version (use zero for latest).
PropertyApilist_property_versionGET /v1/acre/property/{property_id}/versionList property versions. Only versions that the caller can view are returned.
PropertyApireplace_propertyPUT /v1/acre/property/{property.property_id}Replace (PUT) an existing property and current mutable version.
PropertyApiupdate_propertyPATCH /v1/acre/property/{property.property_id}Update (PATCH) an existing property and current mutable version.
ProtectionProductApiadd_case_protection_productPOST /v1/acre/protection_product/{protection_id}/caseAdd a protection product to an existing case.
ProtectionProductApicreate_protection_productPOST /v1/acre/protection_productCreate a protection product.
ProtectionProductApicreate_protection_product_versionPOST /v1/acre/protection_product/{protection_id}/versionCreate a protection product version.
ProtectionProductApidelete_case_protection_productDELETE /v1/acre/protection_product/{protection_id}/case/{case_id}Delete (DELETE) case from a protection product.
ProtectionProductApiget_protection_productGET /v1/acre/protection_productGet protection product details.
ProtectionProductApiget_protection_product_versionGET /v1/acre/protection_product/{protection_id}/version/{version}Get a protection product, specifying a version (use zero for latest).
ProtectionProductApisave_protection_solution_to_casePOST /v1/acre/protection_solutionCreate protection products which belong to a single solution and add to case.
ProtectionProductApiupdate_protection_productPATCH /v1/acre/protection_product/{protection_product.protection_id}Update (PATCH) an existing protection product.
ProtectionProductApilist_protection_product_versionGET /v1/acre/protection_product/{protection_id}/versionList protection product versions.
RoleApicreate_rolePOST /v1/acre/roleCreate a new role.
RoleApiget_roleGET /v1/acre/roleGet the role details.
RoleApireplace_rolePUT /v1/acre/role/{role.role_id}Replace (PUT) an existing role.
RoleApiupdate_rolePATCH /v1/acre/role/{role.role_id}Update (PATCH) an existing role.
ServiceApihealth_checkGET /v1/acre/health_checkCheck the health of the acre processor. This is used by load balancers to check end-to-end service health.
TemplateApicreate_templatePOST /v1/acre/templateCreate a template.
TemplateApiemail_templatePOST /v1/acre/email_templateEmail Template.
TemplateApiget_templateGET /v1/acre/templateGet the template details.
UserApicreate_userPOST /v1/acre/userCreate a new user.
UserApiget_meGET /v1/acre/user/meGet the details of the currently logged in user.
UserApiget_userGET /v1/acre/userGet the details of users.
UserApireplace_userPUT /v1/acre/user/{user.user_id}Replace (PUT) an existing user.
UserApiupdate_userPATCH /v1/acre/user/{user.user_id}Update (PATCH) an existing user.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
1.2.36 Feb 20254
Sorted by available source dates · UTC

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
hosseini72/acre_api

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 18:25 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:d805015f785697bef09b31323271629d969721ce4b3c542c5b3e8c18450587a5