1. Vue générale
Ces APIS sont utilisés pour configurer les clients, tenants, idp, groupes, profils, et utilisateurs.
1.1. Information de version
Version : v1
1.2. Information de contact
Contact : Emmanuel DEVILLER
Email de contact : emmanuel.deviller@teamvitamui.com
1.3. Information de licence
Licence : License to be defined …
Licence URL : http://notedefined.com
Conditions de service : Terms of service
1.4. Schéma d’URI
Serveur : localhost
Chemin de base : /iam/v1
1.5. Tags
-
Applications : Ensemble des APIs permettant la gestion des applications (récupération et vérification de l’existance)
-
Cas : Ensemble des APIs permettant la gestion de l’authentification, la subrogation et de la déconnexion. Ces APIs sont utilisées seulement par le serveur CAS
-
Clients : Ensemble des APIs permettant la gestion des clients (création, modification, récupération et vérification de l’existence)
-
Fournisseur d’identités : Ensemble des APIs permettant la gestion des fournisseurs d’identités (création, modification, récupération et vérification de l’existence)
-
Groupes : Ensemble des APIs permettant la gestion des groupes (création, modification, récupération et vérification de l’existence)
-
Profils : Ensemble des APIs permettant la gestion des profils (création, modification, récupération et vérification de l’existence)
-
Propriétaires : Ensemble des APIs permettant la gestion des propriétaires (création, modification, récupération et vérification de l’existence)
-
Statut : Ensemble des APIs permettant de vérifier l’état du service
-
Subrogations : Ensemble des APIs permettant la gestion de la subrogation (création, modification, récupération et vérification de l’existence)
-
Tenants : Ensemble des APIs permettant la gestion des tenants (création, modification, récupération et vérification de l’existence)
-
Utilisateurs : Ensemble des APIs permettant la gestion des utilisateurs (création, modification, récupération et vérification de l’existence)
1.6. Produit
-
application/json
2. Ressources
2.1. Applications
Ensemble des APIs permettant la gestion des applications (récupération et vérification de l’existance)
2.1.1. Récupération des applications
GET /applications
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/applications
Requête header
"string"
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"id" : "1",
"identifier" : "PROFILES_APP",
"url" : "http://vitamui.com/profiles"
}
2.2. Cas
Ensemble des APIs permettant la gestion de l’authentification, la subrogation et de la déconnexion. Ces APIs sont utilisées seulement par le serveur CAS
2.2.1. Authentification
POST /cas/login
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
LoginRequestDto |
Informations de connexion |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/cas/login
Requête header
"string"
Requête body
{
"ip" : "192.168.1.0",
"password" : "password",
"surrogate" : "surrogate@archiveco.fr",
"username" : "toto@archiveco.fr"
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
2.2.2. Déconnexion
GET /cas/logout
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
authToken |
Identifiant technique du token a invalider |
string |
Query |
superUser |
Email de l’utilisateur subrogateur |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/cas/logout
Requête header
"string"
Requête query
{
"authToken" : "string",
"superUser" : "string"
}
2.2.3. Modification du mot de passe
POST /cas/password/change
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Header |
password |
Nouveau mot de passe |
string |
Header |
username |
Email de l’utilisateur |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
2.2.4. Récupération d’une subrogation à partir de l’email du subrogateur
GET /cas/subrogations
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
superUserEmail |
Email du subrogateur |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< SubrogationDto > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/cas/subrogations
Requête header
"string"
Requête query
{
"superUserEmail" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
} ]
2.2.5. Récupération d’un utilisateur
GET /cas/users
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
email |
Email de l’utilisateur |
string |
Query |
embedded |
value authtoken pour générer un token d’authentification, surrogation pour signifier que c’est une connexion par subrogation |
< enum (authtoken, surrogation) > array(csv) |
Query |
id |
Identifiant technique de l’utilisateur |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/cas/users
Requête header
"string"
Requête query
{
"email" : "string",
"embedded" : "string",
"id" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
2.3. Clients
Ensemble des APIs permettant la gestion des clients (création, modification, récupération et vérification de l’existence)
2.3.1. Création d’un client
POST /customers
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
customer |
Client à créer |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
Created |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/customers
Requête header
"string"
Requête body
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
}
Exemple de réponse HTTP
Réponse 201
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
}
2.3.2. Récupération paginée des clients
GET /customers
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Query |
direction |
Direction pour le tri |
enum (ASC, DESC) |
Query |
embedded |
Non utilisées |
enum (ALL) |
Query |
orderBy |
Nom du champ sur lequel effectuer le tri |
string |
Query |
page |
Numéro de la page |
integer (int32) |
Query |
size |
Nombre de résultats maximum |
integer (int32) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/customers
Requête header
"string"
Requête query
{
"criteria" : "string",
"direction" : "string",
"embedded" : "string",
"orderBy" : "string",
"page" : 0,
"size" : 0
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
} ]
}
2.3.3. Vérification de l’existence d’un client
HEAD /customers/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/customers/check
Requête header
"string"
Requête query
{
"criteria" : "string"
}
2.3.4. Récupération du client courant
GET /customers/me
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
}
2.3.5. Récupération d’un client
GET /customers/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du client |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
}
2.3.6. Modification d’un client
PUT /customers/{id}
Caution
|
operation.deprecated |
Description
L’API sera supprimée en V2
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du client |
string |
Body |
customer |
client |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/customers/string
Requête header
"string"
Requête body
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
}
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
}
2.3.7. Modification partielle d’un client
PATCH /customers/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du client |
string |
FormData |
logo |
Logo du client. Ce paramètre est optionnel et n’est présent que si la modification concerne l’identité graphique du client |
file |
FormData |
partialDto |
Map<string, object> qui contient une clé id avec l’id du client à modifier et une paire de clé/valeur pour chaque attribut du client à modifier |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
-
multipart/form-data
Exemple de requête HTTP
Requête path
/customers/string
Requête header
"string"
Requête formData
"string"
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"defaultEmailDomain" : "@archiveco.fr",
"emailDomains" : [ "@archiveo.fr", "@archiveco.com" ],
"enabled" : true,
"id" : "1",
"identifier" : "1",
"language" : "FRENCH",
"name" : "archiveco",
"otp" : "OPTIONAL",
"owners" : [ {
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
} ],
"readonly" : true,
"passwordRevocationDelay" : 1,
"subrogeable" : true,
"hasCustomGraphicIdentity" : true
}
2.3.8. Récupération de l’historique d’un client
GET /customers/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du client |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.4. Fournisseur D’identités
Ensemble des APIs permettant la gestion des fournisseurs d’identités (création, modification, récupération et vérification de l’existence)
2.4.1. Création d’un fournisseur d’identité
POST /providers
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
idp |
Un fournisseur d’identité |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/providers
Requête header
"string"
Requête body
{
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"idpMetadata" : "string",
"internal" : true,
"keystoreBase64" : "string",
"keystorePassword" : "password",
"maximumAuthenticationLifetime" : 86400,
"name" : "google_id",
"patterns" : [ ".*@archiveco.fr" ],
"privateKeyPassword" : "password",
"readonly" : true,
"spMetadata" : "string",
"technicalName" : "idparchiveco"
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"idpMetadata" : "string",
"internal" : true,
"keystoreBase64" : "string",
"keystorePassword" : "password",
"maximumAuthenticationLifetime" : 86400,
"name" : "google_id",
"patterns" : [ ".*@archiveco.fr" ],
"privateKeyPassword" : "password",
"readonly" : true,
"spMetadata" : "string",
"technicalName" : "idparchiveco"
}
2.4.2. Récupération des fournisseurs d’identités
GET /providers
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Query |
embedded |
Récupération du keystore (base64) et des metadata |
enum (KEYSTORE, IDPMETADATA) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< IdentityProviderDto > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/providers
Requête header
"string"
Requête query
{
"criteria" : "string",
"embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"idpMetadata" : "string",
"internal" : true,
"keystoreBase64" : "string",
"keystorePassword" : "password",
"maximumAuthenticationLifetime" : 86400,
"name" : "google_id",
"patterns" : [ ".*@archiveco.fr" ],
"privateKeyPassword" : "password",
"readonly" : true,
"spMetadata" : "string",
"technicalName" : "idparchiveco"
} ]
2.4.3. Vérification de l’existence d’un fournisseur d’identité
HEAD /providers/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/providers/check
Requête header
"string"
Requête query
{
"criteria" : "string"
}
2.4.4. Récupération d’un fournisseur d’identité
GET /providers/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique d’un fournissuer d’identité |
string |
Query |
embedded |
Récupération du keystore (base64) et des metadata |
enum (KEYSTORE, IDPMETADATA) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/providers/string
Requête header
"string"
Requête query
{
"embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"idpMetadata" : "string",
"internal" : true,
"keystoreBase64" : "string",
"keystorePassword" : "password",
"maximumAuthenticationLifetime" : 86400,
"name" : "google_id",
"patterns" : [ ".*@archiveco.fr" ],
"privateKeyPassword" : "password",
"readonly" : true,
"spMetadata" : "string",
"technicalName" : "idparchiveco"
}
2.4.5. Modification partielle d’un fournisseur d’identité
PATCH /providers/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du fournisseur d’identité |
string |
Body |
partialDto |
Contient les champs à modifier ainsi que leurs nouvelles valeurs |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"idpMetadata" : "string",
"internal" : true,
"keystoreBase64" : "string",
"keystorePassword" : "password",
"maximumAuthenticationLifetime" : 86400,
"name" : "google_id",
"patterns" : [ ".*@archiveco.fr" ],
"privateKeyPassword" : "password",
"readonly" : true,
"spMetadata" : "string",
"technicalName" : "idparchiveco"
}
2.5. Groupes
Ensemble des APIs permettant la gestion des groupes (création, modification, récupération et vérification de l’existence)
2.5.1. Création d’un groupe
POST /groups
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
groupe |
Groupe à créer |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
403 |
L’utilisateur ne possède pas les droits pour effectuer cette opération |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/groups
Requête header
"string"
Requête body
{
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
}
2.5.2. Récupération paginée des groupes
GET /groups
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Query |
direction |
Direction pour le tri |
enum (ASC, DESC) |
Query |
embedded |
Récupération des profiles associés |
enum (ALL) |
Query |
orderBy |
Nom du champ sur lequel effectuer le tri |
string |
Query |
page |
Numéro de la page |
integer (int32) |
Query |
size |
Nombre de résultats maximum |
integer (int32) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/groups
Requête header
"string"
Requête query
{
"criteria" : "string",
"direction" : "string",
"embedded" : "string",
"orderBy" : "string",
"page" : 0,
"size" : 0
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
} ]
}
2.5.3. Vérification de l’existence d’un groupe
HEAD /groups/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/groups/check
Requête header
"string"
Requête query
{
"criteria" : "string"
}
2.5.4. Récupération des niveaux des groupes
GET /groups/levels
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/groups/levels
Requête header
"string"
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.5.5. Récupération d’un groupe
GET /groups/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du groupe |
string |
Query |
embedded |
Récupération des profiles du groupe |
enum (ALL) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/groups/string
Requête header
"string"
Requête query
{
"embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
}
2.5.6. Modification d’un groupe
PUT /groups/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du groupe |
string |
Body |
dto |
dto |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/groups/string
Requête header
"string"
Requête body
{
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
}
2.5.7. Modification partielle d’un groupe
PATCH /groups/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du groupe |
string |
Body |
partialDto |
Contient les champs à modifier ainsi que leurs nouvelles valeurs |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
}
2.5.8. Récupération de l’historique d’un groupe
GET /groups/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du groupe |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.6. Profils
Ensemble des APIs permettant la gestion des profils (création, modification, récupération et vérification de l’existence)
2.6.1. Création d’un profil
POST /profiles
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
profile |
Un profile |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/profiles
Requête header
"string"
Requête body
{
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
}
Exemple de réponse HTTP
Réponse 200
{
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
}
2.6.2. Récupération paginée des profils
GET /profiles
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Query |
direction |
Direction pour le tri |
enum (ASC, DESC) |
Query |
embedded |
Récupération des compteurs usersCount, groupCount ainsi que le nom du tenant |
enum (ALL) |
Query |
orderBy |
Nom du champ sur lequel effectuer le tri |
string |
Query |
page |
Numéro de la page |
integer (int32) |
Query |
size |
Nombre de résultats maximum |
integer (int32) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/profiles
Requête header
"string"
Requête query
{
"criteria" : "string",
"direction" : "string",
"embedded" : "string",
"orderBy" : "string",
"page" : 0,
"size" : 0
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ]
}
2.6.3. Vérification de l’existence d’un profil
HEAD /profiles/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/profiles/check
Requête header
"string"
Requête query
{
"criteria" : "string"
}
2.6.4. Récupération des niveaux des profils
GET /profiles/levels
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< string > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/profiles/levels
Requête header
"string"
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.6.5. Récupération d’un profil
GET /profiles/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du profile |
string |
Query |
embedded |
Récupération des compteurs usersCount, groupCount ainsi que le nom du tenant |
enum (ALL) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/profiles/string
Requête header
"string"
Requête query
{
"embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
}
2.6.6. Modification partielle d’un profil
PATCH /profiles/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du profil |
string |
Body |
partialDto |
Contient les champs à modifier ainsi que leurs nouvelles valeurs |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
{
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
}
2.6.7. Récupération de l’historique d’un profil
GET /profiles/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du profil |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.7. Propriétaires
Ensemble des APIs permettant la gestion des propriétaires (création, modification, récupération et vérification de l’existence)
2.7.1. Création d’un propriétaire
POST /owners
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
owner |
Un propriétaire |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/owners
Requête header
"string"
Requête body
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
}
2.7.2. Vérification de l’existence d’un propriétaire
HEAD /owners/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/owners/check
Requête header
"string"
Requête query
{
"criteria" : "string"
}
2.7.3. Récupération d’un propriétaire
GET /owners/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique d’un propriétaire |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
}
2.7.4. Modification d’un propriétaire
PUT /owners/{id}
Caution
|
operation.deprecated |
Description
L’API sera supprimée en V2
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du propriétaire |
string |
Body |
owner |
Un propriétaire |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/owners/string
Requête header
"string"
Requête body
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
}
2.7.5. Modification partielle d’un propriétaire
PATCH /owners/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du propriétaire |
string |
Body |
partialDto |
Contient les champs à modifier ainsi que leurs nouvelles valeurs |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
{
"address" : {
"city" : "Paris",
"country" : "France",
"street" : "43 avenue de la grande armée",
"zipCode" : "75008"
},
"code" : "1",
"companyName" : "archiveco",
"customerId" : "1",
"id" : "1",
"identifier" : "1",
"name" : "toto",
"readonly" : true
}
2.7.6. Récupération de l’historique d’un propriétaire
GET /owners/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du propriétaire |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
2.8. Statut
Ensemble des APIs permettant de vérifier l’état du service
2.8.1. Test de l’API
GET /autotest
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
"string"
2.8.2. Récupération du statut de l’API
GET /status
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
string |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
2.9. Subrogations
Ensemble des APIs permettant la gestion de la subrogation (création, modification, récupération et vérification de l’existence)
2.9.1. Création d’une subrogation
POST /subrogations
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
subrogation |
Une subrogation |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/subrogations
Requête header
"string"
Requête body
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
Exemple de réponse HTTP
Réponse 200
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
2.9.2. Récupération des subrogations
GET /subrogations
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< SubrogationDto > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/subrogations
Requête header
"string"
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
} ]
2.9.3. Récupération d’un groupe
GET /subrogations/groups/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du groupe |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
}
2.9.4. Récupération de ma subrogation en tant que subrogateur
GET /subrogations/me/superuser
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
2.9.5. Récupération de ma subrogation en tant que subrogé
GET /subrogations/me/surrogate
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
2.9.6. Acceptation d’une subrogation par le subrogé
PATCH /subrogations/surrogate/accept/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de la subrogation |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
2.9.7. Refus de la subrogation par le subrogé
DELETE /subrogations/surrogate/decline/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de la subrogation |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
2.9.8. Récupération paginée des utilisateurs
GET /subrogations/users
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
criteria |
string |
Query |
direction |
direction |
enum (ASC, DESC) |
Query |
orderBy |
orderBy |
string |
Query |
page |
page |
string |
Query |
size |
size |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/subrogations/users
Requête header
"string"
Requête query
{
"criteria" : "string",
"direction" : "string",
"orderBy" : "string",
"page" : "string",
"size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
} ]
}
2.9.9. Récupération d’une subrogation
GET /subrogations/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de la subrogation |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
2.9.10. Modification d’une subrogation
PUT /subrogations/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de la subrogation |
string |
Body |
subrogation |
Une subrogation |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/subrogations/string
Requête header
"string"
Requête body
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
Exemple de réponse HTTP
Réponse 200
{
"date" : "string",
"id" : "1",
"status" : "CREATED",
"superUser" : "superuser@arhiveco.fr",
"superUserCustomerId" : "1",
"surrogate" : "surrogate@archiveco.fr",
"surrogateCustomerId" : "1"
}
2.9.11. Suppression d’une subrogation
DELETE /subrogations/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de la subrogation |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
2.9.12. Vérification de l’existence d’une subrogation
HEAD /subrogations/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique d’une subrogation |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
2.10. Tenants
Ensemble des APIs permettant la gestion des tenants (création, modification, récupération et vérification de l’existence)
2.10.1. Création d’un tenant
POST /tenants
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
tenant |
Un tenant |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/tenants
Requête header
"string"
Requête body
{
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
}
2.10.2. Récupération des tenants
GET /tenants
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
< TenantDto > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/tenants
Requête header
"string"
Requête query
{
"criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
} ]
2.10.3. Vérification de l’existence d’un tenant
HEAD /tenants/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/tenants/check
Requête header
"string"
Requête query
{
"criteria" : "string"
}
2.10.4. Récupération d’un tenant
GET /tenants/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique d’un tenant |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
}
2.10.5. Modification d’un tenant
PUT /tenants/{id}
Caution
|
operation.deprecated |
Description
L’API sera supprimée en V2
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique d’un tenant |
string |
Body |
tenant |
Un tenant |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/tenants/string
Requête header
"string"
Requête body
{
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
}
2.10.6. Modification partielle d’un tenant
PATCH /tenants/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique du tenant |
string |
Body |
partialDto |
Contient les champs à modifier ainsi que leurs nouvelles valeurs |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
{
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
}
2.11. Utilisateurs
Ensemble des APIs permettant la gestion des utilisateurs (création, modification, récupération et vérification de l’existence)
2.11.1. Création d’un utilisateur
POST /users
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
user |
Utilisateur à créer |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
201 |
L’utilisateur a été créé avec succès |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/users
Requête header
"string"
Requête body
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
Exemple de réponse HTTP
Réponse 201
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
2.11.2. Récupération paginée des utilisateurs
GET /users
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Query |
direction |
Direction pour le tri |
enum (ASC, DESC) |
Query |
orderBy |
Nom du champ sur lequel effectuer le tri |
string |
Query |
page |
Numéro de la page |
integer (int32) |
Query |
size |
Nombre de résultats maximum |
integer (int32) |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
Liste paginée des utilisateurs |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de requête HTTP
Requête path
/users
Requête header
"string"
Requête query
{
"criteria" : "string",
"direction" : "string",
"orderBy" : "string",
"page" : 0,
"size" : 0
}
Exemple de réponse HTTP
Réponse 200
{
"hasMore" : true,
"pageNum" : 0,
"pageSize" : 0,
"values" : [ {
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
} ]
}
2.11.3. Vérification de l’existence d’un utilisateur
HEAD /users/check
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Query |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
Au moins un utilisateur existe |
Pas de contenu |
204 |
Aucun utilisateur existe |
Pas de contenu |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/users/check
Requête header
"string"
Requête query
{
"criteria" : "string"
}
2.11.4. Récupération des niveaux des utilisateurs
GET /users/levels
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Body |
criteria |
Critères de recherche |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
Liste des niveaux des utilisateurs |
< string > array |
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
[ "string" ]
2.11.5. getMe
GET /users/me
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
OK |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"accountNonExpired" : true,
"accountNonLocked" : true,
"authToken" : "1",
"authorities" : [ {
"authority" : ""
} ],
"credentialsNonExpired" : true,
"customerId" : "1",
"customerIdentifier" : "1",
"email" : "toto@archiveco.fr",
"enabled" : true,
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "FR",
"lastConnection" : "string",
"lastname" : "TOTO",
"level" : "",
"mobile" : "+33654852569",
"nbFailedAttempts" : 1,
"otp" : true,
"password" : "pasword",
"passwordExpirationDate" : "string",
"phone" : "+33145852596",
"profileGroup" : {
"customerId" : "1",
"description" : "Groupe pour les utilisateurs RH",
"enabled" : true,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "Groupe RH",
"profileIds" : [ "1", "2", "3" ],
"profiles" : [ {
"applicationName" : "USERS_APP",
"customerId" : "1",
"description" : "profile des droits utilisateurs",
"enabled" : true,
"externalParamId" : "string",
"externalParamIdentifier" : "string",
"groupsCount" : 2,
"id" : "1",
"identifier" : "1",
"level" : "",
"name" : "ProfileRH",
"readonly" : true,
"roles" : [ {
"name" : "ROLE_CREATE_USERS"
} ],
"tenantIdentifier" : 1,
"tenantName" : "Tenant 1",
"usersCount" : 10
} ],
"readonly" : true,
"usersCount" : 0
},
"proofTenantIdentifier" : 1,
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"superUser" : "subrogateur@archiveco.fr",
"superUserIdentifier" : "1",
"tenantsByApp" : [ {
"name" : "Tenant A",
"tenants" : [ {
"accessContractHoldingIdentifier" : "AC-00002",
"accessContractLogbookIdentifier" : "AC-00001",
"customerId" : "1",
"enabled" : true,
"id" : "1",
"identifier" : 1,
"ingestContractHoldingIdentifier" : "IC-00002",
"itemIngestContractIdentifier" : "IC-00001",
"name" : "tenant 10",
"ownerId" : "1",
"proof" : true,
"readonly" : true
} ]
} ],
"type" : "string",
"username" : "string"
}
2.11.6. Récupération d’un utilisateur
GET /users/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de l’utilisateur |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
L’utilisateur trouvé |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
2.11.7. Modification d’un utilisateur
PUT /users/{id}
Caution
|
operation.deprecated |
Description
L’API sera supprimée en V2
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de l’utilisateur |
string |
Body |
user |
L’utilisateur modifié |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
L’utilisateur modifié |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de requête HTTP
Requête path
/users/string
Requête header
"string"
Requête body
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
2.11.8. Modification partielle d’un utilisateur
PATCH /users/{id}
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de l’utilisateur |
string |
Body |
partialDto |
Contient les champs à modifier ainsi que leurs nouvelles valeurs |
object |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
l’utilisateur modifié |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Consomme
-
application/json
Exemple de réponse HTTP
Réponse 200
{
"customerId" : "1",
"email" : "toto@example.fr",
"firstname" : "toto",
"groupId" : "1",
"id" : "1",
"identifier" : "1",
"language" : "string",
"lastConnection" : "string",
"lastname" : "DUPONT",
"level" : " ",
"mobile" : "+33667678250",
"nbFailedAttempts" : 0,
"otp" : true,
"passwordExpirationDate" : "string",
"phone" : "+33145868450",
"readonly" : true,
"status" : "string",
"subrogeable" : true,
"type" : "string"
}
2.11.9. Récupération de l’historique d’un utilisateur
GET /users/{id}/history
Paramètres
Type | Nom | Description | Schéma |
---|---|---|---|
Header |
X-Application-Id |
Identifiant unique utilisé dans la génération des logs et des journaux VITAM |
string |
Header |
X-Customer-Id |
Identifiant technique du client |
string |
Header |
X-Tenant-Id |
Identifiant du tenant sur lequel doit être exécuté la requête |
integer (int32) |
Header |
X-User-Level |
Niveau de l’utilisateur |
string |
Header |
X-User-Token |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
Path |
id |
Identifiant technique de l’utilisateur |
string |
Réponses
Code HTTP | Description | Schéma |
---|---|---|
200 |
Historique d’un utilisateur |
|
401 |
La requête n’est pas autorisée. Le X-User-Token n’est pas valide |
Pas de contenu |
404 |
Ressource non trouvée |
Pas de contenu |
Exemple de réponse HTTP
Réponse 200
{
"array" : true,
"bigDecimal" : true,
"bigInteger" : true,
"binary" : true,
"boolean" : true,
"containerNode" : true,
"double" : true,
"float" : true,
"floatingPointNumber" : true,
"int" : true,
"integralNumber" : true,
"long" : true,
"missingNode" : true,
"nodeType" : "string",
"null" : true,
"number" : true,
"object" : true,
"pojo" : true,
"short" : true,
"textual" : true,
"valueNode" : true
}
3. Définitions
3.1. AddressDto
Nom | Description | Schéma |
---|---|---|
city |
Ville |
string |
country |
Pays |
string |
street |
Rue |
string |
zipCode |
Code postal |
string |
3.2. ApplicationDto
Nom | Description | Schéma |
---|---|---|
id |
identifiant technique |
string |
identifier |
identifiant métier |
string |
url |
url de l’application |
string |
3.3. AuthUserDto
Nom | Description | Schéma |
---|---|---|
accountNonExpired |
Expiré |
boolean |
accountNonLocked |
Bloqué |
boolean |
authToken |
Identifiant technique du token généré par le serveur CAS lors de l’authentification |
string |
authorities |
Ensembles des autorisations de l’utilisateur |
< GrantedAuthority > array |
credentialsNonExpired |
Mot de passe expiré |
boolean |
customerId |
Identifiant technique du client |
string |
customerIdentifier |
Identifiant métier du client |
string |
email |
Email |
string |
enabled |
Actif ou inactif |
boolean |
firstname |
Prénom |
string |
groupId |
Identifiant technique du groupe |
string |
id |
Identifiant technique de l’utilisateur |
string |
identifier |
Identifiant métier de l’utilisateur |
string |
language |
Langue de l’utilisateur |
enum (FR, EN, DE) |
lastConnection |
Date de dernière connexion de l’utilisateur |
string (date-time) |
lastname |
Nom de famille |
string |
level |
Niveau de l’utilisateur |
string |
mobile |
Numéro de portable |
string |
nbFailedAttempts |
Nombre de tentative de connexion échouée |
integer (int32) |
otp |
Double authentification activée ou non |
boolean |
password |
Mot de passe |
string |
passwordExpirationDate |
Date d’expiration du mot de passe |
string (date-time) |
phone |
Numéro de fixe |
string |
profileGroup |
Groupe de l’utilisateur |
|
proofTenantIdentifier |
Identifiant métier du tenant des éléments de preuve de l’utilisateur du client |
integer (int32) |
readonly |
Lecture seule |
boolean |
status |
Statut |
enum (ENABLED, DISABLED, BLOCKED, ANONYM) |
subrogeable |
Subrogeable |
boolean |
superUser |
Email de l’utilisateur subrogateur |
string |
superUserIdentifier |
Identifiant métier du subrogateur |
string |
tenantsByApp |
Exemple : |
< TenantInformationDto > array |
type |
Type |
enum (GENERIC, NOMINATIVE) |
username |
Exemple : |
string |
3.4. CustomerDto
Nom | Description | Schéma |
---|---|---|
address |
Exemple : |
|
code |
Identifiant métier |
string |
companyName |
Nom de la compagnie |
string |
defaultEmailDomain |
Nom de domaine par défaut |
string |
emailDomains |
Ensemble des domaines |
< string > array |
enabled |
Actif ou inactif |
boolean |
hasCustomGraphicIdentity |
Exemple : |
boolean |
id |
Identifiant technique |
string |
identifier |
Identifiant métier |
string |
language |
Préférence de langue pour les utilisateurs du client |
enum (FRENCH, ENGLISH, GERMANY) |
name |
Nom du client |
string |
otp |
Authentification en 2 étapes pour les utilisateurs du client |
enum (OPTIONAL, DISABLED, MANDATORY) |
owners |
Propriétaires du client |
< OwnerDto > array |
passwordRevocationDelay |
Durée de validitée des mot de passes pour les utilisateurs clients (exprimée en jours) |
integer (int32) |
readonly |
Lecture seule |
boolean |
subrogeable |
Utilisateur du client subrogeable ou non |
boolean |
3.5. GrantedAuthority
Nom | Description | Schéma |
---|---|---|
authority |
Ensemble des droits utilisateur |
string |
3.6. GroupDto
Nom | Description | Schéma |
---|---|---|
customerId |
Identifiant technique du client |
string |
description |
Exemple : |
string |
enabled |
Actif ou Inactif |
boolean |
id |
Identifiant technique |
string |
identifier |
Identifiant métier |
string |
level |
Niveau |
string |
name |
Nom |
string |
profileIds |
Ensemble des identifiants technique des profils contenu dans le groupe |
< string > array |
profiles |
Ensemble des profiles du groupe |
< ProfileDto > array |
readonly |
Lecture seule |
boolean |
usersCount |
Nombre d’utilisateurs contenu dans le groupe |
integer (int64) |
3.7. IdentityProviderDto
Nom | Description | Schéma |
---|---|---|
customerId |
Identifiant technique du client |
string |
enabled |
Actif ou Inactif |
boolean |
id |
Identifiant technique |
string |
identifier |
Identifiant métier |
string |
idpMetadata |
Metadata |
string |
internal |
Authentification déléguée ou non |
boolean |
keystoreBase64 |
Keystore en base64 |
string |
keystorePassword |
Mot de passe |
string |
maximumAuthenticationLifetime |
Durée maximum de validitée de l’authentification (exprimée en secondes) |
integer (int32) |
name |
Nom |
string |
patterns |
Regexp utilisée pour la décision par le serveur CAS de l’IDP à utiliser |
< string > array |
privateKeyPassword |
Mot de passe de la clé privée |
string |
readonly |
Lecture seule |
boolean |
spMetadata |
Exemple : |
string |
technicalName |
Nom technique |
string |
3.8. JsonNode
Nom | Description | Schéma |
---|---|---|
array |
Exemple : |
boolean |
bigDecimal |
Exemple : |
boolean |
bigInteger |
Exemple : |
boolean |
binary |
Exemple : |
boolean |
boolean |
Exemple : |
boolean |
containerNode |
Exemple : |
boolean |
double |
Exemple : |
boolean |
float |
Exemple : |
boolean |
floatingPointNumber |
Exemple : |
boolean |
int |
Exemple : |
boolean |
integralNumber |
Exemple : |
boolean |
long |
Exemple : |
boolean |
missingNode |
Exemple : |
boolean |
nodeType |
Exemple : |
enum (ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING) |
null |
Exemple : |
boolean |
number |
Exemple : |
boolean |
object |
Exemple : |
boolean |
pojo |
Exemple : |
boolean |
short |
Exemple : |
boolean |
textual |
Exemple : |
boolean |
valueNode |
Exemple : |
boolean |
3.9. LoginRequestDto
Nom | Description | Schéma |
---|---|---|
ip |
Addresse IP de l’utilisateur |
string |
password |
Mot de passe saisie par l’utilisateur |
string |
surrogate |
Adresse mail de l’utilisateur à subroger |
string |
username |
Adresse mail saisie par l’utilisateur |
string |
3.10. OwnerDto
Nom | Description | Schéma |
---|---|---|
address |
Exemple : |
|
code |
Identifiant métier |
string |
companyName |
Nom de la compagnie |
string |
customerId |
Identifiant technique du client |
string |
id |
Identifiant technique |
string |
identifier |
Identifiant métier |
string |
name |
Nom |
string |
readonly |
Lecture seule |
boolean |
3.11. PaginatedValuesDto«CustomerDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< CustomerDto > array |
3.12. PaginatedValuesDto«GroupDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< GroupDto > array |
3.13. PaginatedValuesDto«ProfileDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< ProfileDto > array |
3.14. PaginatedValuesDto«UserDto»
Nom | Description | Schéma |
---|---|---|
hasMore |
Exemple : |
boolean |
pageNum |
Exemple : |
integer (int32) |
pageSize |
Exemple : |
integer (int32) |
values |
Exemple : |
< UserDto > array |
3.15. ProfileDto
Nom | Description | Schéma |
---|---|---|
applicationName |
Identifiant de l’application métier |
string |
customerId |
Identifiant technique du client |
string |
description |
Description |
string |
enabled |
Actif ou Inactif |
boolean |
externalParamId |
Identifier technique d’un paramètre extérieur |
string |
externalParamIdentifier |
Identifier métier d’un paramètre extérieur |
string |
groupsCount |
Nombre de groupe contenant ce profile |
integer (int64) |
id |
Identifiant technique |
string |
identifier |
Identifiant métier |
string |
level |
Niveau |
string |
name |
Nom |
string |
readonly |
Lecture seule |
boolean |
roles |
Ensemble des rôles |
< Role > array |
tenantIdentifier |
Identifiant métier du tenant |
integer (int32) |
tenantName |
Nom du tenant |
string |
usersCount |
Nombre d’utilisateurs |
integer (int64) |
3.16. Role
Nom | Description | Schéma |
---|---|---|
name |
Nom du rôle |
string |
3.17. SubrogationDto
Nom | Description | Schéma |
---|---|---|
date |
Date de fin de la subrogation |
string (date-time) |
id |
Identifiant technique |
string |
status |
Statut |
enum (CREATED, ACCEPTED) |
superUser |
Email de l’utilisateur subrogateur |
string |
superUserCustomerId |
Identifiant métier du client de l’utilisateur subrogateur |
string |
surrogate |
Email de l’utilisateur subrogée |
string |
surrogateCustomerId |
Identifiant métier du client de l’utilisateur subrogée |
string |
3.18. TenantDto
Nom | Description | Schéma |
---|---|---|
accessContractHoldingIdentifier |
Identifiant technique du contrat d’accès utilisé pour la gestion de l’arbre |
string |
accessContractLogbookIdentifier |
Identifiant technique du contrat d’accès utilisé pour accèder aux logbook VITAM |
string |
customerId |
Identifiant technique du client |
string |
enabled |
Actif ou Inactif |
boolean |
id |
Identifiant technique |
string |
identifier |
Identifiant technique du tenant VITAM |
integer (int32) |
ingestContractHoldingIdentifier |
Identifiant technique du contrat d’éntrée utilisé pour la gestion de l’arbre |
string |
itemIngestContractIdentifier |
Identifiant technique du contrat d’éntrée utilisé pour l’envoi de documents dans VITAM |
string |
name |
Nom |
string |
ownerId |
Identifiant technique du propriétaire |
string |
proof |
Tenant générée automatiquement lors de la création d’un client |
boolean |
readonly |
Lecture seule |
boolean |
3.19. TenantInformationDto
Nom | Description | Schéma |
---|---|---|
name |
Nom |
string |
tenants |
Exemple : |
< TenantDto > array |
3.20. UserDto
Nom | Description | Schéma |
---|---|---|
customerId |
Identifiant technique du client |
string |
email |
Adresse mail |
string |
firstname |
Prénom |
string |
groupId |
Identifiant technique du groupe |
string |
id |
Identifiant technique |
string |
identifier |
Identifiant métier |
string |
language |
Langue |
enum (FR, DE, EN) |
lastConnection |
Date de la derniére connexion de l’utilisateur au format ISO-8601 |
string (date-time) |
lastname |
Nom de famille |
string |
level |
Niveau |
string |
mobile |
Numéro de téléphone portable au format international |
string |
nbFailedAttempts |
Nombre de tantive échouée depuis la dernière connexion réussie |
integer (int32) |
otp |
Double authentification activée ou non |
boolean |
passwordExpirationDate |
Date d’expiration du mot de passe |
string (date-time) |
phone |
Numéro de téléphone fixe au format international |
string |
readonly |
Lecture seule |
boolean |
status |
Statut |
enum (ENABLED, DISABLED, BLOCKED, ANONYM) |
subrogeable |
Subrogeable |
boolean |
type |
Type |
enum (GENERIC, NOMINATIVE) |