Aller au contenu principal
NEXCLARADocumentation

identity

Connexion, second facteur, profil, invitations.

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

POST /api/v1/auth/login

Connexion, premiere etape

Verifie la reference de l'institution, l'adresse et le mot de passe. Ouvre une session courte qui ne donne acces qu'a la verification du second facteur.

authLogin

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
LoginIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonLoginOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/auth/logout

Deconnexion

Revoque la session presentee.

authLogout

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
204Successful Response—

POST /api/v1/auth/second-factor

Connexion, seconde etape

Verifie le code TOTP et rend la session pleinement utilisable.

authSecondFactor

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
CodeIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonSessionStateOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/auth/step-up

Authentification renforcee

Reverifie le second facteur avant une action sensible.

authStepUp

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
CodeIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonSessionStateOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/invitations/accept

Accepter une invitation

Cree le compte, second facteur prouve par un code valide.

invitationAccept

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
AcceptInvitationIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
201Successful Response—
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/invitations/enrollment

Enroler le second facteur

Genere la cle TOTP a enroler. Un nouvel appel remplace la precedente.

invitationEnrollment

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
InvitationTokenIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonEnrollmentOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/invitations/inspect

Inspecter une invitation

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

invitationInspect

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
InvitationTokenIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonInvitationInspectionOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/me

Appelant authentifie

Identite, roles et permissions EFFECTIVES de l'appelant. L'interface s'y conforme ; l'autorisation, elle, est appliquee par chaque operation.

me

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonMeOut