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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

Critères de recherche

string
Réponses
Code HTTP Description Schéma

200

OK

< ApplicationDto > 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
/applications
Requête header
"string"
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "id" : "1",
  "identifier" : "USERS_APP",
  "url" : "https://vitamui.com/user"
} ]

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

LoginRequestDto
requis

Informations de connexion

LoginRequestDto
Réponses
Code HTTP Description Schéma

200

OK

UserDto

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

authToken
requis

Identifiant technique du token a invalider

string

Query

superUser
requis

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Header

password
requis

Nouveau mot de passe

string

Header

username
requis

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

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
/cas/password/change
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
"true"

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

superUserEmail
requis

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

email
optionnel

Email de l’utilisateur

string

Query

embedded
optionnel

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
optionnel

Identifiant technique de l’utilisateur

string
Réponses
Code HTTP Description Schéma

200

OK

UserDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

customer
requis

Client à créer

CustomerDto
Réponses
Code HTTP Description Schéma

201

Created

CustomerDto

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
/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 des clients

GET /customers
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

Critères de recherche

string
Réponses
Code HTTP Description Schéma

200

OK

< CustomerDto > array

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

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"
}
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.3. Vérification de l’existence d’un client

HEAD /customers/check
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

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

CustomerDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/customers/me
Requête header
"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.5. Récupération d’un client

GET /customers/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du client

string
Réponses
Code HTTP Description Schéma

200

OK

CustomerDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/customers/string
Requête header
"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.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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du client

string

Body

customer
requis

client

CustomerDto
Réponses
Code HTTP Description Schéma

200

OK

CustomerDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du client

string

FormData

logo
optionnel

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
requis

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

CustomerDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du client

string
Réponses
Code HTTP Description Schéma

200

OK

JsonNode

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/customers/string/history
Requête header
"string"
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

idp
requis

Un fournisseur d’identité

IdentityProviderDto
Réponses
Code HTTP Description Schéma

200

OK

IdentityProviderDto

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

Critères de recherche

string

Query

embedded
optionnel

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique d’un fournissuer d’identité

string

Query

embedded
optionnel

Récupération du keystore (base64) et des metadata

enum (KEYSTORE, IDPMETADATA)
Réponses
Code HTTP Description Schéma

200

OK

IdentityProviderDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du fournisseur d’identité

string

Body

partialDto
requis

Contient les champs à modifier ainsi que leurs nouvelles valeurs

object
Réponses
Code HTTP Description Schéma

200

OK

IdentityProviderDto

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

404

Ressource non trouvée

Pas de contenu
Consomme

  • application/json

Exemple de requête HTTP
Requête path
/providers/string
Requête header
"string"
Requête body
{ }
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

groupe
requis

Groupe à créer

GroupDto
Réponses
Code HTTP Description Schéma

200

OK

GroupDto

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

Critères de recherche

string

Query

direction
optionnel

Direction pour le tri

enum (ASC, DESC)

Query

embedded
optionnel

Récupération des profiles associés

enum (ALL)

Query

orderBy
optionnel

Nom du champ sur lequel effectuer le tri

string

Query

page
requis

Numéro de la page

integer (int32)

Query

size
requis

Nombre de résultats maximum

integer (int32)
Réponses
Code HTTP Description Schéma

200

OK

PaginatedValuesDto«GroupDto»

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

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" : 20,
  "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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

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/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du groupe

string

Query

embedded
optionnel

Récupération des profiles du groupe

enum (ALL)
Réponses
Code HTTP Description Schéma

200

OK

GroupDto

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

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 partielle d’un groupe

PATCH /groups/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du groupe

string

Body

partialDto
requis

Contient les champs à modifier ainsi que leurs nouvelles valeurs

object
Réponses
Code HTTP Description Schéma

200

OK

GroupDto

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

404

Ressource 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
{ }
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. Récupération de l’historique d’un groupe

GET /groups/{id}/history
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du groupe

string
Réponses
Code HTTP Description Schéma

200

OK

JsonNode

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/groups/string/history
Requête header
"string"
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

profile
requis

Un profile

ProfileDto
Réponses
Code HTTP Description Schéma

200

OK

ProfileDto

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

Critères de recherche

string

Query

direction
optionnel

Direction pour le tri

enum (ASC, DESC)

Query

embedded
optionnel

Récupération des compteurs usersCount, groupCount ainsi que le nom du tenant

enum (ALL)

Query

orderBy
optionnel

Nom du champ sur lequel effectuer le tri

string

Query

page
requis

Numéro de la page

integer (int32)

Query

size
requis

Nombre de résultats maximum

integer (int32)
Réponses
Code HTTP Description Schéma

200

OK

PaginatedValuesDto«ProfileDto»

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

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" : 20,
  "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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du profile

string

Query

embedded
optionnel

Récupération des compteurs usersCount, groupCount ainsi que le nom du tenant

enum (ALL)
Réponses
Code HTTP Description Schéma

200

OK

ProfileDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du profil

string

Body

partialDto
requis

Contient les champs à modifier ainsi que leurs nouvelles valeurs

object
Réponses
Code HTTP Description Schéma

200

OK

ProfileDto

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

404

Ressource non trouvée

Pas de contenu
Consomme

  • application/json

Exemple de requête HTTP
Requête path
/profiles/string
Requête header
"string"
Requête body
{ }
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du profil

string
Réponses
Code HTTP Description Schéma

200

OK

JsonNode

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/profiles/string/history
Requête header
"string"
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

owner
requis

Un propriétaire

OwnerDto
Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique d’un propriétaire

string
Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/owners/string
Requête header
"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",
  "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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du propriétaire

string

Body

owner
requis

Un propriétaire

OwnerDto
Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du propriétaire

string

Body

partialDto
requis

Contient les champs à modifier ainsi que leurs nouvelles valeurs

object
Réponses
Code HTTP Description Schéma

200

OK

OwnerDto

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

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
{ }
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du propriétaire

string
Réponses
Code HTTP Description Schéma

200

OK

JsonNode

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/owners/string/history
Requête header
"string"
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

Pas de contenu

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/autotest
Requête header
"string"
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

Pas de contenu

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/status
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
"OK"

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

subrogation
requis

Une subrogation

SubrogationDto
Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du groupe

string
Réponses
Code HTTP Description Schéma

200

OK

GroupDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/subrogations/groups/string
Requête header
"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.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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

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

SubrogationDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/subrogations/me/superuser
Requête header
"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.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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

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

SubrogationDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/subrogations/me/surrogate
Requête header
"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.6. Acceptation d’une subrogation par le subrogé

PATCH /subrogations/surrogate/accept/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de la subrogation

string
Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

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

404

Ressource non trouvée

Pas de contenu
Consomme

  • application/json

Exemple de requête HTTP
Requête path
/subrogations/surrogate/accept/string
Requête header
"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.7. Refus de la subrogation par le subrogé

DELETE /subrogations/surrogate/decline/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de la subrogation

string
Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu
Exemple de requête HTTP
Requête path
/subrogations/surrogate/decline/string
Requête header
"string"

2.9.8. Récupération paginée des utilisateurs génériques

GET /subrogations/users/generic
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

Critères de recherche

string

Query

direction
optionnel

Direction pour le tri

enum (ASC, DESC)

Query

orderBy
optionnel

Nom du champ sur lequel effectuer le tri

string

Query

page
requis

Numéro de la page

integer (int32)

Query

size
requis

Nombre de résultats maximum

integer (int32)
Réponses
Code HTTP Description Schéma

200

OK

PaginatedValuesDto«UserDto»

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/subrogations/users/generic
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" : 20,
  "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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de la subrogation

string
Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/subrogations/string
Requête header
"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.10. Modification d’une subrogation

PUT /subrogations/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de la subrogation

string

Body

subrogation
requis

Une subrogation

SubrogationDto
Réponses
Code HTTP Description Schéma

200

OK

SubrogationDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de la subrogation

string
Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu
Exemple de requête HTTP
Requête path
/subrogations/string
Requête header
"string"

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

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

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
/subrogations/string
Requête header
"string"

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

tenant
requis

Un tenant

TenantDto
Réponses
Code HTTP Description Schéma

200

OK

TenantDto

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique d’un tenant

string
Réponses
Code HTTP Description Schéma

200

OK

TenantDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/tenants/string
Requête header
"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.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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique d’un tenant

string

Body

tenant
requis

Un tenant

TenantDto
Réponses
Code HTTP Description Schéma

200

OK

TenantDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique du tenant

string

Body

partialDto
requis

Contient les champs à modifier ainsi que leurs nouvelles valeurs

object
Réponses
Code HTTP Description Schéma

200

OK

TenantDto

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

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
{ }
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

user
optionnel

Utilisateur à créer

UserDto
Réponses
Code HTTP Description Schéma

201

L’utilisateur a été créé avec succès

UserDto

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

Critères de recherche

string

Query

direction
optionnel

Direction pour le tri

enum (ASC, DESC)

Query

orderBy
optionnel

Nom du champ sur lequel effectuer le tri

string

Query

page
requis

Numéro de la page

integer (int32)

Query

size
requis

Nombre de résultats maximum

integer (int32)
Réponses
Code HTTP Description Schéma

200

Liste paginée des utilisateurs

PaginatedValuesDto«UserDto»

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

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" : 20,
  "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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Query

criteria
optionnel

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

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
/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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

criteria
optionnel

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

403

L’utilisateur ne possède pas les droits pour effectuer cette opération

Pas de contenu

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/users/levels
Requête header
"string"
Requête body
{ }
Exemple de réponse HTTP
Réponse 200
[ "string" ]

2.11.5. Modification de l’utilisateur courant

PATCH /users/me
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Body

partialDto
optionnel

Les modifications à faire pour les champs contenu dans la map

object
Réponses
Code HTTP Description Schéma

200

Mon utilisateur modifié

UserDto

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

404

Ressource non trouvée

Pas de contenu
Consomme

  • application/json

Exemple de requête HTTP
Requête path
/users/me
Requête header
"string"
Requête body
{ }
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.6. Récupération d’un utilisateur

GET /users/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de l’utilisateur

string
Réponses
Code HTTP Description Schéma

200

L’utilisateur trouvé

UserDto

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/users/string
Requête header
"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.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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de l’utilisateur

string

Body

user
optionnel

L’utilisateur modifié

UserDto
Réponses
Code HTTP Description Schéma

200

L’utilisateur modifié

UserDto

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

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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de l’utilisateur

string

Body

partialDto
optionnel

Contient les champs à modifier ainsi que leurs nouvelles valeurs

object
Réponses
Code HTTP Description Schéma

200

l’utilisateur modifié

UserDto

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

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
{ }
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
optionnel

Identifiant unique utilisé dans la génération des logs et des journaux VITAM

string

Header

X-Tenant-Id
requis

Identifiant du tenant sur lequel doit être exécuté la requête

integer (int32)

Header

X-User-Token
requis

Identifiant technique du token généré par le serveur CAS lors de l’authentification

string

Path

id
requis

Identifiant technique de l’utilisateur

string
Réponses
Code HTTP Description Schéma

200

Historique d’un utilisateur

JsonNode

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

404

Ressource non trouvée

Pas de contenu
Exemple de requête HTTP
Requête path
/users/string/history
Requête header
"string"
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
optionnel

Ville
Exemple : "Paris"

string

country
optionnel

Pays
Exemple : "France"

string

street
optionnel

Rue
Exemple : "43 avenue de la grande armée"

string

zipCode
optionnel

Code postal
Exemple : "75008"

string

3.2. ApplicationDto

Nom Description Schéma

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

identifier
optionnel
lecture seule

Identifiant métier
Exemple : "USERS_APP"

string

url
requis

URL de l’application
Exemple : "https://vitamui.com/user"

string

3.3. CustomerDto

Nom Description Schéma

address
requis

Exemple : "AddressDto"

AddressDto

code
requis

Identifiant métier
Exemple : "1"

string

companyName
requis

Nom de la compagnie
Exemple : "archiveco"

string

defaultEmailDomain
requis

Nom de domaine par défaut
Exemple : "@archiveco.fr"

string

emailDomains
requis

Ensemble des domaines
Exemple : [ "@archiveo.fr", "@archiveco.com" ]

< string > array

enabled
optionnel

Actif ou inactif
Exemple : true

boolean

hasCustomGraphicIdentity
requis

Exemple : true

boolean

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

identifier
optionnel
lecture seule

Identifiant métier
Exemple : "1"

string

language
requis

Préférence de langue pour les utilisateurs du client
Exemple : "FRENCH"

enum (FRENCH, ENGLISH, GERMANY)

name
requis

Nom du client
Exemple : "archiveco"

string

otp
requis

Authentification en 2 étapes pour les utilisateurs du client
Exemple : "OPTIONAL"

enum (OPTIONAL, DISABLED, MANDATORY)

owners
optionnel

Propriétaires du client
Exemple : [ "OwnerDto" ]

< OwnerDto > array

passwordRevocationDelay
requis

Durée de validitée des mot de passes pour les utilisateurs clients (exprimée en jours)
Exemple : 1

integer (int32)

readonly
optionnel
lecture seule

Lecture seule
Exemple : true

boolean

subrogeable
optionnel

Utilisateur du client subrogeable ou non
Exemple : true

boolean

3.4. GroupDto

Nom Description Schéma

customerId
requis

Identifiant technique du client
Exemple : "1"

string

description
requis

Exemple : "Groupe pour les utilisateurs RH"

string

enabled
optionnel

Actif ou Inactif
Exemple : true

boolean

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

identifier
optionnel
lecture seule

Identifiant métier
Exemple : "1"

string

level
optionnel

Niveau
Exemple : ""

string

name
requis

Nom
Exemple : "Groupe RH"

string

profileIds
optionnel

Ensemble des identifiants technique des profils contenu dans le groupe
Exemple : [ "1", "2", "3" ]

< string > array

profiles
optionnel

Ensemble des profiles du groupe
Exemple : [ "ProfileDto" ]

< ProfileDto > array

readonly
optionnel
lecture seule

Lecture seule
Exemple : true

boolean

usersCount
optionnel
lecture seule

Nombre d’utilisateurs contenu dans le groupe
Exemple : 0

integer (int64)

3.5. IdentityProviderDto

Nom Description Schéma

customerId
requis

Identifiant technique du client
Exemple : "1"

string

enabled
requis

Actif ou Inactif
Exemple : true

boolean

id
optionnel

Identifiant technique
Exemple : "1"

string

identifier
optionnel
lecture seule

Identifiant métier
Exemple : "1"

string

idpMetadata
optionnel

Metadata
Exemple : "string"

string

internal
requis

Authentification déléguée ou non
Exemple : true

boolean

keystoreBase64
optionnel

Keystore en base64
Exemple : "string"

string

keystorePassword
optionnel

Mot de passe
Exemple : "password"

string

maximumAuthenticationLifetime
optionnel

Durée maximum de validitée de l’authentification (exprimée en secondes)
Exemple : 86400

integer (int32)

name
requis

Nom
Exemple : "google_id"

string

patterns
optionnel

Regexp utilisée pour la décision par le serveur CAS de l’IDP à utiliser
Exemple : [ ".*@archiveco.fr" ]

< string > array

privateKeyPassword
optionnel

Mot de passe de la clé privée
Exemple : "password"

string

readonly
optionnel
lecture seule

Lecture seule
Exemple : true

boolean

spMetadata
optionnel
lecture seule

Exemple : "string"

string

technicalName
requis

Nom technique
Exemple : "idparchiveco"

string

3.6. JsonNode

Nom Description Schéma

array
optionnel

Exemple : true

boolean

bigDecimal
optionnel

Exemple : true

boolean

bigInteger
optionnel

Exemple : true

boolean

binary
optionnel

Exemple : true

boolean

boolean
optionnel

Exemple : true

boolean

containerNode
optionnel

Exemple : true

boolean

double
optionnel

Exemple : true

boolean

float
optionnel

Exemple : true

boolean

floatingPointNumber
optionnel

Exemple : true

boolean

int
optionnel

Exemple : true

boolean

integralNumber
optionnel

Exemple : true

boolean

long
optionnel

Exemple : true

boolean

missingNode
optionnel

Exemple : true

boolean

nodeType
optionnel

Exemple : "string"

enum (ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING)

null
optionnel

Exemple : true

boolean

number
optionnel

Exemple : true

boolean

object
optionnel

Exemple : true

boolean

pojo
optionnel

Exemple : true

boolean

short
optionnel

Exemple : true

boolean

textual
optionnel

Exemple : true

boolean

valueNode
optionnel

Exemple : true

boolean

3.7. LoginRequestDto

Nom Description Schéma

ip
optionnel

Addresse IP de l’utilisateur
Exemple : "192.168.1.0"

string

password
requis

Mot de passe saisie par l’utilisateur
Exemple : "password"

string

surrogate
optionnel

Adresse mail de l’utilisateur à subroger
Exemple : "surrogate@archiveco.fr"

string

username
requis

Adresse mail saisie par l’utilisateur
Exemple : "toto@archiveco.fr"

string

3.8. OwnerDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

code
requis

Identifiant métier
Exemple : "1"

string

companyName
requis

Nom de la compagnie
Exemple : "archiveco"

string

customerId
requis

Identifiant technique du client
Exemple : "1"

string

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

identifier
optionnel
lecture seule

Identifiant métier
Exemple : "1"

string

name
requis

Nom
Exemple : "toto"

string

readonly
optionnel
lecture seule

Lecture seule
Exemple : true

boolean

3.9. PaginatedValuesDto«CustomerDto»

Nom Description Schéma

hasMore
optionnel

Présence de résultats supplémentaires
Exemple : true

boolean

pageNum
optionnel

Numéro de la page
Exemple : 0

integer (int32)

pageSize
optionnel

Taille de la page
Exemple : 20

integer (int32)

values
optionnel

Résultats
Exemple : [ "CustomerDto" ]

< CustomerDto > array

3.10. PaginatedValuesDto«GroupDto»

Nom Description Schéma

hasMore
optionnel

Présence de résultats supplémentaires
Exemple : true

boolean

pageNum
optionnel

Numéro de la page
Exemple : 0

integer (int32)

pageSize
optionnel

Taille de la page
Exemple : 20

integer (int32)

values
optionnel

Résultats
Exemple : [ "GroupDto" ]

< GroupDto > array

3.11. PaginatedValuesDto«ProfileDto»

Nom Description Schéma

hasMore
optionnel

Présence de résultats supplémentaires
Exemple : true

boolean

pageNum
optionnel

Numéro de la page
Exemple : 0

integer (int32)

pageSize
optionnel

Taille de la page
Exemple : 20

integer (int32)

values
optionnel

Résultats
Exemple : [ "ProfileDto" ]

< ProfileDto > array

3.12. PaginatedValuesDto«UserDto»

Nom Description Schéma

hasMore
optionnel

Présence de résultats supplémentaires
Exemple : true

boolean

pageNum
optionnel

Numéro de la page
Exemple : 0

integer (int32)

pageSize
optionnel

Taille de la page
Exemple : 20

integer (int32)

values
optionnel

Résultats
Exemple : [ "UserDto" ]

< UserDto > array

3.13. ProfileDto

Nom Description Schéma

applicationName
requis

Identifiant de l’application métier
Exemple : "USERS_APP"

string

customerId
requis

Identifiant technique du client
Exemple : "1"

string

description
requis

Description
Exemple : "profile des droits utilisateurs"

string

enabled
optionnel

Actif ou Inactif
Exemple : true

boolean

externalParamId
optionnel

Identifier technique d’un paramètre extérieur
Exemple : "string"

string

externalParamIdentifier
optionnel

Identifier métier d’un paramètre extérieur
Exemple : "string"

string

groupsCount
optionnel
lecture seule

Nombre de groupe contenant ce profile
Exemple : 2

integer (int64)

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

identifier
optionnel
lecture seule

Identifiant métier
Exemple : "1"

string

level
optionnel

Niveau
Exemple : ""

string

name
requis

Nom
Exemple : "ProfileRH"

string

readonly
optionnel
lecture seule

Lecture seule
Exemple : true

boolean

roles
optionnel

Ensemble des rôles
Exemple : [ "Role" ]

< Role > array

tenantIdentifier
requis

Identifiant métier du tenant
Exemple : 1

integer (int32)

tenantName
optionnel
lecture seule

Nom du tenant
Exemple : "Tenant 1"

string

usersCount
optionnel
lecture seule

Nombre d’utilisateurs
Exemple : 10

integer (int64)

3.14. Role

Nom Description Schéma

name
requis

Nom du rôle
Exemple : "ROLE_CREATE_USERS"

string

3.15. SubrogationDto

Nom Description Schéma

date
optionnel

Date de fin de la subrogation
Exemple : "string"

string (date-time)

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

status
requis

Statut
Exemple : "CREATED"

enum (CREATED, ACCEPTED)

superUser
requis

Email de l’utilisateur subrogateur
Exemple : "superuser@arhiveco.fr"

string

superUserCustomerId
optionnel

Identifiant métier du client de l’utilisateur subrogateur
Exemple : "1"

string

surrogate
requis

Email de l’utilisateur subrogée
Exemple : "surrogate@archiveco.fr"

string

surrogateCustomerId
optionnel

Identifiant métier du client de l’utilisateur subrogée
Exemple : "1"

string

3.16. TenantDto

Nom Description Schéma

accessContractHoldingIdentifier
optionnel

Identifiant technique du contrat d’accès utilisé pour la gestion de l’arbre
Exemple : "AC-00002"

string

accessContractLogbookIdentifier
optionnel

Identifiant technique du contrat d’accès utilisé pour accèder aux logbook VITAM
Exemple : "AC-00001"

string

customerId
requis

Identifiant technique du client
Exemple : "1"

string

enabled
requis

Actif ou Inactif
Exemple : true

boolean

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

identifier
optionnel

Identifiant technique du tenant VITAM
Exemple : 1

integer (int32)

ingestContractHoldingIdentifier
optionnel

Identifiant technique du contrat d’éntrée utilisé pour la gestion de l’arbre
Exemple : "IC-00002"

string

itemIngestContractIdentifier
optionnel

Identifiant technique du contrat d’éntrée utilisé pour l’envoi de documents dans VITAM
Exemple : "IC-00001"

string

name
requis

Nom
Exemple : "tenant 10"

string

ownerId
optionnel

Identifiant technique du propriétaire
Exemple : "1"

string

proof
optionnel

Tenant générée automatiquement lors de la création d’un client
Exemple : true

boolean

readonly
optionnel
lecture seule

Lecture seule
Exemple : true

boolean

3.17. UserDto

Nom Description Schéma

customerId
requis

Identifiant technique du client
Exemple : "1"

string

email
requis

Adresse mail
Exemple : "toto@example.fr"

string

firstname
requis

Prénom
Exemple : "toto"

string

groupId
requis

Identifiant technique du groupe
Exemple : "1"

string

id
optionnel
lecture seule

Identifiant technique
Exemple : "1"

string

identifier
optionnel
lecture seule

Identifiant métier
Exemple : "1"

string

language
requis

Langue
Exemple : "string"

enum (FR, DE, EN)

lastConnection
optionnel

Date de la derniére connexion de l’utilisateur au format ISO-8601
Exemple : "string"

string (date-time)

lastname
requis

Nom de famille
Exemple : "DUPONT"

string

level
optionnel

Niveau
Exemple : " "

string

mobile
optionnel

Numéro de téléphone portable au format international
Exemple : "+33667678250"

string

nbFailedAttempts
optionnel

Nombre de tantive échouée depuis la dernière connexion réussie
Exemple : 0

integer (int32)

otp
optionnel

Double authentification activée ou non
Exemple : true

boolean

passwordExpirationDate
optionnel

Date d’expiration du mot de passe
Exemple : "string"

string (date-time)

phone
optionnel

Numéro de téléphone fixe au format international
Exemple : "+33145868450"

string

readonly
optionnel
lecture seule

Lecture seule
Exemple : true

boolean

status
optionnel

Statut
Exemple : "string"

enum (ENABLED, DISABLED, BLOCKED, ANONYM)

subrogeable
optionnel

Subrogeable
Exemple : true

boolean

type
optionnel

Type
Exemple : "string"

enum (GENERIC, NOMINATIVE)