iparapheur-provisioning
iparapheur v5.x main core application.
The main link between every sub-services, integrating business code logic.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: DEVELOP
- Package version: 0.0.20260427155707
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://libriciel.fr
Requirements.
Python 3.9+
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 iparapheur_provisioning
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 iparapheur_provisioning
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import iparapheur_provisioning
from iparapheur_provisioning.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = iparapheur_provisioning.Configuration(
host = "http://localhost:8080"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with iparapheur_provisioning.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = iparapheur_provisioning.AdminAllUsersApi(api_client)
user_dto = iparapheur_provisioning.UserDto() # UserDto |
try:
# Create a new super admin user
api_response = api_instance.create_super_admin_as_super_admin(user_dto)
print("The response of AdminAllUsersApi->create_super_admin_as_super_admin:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminAllUsersApi->create_super_admin_as_super_admin: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost:8080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminAllUsersApi | create_super_admin_as_super_admin | POST /api/provisioning/v1/admin/user | Create a new super admin user |
| AdminAllUsersApi | delete_signature_image_as_super_admin | DELETE /api/provisioning/v1/admin/user/{userId}/signature-image | Delete user's signature image |
| AdminAllUsersApi | delete_user_as_super_admin | DELETE /api/provisioning/v1/admin/user/{userId} | Delete a user |
| AdminAllUsersApi | get_signature_image_as_super_admin | GET /api/provisioning/v1/admin/user/{userId}/signature-image | Get user's signature image |
| AdminAllUsersApi | get_user_as_super_admin | GET /api/provisioning/v1/admin/user/{userId} | Get a full user representation |
| AdminAllUsersApi | list_users_as_super_admin | GET /api/provisioning/v1/admin/user | List all users on the instance |
| AdminAllUsersApi | set_signature_image_as_super_admin | POST /api/provisioning/v1/admin/user/{userId}/signature-image | Create user's signature image |
| AdminAllUsersApi | update_signature_image_as_super_admin | PUT /api/provisioning/v1/admin/user/{userId}/signature-image | Replace user's signature image |
| AdminAllUsersApi | update_user_as_super_admin | PUT /api/provisioning/v1/admin/user/{userId} | Edit a user |
| AdminDeskApi | create_delegation_as_admin | POST /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId}/delegation | Create a new delegation (active or planned) from target desk |
| AdminDeskApi | create_desk | POST /api/provisioning/v1/admin/tenant/{tenantId}/desk | Create a desk |
| AdminDeskApi | delete_delegation_as_admin | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId}/delegation/{delegationId} | Remove an active or planned delegation from target Desk |
| AdminDeskApi | delete_desk | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId} | Delete a desk |
| AdminDeskApi | edit_desk | PUT /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId} | Edit a desk |
| AdminDeskApi | get_delegation_as_admin | GET /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId}/delegation/{delegationId} | Get a delegation with every information set |
| AdminDeskApi | get_desk_as_admin | GET /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId} | Get a full desk description |
| AdminDeskApi | list_desk_delegations_as_admin | GET /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId}/delegation | List delegations (active and planned) for given delegating desk |
| AdminDeskApi | list_desks | GET /api/provisioning/v1/admin/tenant/{tenantId}/desk | List desks |
| AdminDeskApi | update_delegation_as_admin | PUT /api/provisioning/v1/admin/tenant/{tenantId}/desk/{deskId}/delegation/{delegationId} | Update a delegation from target Desk |
| AdminExternalSignatureApi | create_external_signature_config | POST /api/provisioning/v1/admin/tenant/{tenantId}/external-signature-config | Create an external signature config |
| AdminExternalSignatureApi | delete_external_signature_config | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/external-signature-config/{configId} | Delete an external signature config |
| AdminExternalSignatureApi | edit_external_signature_config | PUT /api/provisioning/v1/admin/tenant/{tenantId}/external-signature-config/{configId} | Update an external signature config |
| AdminExternalSignatureApi | get_external_signature_config | GET /api/provisioning/v1/admin/tenant/{tenantId}/external-signature-config/{configId} | Get a full external signature config description |
| AdminExternalSignatureApi | list_external_signature_configs | GET /api/provisioning/v1/admin/tenant/{tenantId}/external-signature-config | List external signature configs |
| AdminFolderApi | delete_folder_as_admin | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/folder/{folderId} | Delete folder |
| AdminMetadataApi | create_metadata | POST /api/provisioning/v1/admin/tenant/{tenantId}/metadata | Create a metadata |
| AdminMetadataApi | delete_metadata | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/metadata/{metadataId} | Delete a metadata |
| AdminMetadataApi | get_metadata | GET /api/provisioning/v1/admin/tenant/{tenantId}/metadata/{metadataId} | Get a full metadata description |
| AdminMetadataApi | list_internal_metadata_as_admin | GET /api/provisioning/v1/admin/internal-metadata | List internal metadata |
| AdminMetadataApi | list_metadata | GET /api/provisioning/v1/admin/tenant/{tenantId}/metadata | List all metadata associated with the tenant |
| AdminMetadataApi | update_metadata | PUT /api/provisioning/v1/admin/tenant/{tenantId}/metadata/{metadataId} | Edit a metadata |
| AdminSealCertificateApi | create_seal_certificate | POST /api/provisioning/v1/admin/tenant/{tenantId}/seal-certificate | Create a seal certificate |
| AdminSealCertificateApi | create_seal_certificate_deprecated | POST /api/provisioning/v1/admin/tenant/{tenantId}/sealCertificate | DEPRECATED: Use the "seal-certificate" instead. Create a seal certificate |
| AdminSealCertificateApi | delete_seal_certificate | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/seal-certificate/{sealCertificateId} | Delete a stored seal certificate |
| AdminSealCertificateApi | delete_seal_certificate_deprecated | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/sealCertificate/{sealCertificateId} | DEPRECATED: Use the "seal-certificate" instead. Delete a stored seal certificate |
| AdminSealCertificateApi | get_seal_certificate | GET /api/provisioning/v1/admin/tenant/{tenantId}/seal-certificate/{sealCertificateId} | Get a seal certificate with every information set |
| AdminSealCertificateApi | get_seal_certificate_deprecated | GET /api/provisioning/v1/admin/tenant/{tenantId}/sealCertificate/{sealCertificateId} | DEPRECATED: Use the "seal-certificate" instead. Get a seal certificate with every information set |
| AdminSealCertificateApi | list_seal_certificate | GET /api/provisioning/v1/admin/tenant/{tenantId}/seal-certificate | List seal certificates |
| AdminSealCertificateApi | list_seal_certificate_deprecated | GET /api/provisioning/v1/admin/tenant/{tenantId}/sealCertificate | DEPRECATED: Use the "seal-certificate" instead. List seal certificates |
| AdminSealCertificateApi | update_seal_certificate | PUT /api/provisioning/v1/admin/tenant/{tenantId}/seal-certificate/{sealCertificateId} | Edit a seal certificate |
| AdminSealCertificateApi | update_seal_certificate_deprecated | PUT /api/provisioning/v1/admin/tenant/{tenantId}/sealCertificate/{sealCertificateId} | DEPRECATED: Use the "seal-certificate" instead. Edit a seal certificate |
| AdminSecureMailApi | create_server | POST /api/provisioning/v1/admin/tenant/{tenantId}/secure-mail-server | Create a secure mail server |
| AdminSecureMailApi | delete_server | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/secure-mail-server/{serverId} | Delete a secure mail server |
| AdminSecureMailApi | get_server | GET /api/provisioning/v1/admin/tenant/{tenantId}/secure-mail-server/{serverId} | Get a secure mail server |
| AdminSecureMailApi | list_servers | GET /api/provisioning/v1/admin/tenant/{tenantId}/secure-mail-server | List secure mail servers |
| AdminSecureMailApi | update_server | PUT /api/provisioning/v1/admin/tenant/{tenantId}/secure-mail-server/{serverId} | Update a secure mail server |
| AdminTemplateApi | create_custom_template | POST /api/provisioning/v1/admin/tenant/{tenantId}/templates/{templateType} | Create a custom template |
| AdminTemplateApi | delete_custom_template | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/templates/{templateType} | Delete a custom template |
| AdminTemplateApi | get_custom_template | GET /api/provisioning/v1/tenant/{tenantId}/templates/{templateType} | Get a custom template |
| AdminTemplateApi | get_default_template | GET /api/provisioning/v1/templates/{templateType} | Get the server default template |
| AdminTemplateApi | update_custom_template | PUT /api/provisioning/v1/admin/tenant/{tenantId}/templates/{templateType} | Update a custom template |
| AdminTenantApi | create_tenant | POST /api/provisioning/v1/admin/tenant | Create a new tenant |
| AdminTenantApi | delete_tenant | DELETE /api/provisioning/v1/admin/tenant/{tenantId} | Delete a tenant |
| AdminTenantApi | disable_all_tenant_users | POST /api/provisioning/v1/admin/tenant/{tenantId}/disable-users | Disable all users |
| AdminTenantApi | enable_all_tenant_users | POST /api/provisioning/v1/admin/tenant/{tenantId}/enable-users | Enable all users |
| AdminTenantApi | get_tenant | GET /api/provisioning/v1/admin/tenant/{tenantId} | Get a full tenant description |
| AdminTenantApi | list_tenants | GET /api/provisioning/v1/admin/tenant | List tenants |
| AdminTenantApi | update_tenant | PUT /api/provisioning/v1/admin/tenant/{tenantId} | Edit a tenant |
| AdminTenantUserApi | create_user | POST /api/provisioning/v1/admin/tenant/{tenantId}/user | Create a new user |
| AdminTenantUserApi | delete_signature_image | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/user/{userId}/signature-image | Delete user's signature image |
| AdminTenantUserApi | get_signature_image | GET /api/provisioning/v1/admin/tenant/{tenantId}/user/{userId}/signature-image | Get user's signature image |
| AdminTenantUserApi | get_user | GET /api/provisioning/v1/admin/tenant/{tenantId}/user/{userId} | Get a full user description |
| AdminTenantUserApi | list_tenant_users | GET /api/provisioning/v1/admin/tenant/{tenantId}/user | List all users associated with the tenant |
| AdminTenantUserApi | remove_user | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/user/{userId} | Remove the given user from the tenant, deleting it if it was the last tenant linked |
| AdminTenantUserApi | set_signature_image | POST /api/provisioning/v1/admin/tenant/{tenantId}/user/{userId}/signature-image | Create user's signature image |
| AdminTenantUserApi | update_signature_image | PUT /api/provisioning/v1/admin/tenant/{tenantId}/user/{userId}/signature-image | Replace user's signature image |
| AdminTenantUserApi | update_user | PUT /api/provisioning/v1/admin/tenant/{tenantId}/user/{userId} | Edit a user |
| AdminTypologyApi | create_subtype | POST /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId}/subtype | Create a subtype |
| AdminTypologyApi | create_type | POST /api/provisioning/v1/admin/tenant/{tenantId}/typology/type | Create a type |
| AdminTypologyApi | delete_subtype | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId}/subtype/{subtypeId} | Delete a subtype |
| AdminTypologyApi | delete_type | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId} | Delete a type |
| AdminTypologyApi | get_subtype | GET /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId}/subtype/{subtypeId} | Get a subtype with every information set |
| AdminTypologyApi | get_type | GET /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId} | Get a type with every information set |
| AdminTypologyApi | list_subtypes | GET /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId}/subtype | Get subtypes |
| AdminTypologyApi | list_types | GET /api/provisioning/v1/admin/tenant/{tenantId}/typology/type | List types |
| AdminTypologyApi | update_subtype | PUT /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId}/subtype/{subtypeId} | Edit a subtype |
| AdminTypologyApi | update_type | PUT /api/provisioning/v1/admin/tenant/{tenantId}/typology/type/{typeId} | Edit a type |
| AdminWorkflowDefinitionApi | create_workflow_definition | POST /api/provisioning/v1/admin/tenant/{tenantId}/workflow-definition | Create a workflow definition |
| AdminWorkflowDefinitionApi | delete_workflow_definition | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/workflow-definition/{workflowDefinitionKey} | Delete a workflow definition |
| AdminWorkflowDefinitionApi | delete_workflow_definition_legacy | DELETE /api/provisioning/v1/admin/tenant/{tenantId}/workflowDefinition/{workflowDefinitionKey} | Delete a workflow definition |
| AdminWorkflowDefinitionApi | get_workflow_definition | GET /api/provisioning/v1/admin/tenant/{tenantId}/workflow-definition/{workflowDefinitionKey} | Get a workflow definition with every information set |
| AdminWorkflowDefinitionApi | list_workflow_definitions | GET /api/provisioning/v1/admin/tenant/{tenantId}/workflow-definition | List workflow definitions |
| AdminWorkflowDefinitionApi | list_workflow_definitions_legacy | GET /api/provisioning/v1/admin/tenant/{tenantId}/workflowDefinition | List workflow definitions |
| AdminWorkflowDefinitionApi | update_workflow_definition | PUT /api/provisioning/v1/admin/tenant/{tenantId}/workflow-definition/{workflowDefinitionKey} | Edit a workflow definition |
Documentation For Models
- CertificateInformations
- CreateSealCertificateDeprecatedRequest
- DelegationDto
- DelegationSortBy
- DeskDto
- DeskRepresentation
- ErrorResponse
- ExternalSignatureConfigDto
- ExternalSignatureConfigRepresentation
- ExternalSignatureConfigSortBy
- ExternalSignatureLevel
- ExternalSignatureProvider
- InternalMetadata
- LayerRepresentation
- LayerSortBy
- ListableUser
- MetadataDto
- MetadataRepresentation
- MetadataSortBy
- MetadataType
- PageDelegationDto
- PageDeskRepresentation
- PageExternalSignatureConfigRepresentation
- PageListableUser
- PageMetadataRepresentation
- PageSealCertificateRepresentation
- PageSecureMailServerRepresentation
- PageSubtypeRepresentation
- PageTenantRepresentation
- PageTypeRepresentation
- PageWorkflowDefinitionRepresentation
- PageableObject
- PdfSignaturePosition
- SealCertificateDto
- SealCertificateRepresentation
- SealCertificateSortBy
- SecureMailServerDto
- SecureMailServerRepresentation
- SignatureFormat
- SignatureProtocol
- SortObject
- StepDefinitionDto
- StepDefinitionParallelType
- StepDefinitionType
- SubtypeDto
- SubtypeLayerAssociation
- SubtypeLayerDto
- SubtypeMetadataDto
- SubtypeRepresentation
- TemplateInfo
- TemplateType
- TenantDto
- TenantRepresentation
- TenantSortBy
- TypeDto
- TypeRepresentation
- TypologySortBy
- UpdateSealCertificateDeprecatedRequest
- UpdateSignatureImageAsSuperAdminRequest
- UserDto
- UserPrivilege
- UserRepresentation
- UserSortBy
- WorkflowDefinitionDto
- WorkflowDefinitionRepresentation
- WorkflowDefinitionSortBy
Documentation For Authorization
Authentication schemes defined for the API:
spring_oauth
- Type: OAuth
- Flow: accessCode
- Authorization URL: ./auth/realms/api/protocol/openid-connect/auth
- Scopes: N/A
Author
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file iparapheur_provisioning-0.0.20260427155707.tar.gz.
File metadata
- Download URL: iparapheur_provisioning-0.0.20260427155707.tar.gz
- Upload date:
- Size: 89.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
10d26c31e41a385e5b53fcbaba9faf4c2fdc647d7294a5c2c25e47aa1357071e
|
|
| MD5 |
66a5ada40799931ee31d9929b3a6d891
|
|
| BLAKE2b-256 |
7550e5b1f5abe485d528e436aa4f82fd06e99a8507356ce451d52d6c14bebe2a
|
