Aller au contenu principal
NEXCLARADocumentation

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éTypeRequisDescriptionContraintes
display_namestringouiminLength: 2 ; maxLength: 120
institutionstringouiminLength: 3 ; maxLength: 32
locale"fr" | "en"nondefault: "fr"
passwordstringouiminLength: 1 ; maxLength: 256
tokenstringouiminLength: 20 ; maxLength: 128
totp_codestringouipattern: "^\\s*\\d{3}\\s?\\d{3}\\s*$"

Employé par : invitationAccept

CodeIn

Code du second facteur.

Type : object

PropriétéTypeRequisDescriptionContraintes
codestringouiCode 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éTypeRequisDescriptionContraintes
emailstringoui
expires_atstring (date-time)oui
institution_namestringoui
rolesarray<Role>oui
supported_localesarray<string>oui

Employé par : invitationInspect

LoginIn

Premiere etape de connexion.

Type : object

PropriétéTypeRequisDescriptionContraintes
emailstringouiminLength: 3 ; maxLength: 320
institutionstringouiReference de l'institution.minLength: 3 ; maxLength: 32
passwordstringouiminLength: 1 ; maxLength: 256

Employé par : authLogin

LoginOut

Session ouverte, second facteur en attente.

Type : object

PropriétéTypeRequisDescriptionContraintes
expires_atstring (date-time)oui
session_tokenstringouiJeton opaque, montre une seule fois.
state"second_factor_required"oui

Employé par : authLogin

MeInstitutionOut

Institution de l'appelant.

Type : object

PropriétéTypeRequisDescriptionContraintes
base_currencystringoui
display_namestringoui
short_namestringoui
supported_localesarray<string>oui

Employé par : me

MeOut

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

Type : object

PropriétéTypeRequisDescriptionContraintes
institutionMeInstitutionOutoui
mfa_verified_atstring (date-time) | nulloui
open_modulesarray<ModuleId>ouiModules OUVERTS pour l institution (souscrits ou ouverts au pilote, ADR-0067). La permission de chaque fonction reste exigee ; l API refuse un module ferme.
permissionsarray<Permission>oui
rolesarray<Role>oui
step_up_valid_untilstring (date-time) | nullouiFin de validite de l'authentification renforcee.
userMeUserOutoui

Employé par : me

MeUserOut

Compte de l'appelant.

Type : object

PropriétéTypeRequisDescriptionContraintes
display_namestringoui
emailstringoui
idstring (uuid)oui
job_titlestring | nullnonFonction (intitule de poste). Ne donne aucun droit.
localestringoui

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éTypeRequisDescriptionContraintes
idle_expires_atstring (date-time)oui
state"authenticated"oui

Employé par : authSecondFactor, authStepUp