Schemas: account
Schemas whose first using operation belongs to the account family. A shared schema is described once, here, and linked from every operation that uses it.
Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.
EnrollmentOut
Cle TOTP a enroler, montree une seule fois.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
provisioning_uri | string | yes | ||
secret | string | yes |
Used by : accountRecoveryEnrollment, invitationEnrollment
HTTPValidationError
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
detail | array<ValidationError> | no |
Used by : 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
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
institution | string | yes | minLength: 3 ; maxLength: 32 | |
token | string | yes | minLength: 20 ; maxLength: 128 |
Used by : accountRecoveryEnrollment, accountRecoveryInspect, invitationEnrollment, invitationInspect
OwnSessionOut
Une session de l'appelant. Aucune adresse IP ni agent : rien n'en est recueilli.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
absolute_expires_at | string (date-time) | yes | ||
created_at | string (date-time) | yes | ||
current | boolean | yes | ||
id | string (uuid) | yes | ||
idle_expires_at | string (date-time) | yes | ||
last_seen_at | string (date-time) | yes | ||
state | "authenticated" | "second_factor_pending" | yes |
Used by : meListSessions
PasswordChangeIn
Changement de mot de passe : l'actuel prouve, le nouveau propose.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
current_password | string | yes | minLength: 1 ; maxLength: 256 | |
new_password | string | yes | minLength: 1 ; maxLength: 256 |
Used by : meChangePassword
ProfileIn
Sa propre presentation : nom affiche, fonction, langue.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
display_name | string | yes | minLength: 2 ; maxLength: 120 | |
job_title | string | null | no | Fonction (intitule de poste). Vide ou absente : aucune. Ne donne aucun droit. | maxLength: 120 |
locale | "fr" | "en" | yes |
Used by : 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
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
institution | string | yes | minLength: 3 ; maxLength: 32 | |
new_password | string | null | no | minLength: 1 ; maxLength: 256 | |
password | string | null | no | minLength: 1 ; maxLength: 256 | |
token | string | yes | minLength: 20 ; maxLength: 128 | |
totp_code | string | yes | pattern: "^\\s*\\d{3}\\s?\\d{3}\\s*$" |
Used by : accountRecoveryComplete
RecoveryInspectionOut
Ce que le detenteur d'un lien valide peut savoir.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
email | string | yes | ||
expires_at | string (date-time) | yes | ||
institution_name | string | yes | ||
kind | RecoveryKind | yes |
Used by : 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
Allowed values : password, second_factor
Used by : accountRecoveryInspect, adminDisableUser, adminGetUser, adminIssueAccountRecovery, adminListUsers, adminReactivateUser, adminSetUserRoles, adminSuspendUser, adminUpdateUserProfile, meUpdateProfile
SecondFactorCodeIn
Code de la NOUVELLE cle, qui la prouve.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
code | string | yes | Code TOTP a six chiffres. | pattern: "^\\s*\\d{3}\\s?\\d{3}\\s*$" |
Used by : meConfirmSecondFactor
SecondFactorEnrollmentOut
Nouvelle cle TOTP, montree une seule fois ; l'ancienne reste en service.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
expires_at | string (date-time) | yes | Au-dela, l'enrolement est a recommencer. | |
provisioning_uri | string | yes | ||
secret | string | yes |
Used by : meBeginSecondFactor
SecurityEventOut
Evenement de securite du compte, lu dans la chaine d'audit.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
action | string | yes | Code d'action d'audit (`user.login.succeeded`, ...). | |
by_self | boolean | yes | Vrai si l'interesse a agi lui-meme. | |
detail | map<string, string | integer | boolean | null> | yes | ||
occurred_at | string (date-time) | yes | ||
sequence | integer | yes |
Used by : meListSecurityEvents
ValidationError
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
ctx | object | no | ||
input | any | no | ||
loc | array<string | integer> | yes | ||
msg | string | yes | ||
type | string | yes |
Used by : 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