Schémas : account
Schémas dont la première opération qui les emploie appartient à la famille account. 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é.
EnrollmentOut
Cle TOTP a enroler, montree une seule fois.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
provisioning_uri | string | oui | ||
secret | string | oui |
Employé par : accountRecoveryEnrollment, invitationEnrollment
HTTPValidationError
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
detail | array<ValidationError> | non |
Employé par : accountRecoveryComplete, accountRecoveryEnrollment, accountRecoveryInspect, adminActivateCreditProduct, adminArchiveCreditProduct, adminConsentExceptionalAccess, adminCreateCreditProduct, adminCreateCustomField, adminDisableUser, adminGetUser, adminIssueAccountRecovery, adminIssueApiCredential, adminIssueInvitation, adminListAuditEvents, adminOpposeExceptionalAccess, adminReactivateUser, adminReadUsage, adminRefuseExceptionalAccess, adminReissueInvitation, adminRetireCustomField, adminRevokeAccountRecovery, adminRevokeApiCredential, adminRevokeExceptionalAccess, adminRevokeInvitation, adminRevokeUserSessions, adminSetUserRoles, adminSuspendUser, adminUpdateCreditProduct, adminUpdateUserProfile, applicationsApplicantHistory, applicationsConsents, applicationsCreate, applicationsDecide, applicationsEscalate, applicationsExportEvidence, applicationsGet, applicationsList, applicationsRecordConsent, applicationsReevaluate, applicationsSubmit, applicationsUpdate, authLogin, authSecondFactor, authStepUp, deskProductForm, evaluationsGet, evaluationsReconstitute, historicalDatasetsFreeze, historicalDatasetsGet, historicalDatasetsList, historicalSimulationsGet, historicalSimulationsList, historicalSimulationsReconstitute, historicalSimulationsSeal, historicalSimulationsStart, invitationAccept, invitationEnrollment, invitationInspect, knowledgeAnswer, knowledgeCommonRead, knowledgeDocumentDelete, knowledgeDocumentPut, knowledgeDocumentRead, knowledgeSearch, linkApplicationProvenance, linkBatchConfirm, linkBatchErrorReport, linkBatchGet, linkBatchList, linkBatchPrevalidate, linkBatchQuality, linkBatchRequeue, linkBatchRows, linkFileGet, linkFileUpload, linkMappingList, linkMappingSave, linkProductContract, linkProductTemplate, meChangePassword, meConfirmSecondFactor, meListSecurityEvents, meRevokeSession, meUpdateProfile, modulesRequestActivation, modulesWithdrawActivationRequest, pilotAttestStep, policiesApprove, policiesArchive, policiesCreate, policiesDerive, policiesGet, policiesList, policiesReject, policiesSetParameters, policiesSimulate, policiesSubmit, trustAcceptErasure, trustAccessReport, trustCompleteRectification, trustComplianceReport, trustConfirmRetention, trustCreatePurpose, trustExportComplianceReport, trustGetRightsRequest, trustListRightsRequests, trustPurgeAttestation, trustRefuseRightsRequest, trustRegisterRightsRequest, trustRetirePurpose
InvitationTokenIn
Jeton d'invitation et institution, transmis par le destinataire.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
institution | string | oui | minLength: 3 ; maxLength: 32 | |
token | string | oui | minLength: 20 ; maxLength: 128 |
Employé par : accountRecoveryEnrollment, accountRecoveryInspect, invitationEnrollment, invitationInspect
OwnSessionOut
Une session de l'appelant. Aucune adresse IP ni agent : rien n'en est recueilli.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
absolute_expires_at | string (date-time) | oui | ||
created_at | string (date-time) | oui | ||
current | boolean | oui | ||
id | string (uuid) | oui | ||
idle_expires_at | string (date-time) | oui | ||
last_seen_at | string (date-time) | oui | ||
state | "authenticated" | "second_factor_pending" | oui |
Employé par : meListSessions
PasswordChangeIn
Changement de mot de passe : l'actuel prouve, le nouveau propose.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
current_password | string | oui | minLength: 1 ; maxLength: 256 | |
new_password | string | oui | minLength: 1 ; maxLength: 256 |
Employé par : meChangePassword
ProfileIn
Sa propre presentation : nom affiche, fonction, langue.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
display_name | string | oui | minLength: 2 ; maxLength: 120 | |
job_title | string | null | non | Fonction (intitule de poste). Vide ou absente : aucune. Ne donne aucun droit. | maxLength: 120 |
locale | "fr" | "en" | oui |
Employé par : meUpdateProfile
RecoveryCompleteIn
Achevement : preuve du facteur restant, facteur nouveau. `second_factor` : `password` (actuel) et `totp_code` (de la nouvelle cle). `password` : `totp_code` (de la cle en service) et `new_password`.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
institution | string | oui | minLength: 3 ; maxLength: 32 | |
new_password | string | null | non | minLength: 1 ; maxLength: 256 | |
password | string | null | non | 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 : accountRecoveryComplete
RecoveryInspectionOut
Ce que le detenteur d'un lien valide peut savoir.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
email | string | oui | ||
expires_at | string (date-time) | oui | ||
institution_name | string | oui | ||
kind | RecoveryKind | oui |
Employé par : accountRecoveryInspect
RecoveryKind
Facteur que remplace un lien de retablissement (ADR-0061, decision 4). UN FACTEUR A LA FOIS. Le lien ne remplace jamais les deux : l'interesse prouve toujours celui qui reste. Un administrateur qui verrait le lien ne detient donc jamais de quoi prendre le compte.
Type : string
Valeurs admises : password, second_factor
Employé par : accountRecoveryInspect, adminDisableUser, adminGetUser, adminIssueAccountRecovery, adminListUsers, adminReactivateUser, adminSetUserRoles, adminSuspendUser, adminUpdateUserProfile, meUpdateProfile
SecondFactorCodeIn
Code de la NOUVELLE cle, qui la prouve.
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 : meConfirmSecondFactor
SecondFactorEnrollmentOut
Nouvelle cle TOTP, montree une seule fois ; l'ancienne reste en service.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
expires_at | string (date-time) | oui | Au-dela, l'enrolement est a recommencer. | |
provisioning_uri | string | oui | ||
secret | string | oui |
Employé par : meBeginSecondFactor
SecurityEventOut
Evenement de securite du compte, lu dans la chaine d'audit.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
action | string | oui | Code d'action d'audit (`user.login.succeeded`, ...). | |
by_self | boolean | oui | Vrai si l'interesse a agi lui-meme. | |
detail | map<string, string | integer | boolean | null> | oui | ||
occurred_at | string (date-time) | oui | ||
sequence | integer | oui |
Employé par : meListSecurityEvents
ValidationError
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
ctx | object | non | ||
input | any | non | ||
loc | array<string | integer> | oui | ||
msg | string | oui | ||
type | string | oui |
Employé par : accountRecoveryComplete, accountRecoveryEnrollment, accountRecoveryInspect, adminActivateCreditProduct, adminArchiveCreditProduct, adminConsentExceptionalAccess, adminCreateCreditProduct, adminCreateCustomField, adminDisableUser, adminGetUser, adminIssueAccountRecovery, adminIssueApiCredential, adminIssueInvitation, adminListAuditEvents, adminOpposeExceptionalAccess, adminReactivateUser, adminReadUsage, adminRefuseExceptionalAccess, adminReissueInvitation, adminRetireCustomField, adminRevokeAccountRecovery, adminRevokeApiCredential, adminRevokeExceptionalAccess, adminRevokeInvitation, adminRevokeUserSessions, adminSetUserRoles, adminSuspendUser, adminUpdateCreditProduct, adminUpdateUserProfile, applicationsApplicantHistory, applicationsConsents, applicationsCreate, applicationsDecide, applicationsEscalate, applicationsExportEvidence, applicationsGet, applicationsList, applicationsRecordConsent, applicationsReevaluate, applicationsSubmit, applicationsUpdate, authLogin, authSecondFactor, authStepUp, deskProductForm, evaluationsGet, evaluationsReconstitute, historicalDatasetsFreeze, historicalDatasetsGet, historicalDatasetsList, historicalSimulationsGet, historicalSimulationsList, historicalSimulationsReconstitute, historicalSimulationsSeal, historicalSimulationsStart, invitationAccept, invitationEnrollment, invitationInspect, knowledgeAnswer, knowledgeCommonRead, knowledgeDocumentDelete, knowledgeDocumentPut, knowledgeDocumentRead, knowledgeSearch, linkApplicationProvenance, linkBatchConfirm, linkBatchErrorReport, linkBatchGet, linkBatchList, linkBatchPrevalidate, linkBatchQuality, linkBatchRequeue, linkBatchRows, linkFileGet, linkFileUpload, linkMappingList, linkMappingSave, linkProductContract, linkProductTemplate, meChangePassword, meConfirmSecondFactor, meListSecurityEvents, meRevokeSession, meUpdateProfile, modulesRequestActivation, modulesWithdrawActivationRequest, pilotAttestStep, policiesApprove, policiesArchive, policiesCreate, policiesDerive, policiesGet, policiesList, policiesReject, policiesSetParameters, policiesSimulate, policiesSubmit, trustAcceptErasure, trustAccessReport, trustCompleteRectification, trustComplianceReport, trustConfirmRetention, trustCreatePurpose, trustExportComplianceReport, trustGetRightsRequest, trustListRightsRequests, trustPurgeAttestation, trustRefuseRightsRequest, trustRegisterRightsRequest, trustRetirePurpose