Schémas : identity
Schémas dont la première opération qui les emploie appartient à la famille identity. 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é.
AcceptInvitationIn
Acceptation d'une invitation.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
display_name | string | oui | minLength: 2 ; maxLength: 120 | |
institution | string | oui | minLength: 3 ; maxLength: 32 | |
locale | "fr" | "en" | non | default: "fr" | |
password | string | oui | minLength: 1 ; maxLength: 256 | |
token | string | oui | minLength: 20 ; maxLength: 128 | |
totp_code | string | oui | pattern: "^\\s*\\d{3}\\s?\\d{3}\\s*$" |
Employé par : invitationAccept
CodeIn
Code du second facteur.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
code | string | oui | Code TOTP a six chiffres. | pattern: "^\\s*\\d{3}\\s?\\d{3}\\s*$" |
Employé par : authSecondFactor, authStepUp
InvitationInspectionOut
Ce que le detenteur d'un jeton valide peut savoir.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
email | string | oui | ||
expires_at | string (date-time) | oui | ||
institution_name | string | oui | ||
roles | array<Role> | oui | ||
supported_locales | array<string> | oui |
Employé par : invitationInspect
LoginIn
Premiere etape de connexion.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
email | string | oui | minLength: 3 ; maxLength: 320 | |
institution | string | oui | Reference de l'institution. | minLength: 3 ; maxLength: 32 |
password | string | oui | minLength: 1 ; maxLength: 256 |
Employé par : authLogin
LoginOut
Session ouverte, second facteur en attente.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
expires_at | string (date-time) | oui | ||
session_token | string | oui | Jeton opaque, montre une seule fois. | |
state | "second_factor_required" | oui |
Employé par : authLogin
MeInstitutionOut
Institution de l'appelant.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
base_currency | string | oui | ||
display_name | string | oui | ||
short_name | string | oui | ||
supported_locales | array<string> | oui |
Employé par : me
MeOut
Ce que l'interface doit refleter : identite, roles, permissions effectives.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
institution | MeInstitutionOut | oui | ||
mfa_verified_at | string (date-time) | null | oui | ||
open_modules | array<ModuleId> | oui | 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> | oui | ||
roles | array<Role> | oui | ||
step_up_valid_until | string (date-time) | null | oui | Fin de validite de l'authentification renforcee. | |
user | MeUserOut | oui |
Employé par : me
MeUserOut
Compte de l'appelant.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
display_name | string | oui | ||
email | string | oui | ||
id | string (uuid) | oui | ||
job_title | string | null | non | Fonction (intitule de poste). Ne donne aucun droit. | |
locale | string | oui |
Employé par : me
ModuleId
Les onze modules du produit, sous leur identifiant de catalogue.
Type : string
Valeurs admises : core, clarity, link, desk, trust, admin, signal, shield, sentinel, vision, sage
Employé par : me, modulesCatalogue, modulesRequestActivation, modulesWithdrawActivationRequest
SessionStateOut
Etat d'une session apres verification du second facteur.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
idle_expires_at | string (date-time) | oui | ||
state | "authenticated" | oui |
Employé par : authSecondFactor, authStepUp