Parcours d’accueil
Étapes du parcours d’accueil (organisation, entités, référentiels, qualification, analyse d’écart).
POST
/api/v1/onboarding/complete PUT /api/v1/onboarding/entities POST /api/v1/onboarding/entities/{entityId}/frameworks POST /api/v1/onboarding/entities/{entityId}/gap-analysis/{framework} GET /api/v1/onboarding/entities/{entityId}/gap-analysis/{framework}/results POST /api/v1/onboarding/entities/{entityId}/qualification/{framework} PUT /api/v1/onboarding/organization GET /api/v1/onboarding/status POST /api/v1/onboarding/complete
- Accès
-
Permission organisation : modification
(Organization.Update), accordée par un rôle sur au moins une entité de l’organisation. - Limite de débit
- 60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)
Réponse
200 · application/json
Schéma CompleteOnboardingResponse
| Champ | Type | Contraintes |
|---|---|---|
controlsGenerated | integer | — |
initialScore | number | — |
redirectUrl | string | — |
PUT /api/v1/onboarding/entities
- Accès
-
Permission organisation : modification
(Organization.Update), accordée par un rôle sur au moins une entité de l’organisation. - Limite de débit
- 60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)
Corps de la requête
application/json, requis
Schéma UpdateEntitiesRequest
| Champ | Type | Contraintes |
|---|---|---|
entities | EntityDto[] | — |
Réponse 200
Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).
POST /api/v1/onboarding/entities/{entityId}/frameworks
- Accès
-
Permission entités : modification
(Entity.Update), accordée par le rôle de l’utilisateur sur l’entité du chemin. - Limite de débit
- 60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)
Paramètres
| Nom | Où | Type | Contraintes |
|---|---|---|---|
entityId requis | chemin | string (uuid) | — |
Corps de la requête
application/json, requis
Schéma ActivateFrameworksRequest
| Champ | Type | Contraintes |
|---|---|---|
frameworkTypes | string[] | — |
targetDate | string (date-time) | null | — |
Réponse
200 · application/json
Type FrameworkSummary[]
POST /api/v1/onboarding/entities/{entityId}/gap-analysis/{framework}
- Accès
-
Permission entités : modification
(Entity.Update), accordée par le rôle de l’utilisateur sur l’entité du chemin. - Limite de débit
- 60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)
Paramètres
| Nom | Où | Type | Contraintes |
|---|---|---|---|
entityId requis | chemin | string (uuid) | — |
framework requis | chemin | string | — |
Corps de la requête
application/json, requis
Schéma GapAnalysisRequest
| Champ | Type | Contraintes |
|---|---|---|
responses | GapAnalysisAnswerDto[] | — |
Réponse 200
Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).
GET /api/v1/onboarding/entities/{entityId}/gap-analysis/{framework}/results
- Accès
-
Permission contrôles : lecture
(Controls.Read), accordée par le rôle de l’utilisateur sur l’entité du chemin. - Limite de débit
- aucune
Paramètres
| Nom | Où | Type | Contraintes |
|---|---|---|---|
entityId requis | chemin | string (uuid) | — |
framework requis | chemin | string | — |
Réponse
200 · application/json
Schéma GapAnalysisResultResponse
| Champ | Type | Contraintes |
|---|---|---|
overallScore | number | — |
domainScores | DomainScore[] | — |
controlsTotal | integer | — |
controlsPriority | integer | — |
POST /api/v1/onboarding/entities/{entityId}/qualification/{framework}
- Accès
-
Permission entités : modification
(Entity.Update), accordée par le rôle de l’utilisateur sur l’entité du chemin. - Limite de débit
- 60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)
Paramètres
| Nom | Où | Type | Contraintes |
|---|---|---|---|
entityId requis | chemin | string (uuid) | — |
framework requis | chemin | string | — |
Corps de la requête
application/json, requis
Schéma QualificationRequest
| Champ | Type | Contraintes |
|---|---|---|
answers | map<string, string> | — |
Réponse
200 · application/json
Schéma QualificationResult
| Champ | Type | Contraintes |
|---|---|---|
framework | string | — |
classification | string | — |
explanation | string | — |
canOverride | boolean | — |
PUT /api/v1/onboarding/organization
- Accès
-
Permission organisation : modification
(Organization.Update), accordée par un rôle sur au moins une entité de l’organisation. - Limite de débit
- 60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)
Corps de la requête
application/json, requis
Schéma UpdateOrganizationRequest
| Champ | Type | Contraintes |
|---|---|---|
name requis | string | max. 255 caractères |
country requis | string | max. 2 caractères |
sector requis | string | — |
headcount | integer | null | — |
revenueRange | string | null | — |
website | string | null | — |
siren | string | null | — |
Réponse 200
Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).
GET /api/v1/onboarding/status
- Accès
-
Permission organisation : modification
(Organization.Update), accordée par un rôle sur au moins une entité de l’organisation. - Limite de débit
- aucune
Réponse
200 · application/json
Schéma OnboardingStatusResponse
| Champ | Type | Contraintes |
|---|---|---|
completed | boolean | — |
currentStep | string | null | — |
organization | OrganizationSummary | null | — |
entities | EntitySummary[] | — |
frameworks | FrameworkSummary[] | — |
Schémas
Objets utilisés par les opérations de cette page. Les nombres sont écrits en JSON comme des nombres ; les énumérations, comme des chaînes.
CompleteOnboardingResponse
| Champ | Type | Contraintes |
|---|---|---|
controlsGenerated | integer | — |
initialScore | number | — |
redirectUrl | string | — |
UpdateEntitiesRequest
| Champ | Type | Contraintes |
|---|---|---|
entities | EntityDto[] | — |
EntityDto
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | null | — |
parentEntityId | string (uuid) | null | — |
name requis | string | — |
type requis | string | — |
country requis | string | max. 2 caractères |
sector | string | — |
headcount | integer | null | — |
ActivateFrameworksRequest
| Champ | Type | Contraintes |
|---|---|---|
frameworkTypes | string[] | — |
targetDate | string (date-time) | null | — |
FrameworkSummary
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
frameworkType | string | — |
status | string | — |
activatedAt | string (date-time) | — |
GapAnalysisRequest
| Champ | Type | Contraintes |
|---|---|---|
responses | GapAnalysisAnswerDto[] | — |
GapAnalysisAnswerDto
| Champ | Type | Contraintes |
|---|---|---|
questionId | string | — |
answer | string | — |
GapAnalysisResultResponse
| Champ | Type | Contraintes |
|---|---|---|
overallScore | number | — |
domainScores | DomainScore[] | — |
controlsTotal | integer | — |
controlsPriority | integer | — |
DomainScore
| Champ | Type | Contraintes |
|---|---|---|
domain | string | — |
score | number | — |
level | string | — |
QualificationRequest
| Champ | Type | Contraintes |
|---|---|---|
answers | map<string, string> | — |
QualificationResult
| Champ | Type | Contraintes |
|---|---|---|
framework | string | — |
classification | string | — |
explanation | string | — |
canOverride | boolean | — |
UpdateOrganizationRequest
| Champ | Type | Contraintes |
|---|---|---|
name requis | string | max. 255 caractères |
country requis | string | max. 2 caractères |
sector requis | string | — |
headcount | integer | null | — |
revenueRange | string | null | — |
website | string | null | — |
siren | string | null | — |
OnboardingStatusResponse
| Champ | Type | Contraintes |
|---|---|---|
completed | boolean | — |
currentStep | string | null | — |
organization | OrganizationSummary | null | — |
entities | EntitySummary[] | — |
frameworks | FrameworkSummary[] | — |
OrganizationSummary
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
name | string | — |
website | string | null | — |
siren | string | null | — |
country | string | — |
sector | string | — |
headcount | integer | null | — |
revenueRange | string | null | — |
doraType | string | null | — |
hasDpo | boolean | null | — |
dpoName | string | null | — |
dpoEmail | string | null | — |
iso27001Certified | boolean | — |
iso27001CertDate | string | null | — |
iso27001CertExpiry | string | null | — |
EntitySummary
| Champ | Type | Contraintes |
|---|---|---|
id | string (uuid) | — |
name | string | — |
type | string | — |
country | string | — |
sector | string | — |
parentEntityId | string (uuid) | null | — |
frameworks | FrameworkSummary[] | — |
headcount | integer | null | — |
revenueRange | string | null | — |
doraType | string | null | — |
hasDpo | boolean | null | — |
dpoName | string | null | — |
dpoEmail | string | null | — |
iso27001Certified | boolean | — |
iso27001CertDate | string | null | — |
iso27001CertExpiry | string | null | — |
nis2Classification | string | null | — |
Mise à jour : 10 octobre 2026. Signaler une inexactitude