Skip to main content
NEXCLARADocumentation

identity

Connexion, second facteur, profil, invitations.

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

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

Parameters

No parameters.

Request body

Content type
application/json
Type
LoginIn
Required
yes

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonLoginOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/auth/logout

Deconnexion

Revoque la session presentee.

authLogout

Parameters

No parameters.

Request body

No request body.

Responses

StatusDescriptionContent typeType
204Successful Response—

POST /api/v1/auth/second-factor

Connexion, seconde etape

Verifie le code TOTP et rend la session pleinement utilisable.

authSecondFactor

Parameters

No parameters.

Request body

Content type
application/json
Type
CodeIn
Required
yes

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonSessionStateOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/auth/step-up

Authentification renforcee

Reverifie le second facteur avant une action sensible.

authStepUp

Parameters

No parameters.

Request body

Content type
application/json
Type
CodeIn
Required
yes

Responses

StatusDescriptionContent typeType
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

Parameters

No parameters.

Request body

Content type
application/json
Type
AcceptInvitationIn
Required
yes

Responses

StatusDescriptionContent typeType
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

Parameters

No parameters.

Request body

Content type
application/json
Type
InvitationTokenIn
Required
yes

Responses

StatusDescriptionContent typeType
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

Parameters

No parameters.

Request body

Content type
application/json
Type
InvitationTokenIn
Required
yes

Responses

StatusDescriptionContent typeType
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

Parameters

No parameters.

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonMeOut