Schémas : administration

Schémas dont la première opération qui les emploie appartient à la famille administration. Un schéma partagé est décrit une seule fois, ici, et lié depuis toutes les opérations qui l'emploient.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

`AccessScope`

Perimetre FERME d'un acces exceptionnel : des lectures, jamais une ecriture.

Type : string

Valeurs admises : applications, policies, audit

Employé par : adminConsentExceptionalAccess, adminListExceptionalAccess, adminOpposeExceptionalAccess, adminRefuseExceptionalAccess, adminRevokeExceptionalAccess

`AdminProfileIn`

Fiche d'un collegue corrigee par un administrateur : nom affiche et fonction.

Type : object

Propriété	Type	Requis	Description	Contraintes
`display_name`	`string`	oui		minLength: 2 ; maxLength: 120
`job_title`	`string \| null`	non	Fonction (intitule de poste). Vide ou absente : aucune. Ne donne aucun droit.	maxLength: 120

Employé par : adminUpdateUserProfile

`ApiCredentialIn`

Identifiant machine a emettre.

Type : object

Propriété	Type	Requis	Contraintes
`expires_at`	`string (date-time) \| null`	non
`name`	`string`	oui	minLength: 1 ; maxLength: 120
`scopes`	`array<string>`	oui	minItems: 1 ; maxItems: 8

Employé par : adminIssueApiCredential

`ApiCredentialIssuedOut`

Identifiant emis. `secret` n'est rendu qu'ici, une seule fois.

Type : object

Propriété	Type	Requis
`id`	`string (uuid)`	oui
`prefix`	`string`	oui
`secret`	`string`	oui

Employé par : adminIssueApiCredential

`ApiCredentialOut`

Identifiant machine, sans secret.

Type : object

Propriété	Type	Requis
`created_at`	`string (date-time)`	oui
`expires_at`	`string (date-time) \| null`	oui
`id`	`string (uuid)`	oui
`last_used_at`	`string (date-time) \| null`	oui
`name`	`string`	oui
`prefix`	`string`	oui
`revoked_at`	`string (date-time) \| null`	oui
`scopes`	`array<string>`	oui

Employé par : adminListApiCredentials

`ApplicantScope`

Nature des demandeurs auxquels le produit s'adresse.

Type : string

Valeurs admises : natural_person, legal_entity, both

Employé par : adminActivateCreditProduct, adminArchiveCreditProduct, adminCreateCreditProduct, adminListCreditProducts, adminUpdateCreditProduct

`AuditEventOut`

Evenement d'audit, tel qu'un auditeur le lit.

Type : object

Propriété	Type	Requis
`action`	`string`	oui
`actor_id`	`string \| null`	oui
`actor_type`	`string`	oui
`correlation_id`	`string`	oui
`event_hash`	`string`	oui
`occurred_at`	`string (date-time)`	oui
`resource_id`	`string`	oui
`resource_type`	`string`	oui
`sequence`	`integer`	oui

Employé par : adminListAuditEvents

`ConsentMode`

Regime de consentement fixe par le contrat de l'institution (ADR-0046).

Type : string

Valeurs admises : prior_consent, notification_with_opposition

Employé par : adminConsentExceptionalAccess, adminListExceptionalAccess, adminOpposeExceptionalAccess, adminRefuseExceptionalAccess, adminRevokeExceptionalAccess

`CreditProductCategory`

Famille de credit (Architecture §6.2 : microcredit, PME, consommation, immobilier).

Type : string

Valeurs admises : microcredit, sme, consumer, mortgage, other

Employé par : adminActivateCreditProduct, adminArchiveCreditProduct, adminCreateCreditProduct, adminListCreditProducts, adminUpdateCreditProduct, deskProductForm, deskProducts, policiesReferenceGrids

`CreditProductIn`

Saisie d'un produit de credit.

Type : object

Propriété	Type	Requis	Contraintes
`applicant_scope`	`ApplicantScope`	oui
`category`	`CreditProductCategory`	oui
`code`	`string`	oui	minLength: 2 ; maxLength: 32
`currency`	`string \| null`	non	minLength: 3 ; maxLength: 3
`name`	`string`	oui	minLength: 1 ; maxLength: 120
`name_en`	`string \| null`	non	maxLength: 120

Employé par : adminCreateCreditProduct, adminUpdateCreditProduct

`CreditProductOut`

Produit de credit.

Type : object

Propriété	Type	Requis
`applicant_scope`	`ApplicantScope`	oui
`category`	`CreditProductCategory`	oui
`code`	`string`	oui
`currency`	`string`	oui
`id`	`string (uuid)`	oui
`name`	`string`	oui
`name_en`	`string \| null`	oui
`status`	`CreditProductStatus`	oui

Employé par : adminActivateCreditProduct, adminArchiveCreditProduct, adminCreateCreditProduct, adminListCreditProducts, adminUpdateCreditProduct

`CreditProductStatus`

Cycle de vie d'un produit : brouillon, actif, archive. Jamais supprime.

Type : string

Valeurs admises : draft, active, archived

Employé par : adminActivateCreditProduct, adminArchiveCreditProduct, adminCreateCreditProduct, adminListCreditProducts, adminUpdateCreditProduct

`CustomFieldEntity`

Objet auquel un champ personnalise s'attache.

Type : string

Valeurs admises : applicant, credit_application

Employé par : adminCreateCustomField, adminListCustomFields

`CustomFieldIn`

Definition d'un champ personnalise.

Type : object

Propriété	Type	Requis	Contraintes
`choices`	`array<string> \| null`	non	maxItems: 50
`code`	`string`	oui	minLength: 2 ; maxLength: 48
`entity`	`CustomFieldEntity`	oui
`field_type`	`CustomFieldType`	oui
`label_en`	`string \| null`	non	maxLength: 120
`label_fr`	`string`	oui	minLength: 1 ; maxLength: 120
`required`	`boolean`	non	default: false

Employé par : adminCreateCustomField

`CustomFieldOut`

Champ personnalise.

Type : object

Propriété	Type	Requis
`choices`	`array<string> \| null`	oui
`code`	`string`	oui
`created_at`	`string (date-time)`	oui
`entity`	`CustomFieldEntity`	oui
`field_type`	`CustomFieldType`	oui
`id`	`string (uuid)`	oui
`label_en`	`string \| null`	oui
`label_fr`	`string`	oui
`required`	`boolean`	oui
`status`	`CustomFieldStatus`	oui

Employé par : adminCreateCustomField, adminListCustomFields

`CustomFieldStatus`

Un champ retire reste defini : des valeurs anciennes peuvent s'y rapporter.

Type : string

Valeurs admises : active, retired

Employé par : adminCreateCustomField, adminListCustomFields

`CustomFieldType`

Types de valeur admis. Volontairement fermes : un type libre n'est pas validable.

Type : string

Valeurs admises : text, integer, decimal, date, boolean, choice

Employé par : adminCreateCustomField, adminListCustomFields

`ExceptionalAccessDecisionOut`

Issue d'une decision ; l'invitation de support si le consentement en a emis une.

Type : object

Propriété	Type	Requis	Description	Contraintes
`grant`	`ExceptionalAccessOut`	oui
`invitation`	`InvitationIssuedOut \| null`	oui

Employé par : adminConsentExceptionalAccess, adminOpposeExceptionalAccess, adminRefuseExceptionalAccess, adminRevokeExceptionalAccess

`ExceptionalAccessOut`

Autorisation d'acces exceptionnel recue de CONTROL, et ce qui s'est fait sous elle.

Type : object

Propriété	Type	Requis	Description
`consent_mode`	`ConsentMode`	oui
`consultations`	`array<SupportConsultationOut>`	oui
`decided_at`	`string (date-time) \| null`	oui
`decided_by`	`string (uuid) \| null`	oui
`grant_id`	`string (uuid)`	oui
`motive`	`string`	oui
`not_after`	`string (date-time)`	oui
`operator_email`	`string`	oui
`opposition_deadline`	`string (date-time) \| null`	oui
`received_at`	`string (date-time)`	oui
`scopes`	`array<AccessScope>`	oui
`status`	`GrantStatus`	oui	Etat EFFECTIF : echeance et delai compris.
`ticket_reference`	`string`	oui
`user_id`	`string (uuid) \| null`	oui	Identite de support, une fois l'invitation acceptee.

Employé par : adminConsentExceptionalAccess, adminListExceptionalAccess, adminOpposeExceptionalAccess, adminRefuseExceptionalAccess, adminRevokeExceptionalAccess

`GrantStatus`

Etat d'une autorisation, tel qu'un administrateur le lit.

Type : string

Valeurs admises : pending_consent, notified, active, refused, opposed, revoked, expired

Employé par : adminConsentExceptionalAccess, adminListExceptionalAccess, adminOpposeExceptionalAccess, adminRefuseExceptionalAccess, adminRevokeExceptionalAccess

`InvitationIn`

Invitation a emettre.

Type : object

Propriété	Type	Requis	Contraintes
`delegation_limit`	`number \| string \| null`	non	exclusiveMinimum: 0 ; pattern: "^(?!^[-+.]$)[+-]?0(?:\\d{0,16}\|(?=[\\d.]{1,19}0$)\\d{0,16}\\.\\d{0,2}0$)"
`email`	`string`	oui	minLength: 3 ; maxLength: 320
`locale`	`"fr" \| "en"`	non	default: "fr"
`roles`	`array<Role>`	oui	minItems: 1 ; maxItems: 6

Employé par : adminIssueInvitation

`InvitationIssuedOut`

Invitation emise ; `link` seulement si le courriel n'est pas parti.

Type : object

Propriété	Type	Requis	Description
`delivery`	`"delivered" \| "not_configured" \| "failed"`	oui
`expires_at`	`string (date-time)`	oui
`invitation_id`	`string (uuid)`	oui
`link`	`string \| null`	oui	Lien a transmettre soi-meme ; montre une seule fois.

Employé par : adminConsentExceptionalAccess, adminIssueInvitation, adminOpposeExceptionalAccess, adminRefuseExceptionalAccess, adminReissueInvitation, adminRevokeExceptionalAccess

`InvitationOut`

Invitation, sans jeton.

Type : object

Propriété	Type	Requis
`created_at`	`string (date-time)`	oui
`email`	`string`	oui
`expires_at`	`string (date-time)`	oui
`id`	`string (uuid)`	oui
`roles`	`array<Role>`	oui
`status`	`"pending" \| "accepted" \| "revoked" \| "expired"`	oui

Employé par : adminListInvitations

`MonthlyUsageOut`

Usage d'un mois (UTC) : des volumes, jamais un dossier (D4, ADR-0038).

Type : object

Propriété	Type	Requis	Description
`billable_evaluations`	`integer`	oui	Premieres evaluations de dossiers soumis : l'acte facturable.
`month`	`string`	oui	Mois au format AAAA-MM, en temps universel.
`reevaluations`	`integer`	oui	Reevaluations sous une nouvelle politique : comptees, non facturables.

Employé par : adminReadUsage

`PendingRecoveryOut`

Lien de retablissement en attente (ADR-0061) ; `expired` s'il est echu.

Type : object

Propriété	Type	Requis
`expired`	`boolean`	oui
`expires_at`	`string (date-time)`	oui
`kind`	`RecoveryKind`	oui

Employé par : adminDisableUser, adminGetUser, adminListUsers, adminReactivateUser, adminSetUserRoles, adminSuspendUser, adminUpdateUserProfile, meUpdateProfile

`Permission`

Actions autorisables, au format `domaine.action`.

Type : string

Valeurs admises : institution.read, users.read, users.invite, users.manage, roles.assign, credit_products.read, credit_products.manage, custom_fields.read, custom_fields.manage, integrations.read, integrations.manage, audit.read, usage.read, policies.read, policies.manage, policies.approve, scorecard.read, applications.read, applications.write, applications.decide, imports.read, imports.write, knowledge.read, knowledge.manage, exceptional_access.decide, trust.read, trust.configure, consents.read, consents.record, data_rights.read, data_rights.manage, pilot.read, pilot.manage, modules.read, modules.request

Employé par : adminListRoles, me

`RecoveryIn`

Nature du lien de retablissement : le facteur a remplacer.

Type : object

Propriété	Type	Requis	Description	Contraintes
`kind`	`RecoveryKind`	oui

Employé par : adminIssueAccountRecovery

`RecoveryIssuedOut`

Lien emis ; `link` seulement si le courriel n'est pas parti.

Type : object

Propriété	Type	Requis	Description
`delivery`	`"delivered" \| "not_configured" \| "failed"`	oui
`expires_at`	`string (date-time)`	oui
`kind`	`RecoveryKind`	oui
`link`	`string \| null`	oui	Lien a transmettre soi-meme ; montre une seule fois.
`recovery_id`	`string (uuid)`	oui

Employé par : adminIssueAccountRecovery

`Role`

Roles institutionnels de reference (Specifications A.1).

Type : string

Valeurs admises : institution_admin, risk_director, policy_approver, credit_analyst, credit_manager, audit_compliance, nexclara_support

Employé par : adminDisableUser, adminGetUser, adminIssueInvitation, adminListInvitations, adminListRoles, adminListUsers, adminReactivateUser, adminSetUserRoles, adminSuspendUser, adminUpdateUserProfile, invitationInspect, me, meUpdateProfile

`RoleDescriptionOut`

Description d'un role : famille et permissions.

Type : object

Propriété	Type	Requis
`family`	`RoleFamily`	oui
`permissions`	`array<Permission>`	oui
`role`	`Role`	oui

Employé par : adminListRoles

`RoleFamily`

Familles de roles mutuellement exclusives (Architecture §11).

Type : string

Valeurs admises : configuration, decision, audit, support

Employé par : adminListRoles

`RolesIn`

Nouvel ensemble de roles d'un compte.

Type : object

Propriété	Type	Requis	Description	Contraintes
`delegation_limit`	`number \| string \| null`	non		exclusiveMinimum: 0 ; pattern: "^(?!^[-+.]$)[+-]?0(?:\\d{0,16}\|(?=[\\d.]{1,19}0$)\\d{0,16}\\.\\d{0,2}0$)"
`roles`	`array<Role>`	oui		minItems: 0 ; maxItems: 6

Employé par : adminSetUserRoles

`SessionsRevokedOut`

Nombre de sessions fermees.

Type : object

Propriété	Type	Requis	Description	Contraintes
`revoked`	`integer`	oui

Employé par : adminRevokeUserSessions, meChangePassword, meConfirmSecondFactor, meRevokeOtherSessions

`SupportConsultationOut`

Requete de l'identite de support, telle que le journal l'a consignee.

Type : object

Propriété	Type	Requis	Description
`method`	`string`	oui
`occurred_at`	`string (date-time)`	oui
`route`	`string`	oui	Gabarit de la route, jamais le chemin concret.
`target_id`	`string`	oui	Identifiant vise par le chemin ; vide sinon.
`user_id`	`string \| null`	oui

Employé par : adminConsentExceptionalAccess, adminListExceptionalAccess, adminOpposeExceptionalAccess, adminRefuseExceptionalAccess, adminRevokeExceptionalAccess

`UserOut`

Compte, sans secret.

Type : object

Propriété	Type	Requis	Description	Contraintes
`created_at`	`string (date-time)`	oui
`delegation_limit`	`string \| null`	oui		pattern: "^(?!^[-+.]$)[+-]?0\\d\\.?\\d$"
`display_name`	`string`	oui
`email`	`string`	oui
`id`	`string (uuid)`	oui
`job_title`	`string \| null`	non	Fonction (intitule de poste). Ne donne aucun droit.
`last_login_at`	`string (date-time) \| null`	oui
`locale`	`string`	oui
`pending_recovery`	`PendingRecoveryOut \| null`	non
`roles`	`array<Role>`	oui
`status`	`UserStatus`	oui

Employé par : adminDisableUser, adminGetUser, adminListUsers, adminReactivateUser, adminSetUserRoles, adminSuspendUser, adminUpdateUserProfile, meUpdateProfile

`UserStatus`

Etat d'un compte. Il n'existe pas d'etat « supprime ». Un utilisateur qui a pris des decisions tracees ne disparait jamais de l'histoire : on le DESACTIVE, on ne l'efface pas. La suppression des donnees personnelles d'un ancien collaborateur releve de la retention (Lot 5), pas d'un bouton.

Type : string

Valeurs admises : active, suspended, disabled

Employé par : adminDisableUser, adminGetUser, adminListUsers, adminReactivateUser, adminSetUserRoles, adminSuspendUser, adminUpdateUserProfile, meUpdateProfile