Skip to content

Commit 4facf78

Browse files
Update documentation and validation for identity system
1 parent 2f6c260 commit 4facf78

File tree

3 files changed

+76
-2
lines changed

3 files changed

+76
-2
lines changed

docs/summary.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
"file": "Documentation_utilisateur.md",
3131
"children": [
3232
{
33-
"title": "IdentitiesValidation",
34-
"file": "./user/IdentitiesValidation.md"
33+
"title": "Documentation du Systeme de Validation des schemas complémentaires de l'identité",
34+
"file": "./user/Documentation_Systeme_Validation_Identite.md"
3535
}
3636
]
3737
}

docs/user/IdentitiesValidation.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,70 @@
55
Ce guide explique comment interagir avec le système de validation des identités dans notre application. Cette fonctionnalité assure que toutes les données relatives aux identités sont valides et conformes aux exigences de l'organisation.
66

77
## Validation des Données
8+
9+
### Résumé
810
Lorsque vous soumettez des données d'identité (par exemple, via un formulaire ou une API), le système effectue les vérifications suivantes :
911
- Tous les champs obligatoires sont présents.
1012
- Les données correspondent aux types attendus (chaînes, nombres, dates, etc.).
1113
- Les valeurs respectent les contraintes spécifiques (par exemple, formats d'email ou de téléphone).
1214

15+
### Données a passer
16+
Pour valider les données, vous devez fournir :
17+
Un fichier XML nommé selon le nom de l'objet à valider (par exemple, `supann.xml`).
18+
Dans le json de la requête, vous devez fournir :
19+
- Le champs "state" a -1 pour une creation
20+
- l'object avec comme clé inetorgperson et comme valeur un objet contenant les champs a valider
21+
- un objet "additionalFields" contenant deux champs :
22+
- - "objectClasses" : un tableau de string contenant les objectClasses a ajouter a l'objet
23+
- - "attributes" : un objet contenant les champs a ajouter a l'objet
24+
25+
Par exemple, pour valider un objet supann, vous devez fournir :
26+
```json
27+
{
28+
"state": -1,
29+
"inetorgperson": {
30+
"sn": "Doe",
31+
"uid": "John",
32+
"cn": "John Doe",
33+
},
34+
"additionalFields": {
35+
"objectClasses": ["supann"],
36+
"attributes":{
37+
"supann": {
38+
"supannEmpId": "123456",
39+
"supannCivilite": "Mr",
40+
"supannBirthName": "Doe"
41+
}
42+
}
43+
}
44+
}
45+
```
46+
47+
Avec comme fichier de configuration :
48+
```yml
49+
objectClasses:
50+
- name: supannPerson
51+
desc: 'SUPANN person object class'
52+
attributes:
53+
- supannEmpId
54+
- supannCivilite
55+
- supannBirthName
56+
57+
attributes:
58+
- name: supannEmpId
59+
desc: 'Employee ID'
60+
type: string
61+
62+
- name: supannCivilite
63+
desc: 'Title (Mr, Ms, etc.)'
64+
type: string
65+
66+
- name: supannBirthName
67+
desc: 'Birth name'
68+
type: string
69+
```
70+
71+
1372
## Erreurs de Validation
1473
En cas d'erreur de validation, le système vous fournira un retour détaillé sur les problèmes rencontrés. Cela peut inclure :
1574
- Des champs manquants.

src/management/identities/validations/_config/supann.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,48 +23,63 @@ attributes:
2323
- name: supannEmpId
2424
desc: 'Employee ID'
2525
type: string
26+
2627
- name: supannCivilite
2728
desc: 'Title (Mr, Ms, etc.)'
2829
type: string
30+
2931
- name: supannBirthName
3032
desc: 'Birth name'
3133
type: string
34+
3235
- name: supannBirthDate
3336
desc: 'Date of birth'
3437
type: date
38+
3539
- name: supannBirthPlace
3640
desc: 'Place of birth'
3741
type: string
42+
3843
- name: supannMailPerso
3944
desc: 'Personal email'
4045
type: string
46+
4147
- name: supannMailPro
4248
desc: 'Professional email'
4349
type: string
50+
4451
- name: supannTelPerso
4552
desc: 'Personal phone number'
4653
type: string
54+
4755
- name: supannTelPro
4856
desc: 'Professional phone number'
4957
type: string
58+
5059
- name: supannPostalAddress
5160
desc: 'Postal address'
5261
type: string
62+
5363
- name: supannRole
5464
desc: 'Role in the organization'
5565
type: string
66+
5667
- name: supannStatus
5768
desc: 'Employment status'
5869
type: string
70+
5971
- name: supannEtablissement
6072
desc: 'Institution'
6173
type: string
74+
6275
- name: supannAffectationPrincipale
6376
desc: 'Primary assignment'
6477
type: string
78+
6579
- name: supannAffectationSecondaire
6680
desc: 'Secondary assignment'
6781
type: string
82+
6883
- name: supannCodeINE
6984
desc: 'National Education Identifier'
7085
type: string

0 commit comments

Comments
 (0)