trust
Le contrat ne décrit pas cette famille.
Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.
GET /api/v1/applications/{application_id}/consents
Consentements du demandeur d'un dossier
Etat par finalite active et historique ; la lecture est journalisee (P56).
applicationsConsents
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
application_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | ApplicantConsentsOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/applications/{application_id}/consents
Enregistrer un recueil ou un retrait de consentement
Evenement de consentement, avec la reference de sa piece (`consents.record`).
applicationsRecordConsent
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
application_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
ConsentIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
201 | Successful Response | application/json | ApplicantConsentsOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/compliance-report
Rapport de conformite
Cinq sections calculees sur la periode, sous `audit.read`.
trustComplianceReport
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
start | query | string (date) | oui | |
end | query | string (date) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | ComplianceReportOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/compliance-report/export
Exporter le rapport de conformite en preuve signee
`nexclara-compliance-report@1`, signe par la cle d'instance si configuree.
trustExportComplianceReport
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
start | query | string (date) | oui | |
end | query | string (date) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Preuve canonique, a verifier hors du service. | application/json | EvidenceBundleOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/consent-purposes
Finalites de consentement
Versions de finalite, actives et retirees.
trustListPurposes
Paramètres
Aucun paramètre.
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<ConsentPurposeOut> |
POST /api/v1/trust/consent-purposes
Definir une finalite (nouvelle version)
Nouvelle version ; la version active du meme code est retiree (`trust.configure`).
trustCreatePurpose
Paramètres
Aucun paramètre.
Corps de la requête
- Type de contenu
application/json- Type
ConsentPurposeIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
201 | Successful Response | application/json | ConsentPurposeOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/consent-purposes/{purpose_id}/retire
Retirer une finalite
Retire une version active ; les consentements donnes demeurent.
trustRetirePurpose
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
purpose_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | ConsentPurposeOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/data-rights
Demandes de droits
Demandes, recentes d'abord, filtrees par etat.
trustListRightsRequests
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
status | query | "open" | "awaiting_purge" | "completed" | "refused" | null | non |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<RightsRequestOut> |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights
Enregistrer une demande d'exercice de droits
Demande enregistree, echeance fixee ; la reference presentee n'est pas conservee.
trustRegisterRightsRequest
Paramètres
Aucun paramètre.
Corps de la requête
- Type de contenu
application/json- Type
RightsRequestIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
201 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/data-rights/{request_id}
Une demande
Une demande et son echeance.
trustGetRightsRequest
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
request_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/accept-erasure
Accepter un effacement
Effacement accepte : la prochaine purge l'execute, l'atteste et clot la demande.
trustAcceptErasure
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
request_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
RightsTransitionIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/access-report
Emettre le releve d'acces et clore la demande
`nexclara-subject-access-report@1`, signe ; la demande est close.
trustAccessReport
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
request_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
AccessReportIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Preuve canonique, a verifier hors du service. | application/json | EvidenceBundleOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/complete-rectification
Clore une rectification faite a la source
La donnee a ete corrigee dans le systeme de l'institution ; NEXCLARA ne la reecrit pas.
trustCompleteRectification
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
request_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
RightsTransitionIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/trust/data-rights/{request_id}/refuse
Refuser une demande, motif code
Refus avec un motif de la liste fermee ; aucun texte libre.
trustRefuseRightsRequest
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
request_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
RefusalIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | RightsRequestOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/purge-runs
Executions de purge
Executions recentes d'abord : comptes, empreinte de l'attestation.
trustPurgeRuns
Paramètres
Aucun paramètre.
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<PurgeRunOut> |
GET /api/v1/trust/purge-runs/{run_id}/attestation
Telecharger une attestation de destruction
`nexclara-destruction-attestation@1`, octets tels qu'emis et signes.
trustPurgeAttestation
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
run_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Preuve canonique, a verifier hors du service. | application/json | EvidenceBundleOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/trust/retention
Durees de conservation
Durees en vigueur (provisoires ou confirmees) et elements echus.
trustRetention
Paramètres
Aucun paramètre.
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | RetentionOut |
PUT /api/v1/trust/retention/{category}
Confirmer une duree de conservation
Confirme une duree (authentification renforcee) : la purge s'y appliquera.
trustConfirmRetention
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
category | path | RetentionCategory | oui |
Corps de la requête
- Type de contenu
application/json- Type
RetentionIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | RetentionOut |
422 | Validation Error | application/json | HTTPValidationError |