Schemas: identity

Schemas whose first using operation belongs to the identity family. A shared schema is described once, here, and linked from every operation that uses it.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

`AcceptInvitationIn`

Acceptation d'une invitation.

Type : object

Property	Type	Required	Constraints
`display_name`	`string`	yes	minLength: 2 ; maxLength: 120
`institution`	`string`	yes	minLength: 3 ; maxLength: 32
`locale`	`"fr" \| "en"`	no	default: "fr"
`password`	`string`	yes	minLength: 1 ; maxLength: 256
`token`	`string`	yes	minLength: 20 ; maxLength: 128
`totp_code`	`string`	yes	pattern: "^\\s\\d{3}\\s?\\d{3}\\s$"

Used by : invitationAccept

`CodeIn`

Code du second facteur.

Type : object

Property	Type	Required	Description	Constraints
`code`	`string`	yes	Code TOTP a six chiffres.	pattern: "^\\s\\d{3}\\s?\\d{3}\\s$"

Used by : authSecondFactor, authStepUp

`InvitationInspectionOut`

Ce que le detenteur d'un jeton valide peut savoir.

Type : object

Property	Type	Required
`email`	`string`	yes
`expires_at`	`string (date-time)`	yes
`institution_name`	`string`	yes
`roles`	`array<Role>`	yes
`supported_locales`	`array<string>`	yes

Used by : invitationInspect

`LoginIn`

Premiere etape de connexion.

Type : object

Property	Type	Required	Description	Constraints
`email`	`string`	yes		minLength: 3 ; maxLength: 320
`institution`	`string`	yes	Reference de l'institution.	minLength: 3 ; maxLength: 32
`password`	`string`	yes		minLength: 1 ; maxLength: 256

Used by : authLogin

`LoginOut`

Session ouverte, second facteur en attente.

Type : object

Property	Type	Required	Description
`expires_at`	`string (date-time)`	yes
`session_token`	`string`	yes	Jeton opaque, montre une seule fois.
`state`	`"second_factor_required"`	yes

Used by : authLogin

`MeInstitutionOut`

Institution de l'appelant.

Type : object

Property	Type	Required
`base_currency`	`string`	yes
`display_name`	`string`	yes
`short_name`	`string`	yes
`supported_locales`	`array<string>`	yes

Used by : me

`MeOut`

Ce que l'interface doit refleter : identite, roles, permissions effectives.

Type : object

Property	Type	Required	Description
`institution`	`MeInstitutionOut`	yes
`mfa_verified_at`	`string (date-time) \| null`	yes
`open_modules`	`array<ModuleId>`	yes	Modules OUVERTS pour l institution (souscrits ou ouverts au pilote, ADR-0067). La permission de chaque fonction reste exigee ; l API refuse un module ferme.
`permissions`	`array<Permission>`	yes
`roles`	`array<Role>`	yes
`step_up_valid_until`	`string (date-time) \| null`	yes	Fin de validite de l'authentification renforcee.
`user`	`MeUserOut`	yes

Used by : me

`MeUserOut`

Compte de l'appelant.

Type : object

Property	Type	Required	Description
`display_name`	`string`	yes
`email`	`string`	yes
`id`	`string (uuid)`	yes
`job_title`	`string \| null`	no	Fonction (intitule de poste). Ne donne aucun droit.
`locale`	`string`	yes

Used by : me

`ModuleId`

Les onze modules du produit, sous leur identifiant de catalogue.

Type : string

Allowed values : core, clarity, link, desk, trust, admin, signal, shield, sentinel, vision, sage

Used by : me, modulesCatalogue, modulesRequestActivation, modulesWithdrawActivationRequest

`SessionStateOut`

Etat d'une session apres verification du second facteur.

Type : object

Property	Type	Required	Description	Constraints
`idle_expires_at`	`string (date-time)`	yes
`state`	`"authenticated"`	yes

Used by : authSecondFactor, authStepUp