1. Vue générale

This API is used by the UI to manage customers, tenants, identity providers, users with their profiles and their profiles groups. This API should be used by the Identity UI only.

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 : URL not defined.
Conditions de service : Terms of service

1.4. Schéma d’URI

Serveur : localhost
Chemin de base : /

1.5. Tags

  • customers : Customer Controller

  • groups : Group Controller

  • owners : Owner Controller

  • profiles : Profile Controller

  • providers : Provider Controller

  • tenants : Tenant Controller

  • users : User Controller

1.6. Produit

  • application/json

2. Ressources

2.1. Customers

Customer Controller

2.1.1. Create entity

POST /identity-api/customers
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

customerDto.address.city
optionnel

string

Query

customerDto.address.country
optionnel

string

Query

customerDto.address.street
optionnel

string

Query

customerDto.address.zipCode
optionnel

string

Query

customerDto.code
optionnel

string

Query

customerDto.companyName
optionnel

string

Query

customerDto.defaultEmailDomain
optionnel

string

Query

customerDto.emailDomains
optionnel

< string > array(multi)

Query

customerDto.enabled
optionnel

boolean

Query

customerDto.hasCustomGraphicIdentity
optionnel

boolean

Query

customerDto.id
optionnel

string

Query

customerDto.identifier
optionnel

string

Query

customerDto.language
optionnel

enum (FRENCH, ENGLISH, GERMANY)

Query

customerDto.name
optionnel

string

Query

customerDto.otp
optionnel

enum (OPTIONAL, DISABLED, MANDATORY)

Query

customerDto.owners[0].address.city
optionnel

string

Query

customerDto.owners[0].address.country
optionnel

string

Query

customerDto.owners[0].address.street
optionnel

string

Query

customerDto.owners[0].address.zipCode
optionnel

string

Query

customerDto.owners[0].code
optionnel

string

Query

customerDto.owners[0].companyName
optionnel

string

Query

customerDto.owners[0].customerId
optionnel

string

Query

customerDto.owners[0].id
optionnel

string

Query

customerDto.owners[0].identifier
optionnel

string

Query

customerDto.owners[0].name
optionnel

string

Query

customerDto.owners[0].readonly
optionnel

boolean

Query

customerDto.passwordRevocationDelay
optionnel

integer (int32)

Query

customerDto.readonly
optionnel

boolean

Query

customerDto.subrogeable
optionnel

boolean

Query

logo
optionnel

file

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

  • multipart/form-data

Exemple de requête HTTP
Requête path
/identity-api/customers
Requête header
"string"
Requête query
{
  "customerDto.address.city" : "string",
  "customerDto.address.country" : "string",
  "customerDto.address.street" : "string",
  "customerDto.address.zipCode" : "string",
  "customerDto.code" : "string",
  "customerDto.companyName" : "string",
  "customerDto.defaultEmailDomain" : "string",
  "customerDto.emailDomains" : "string",
  "customerDto.enabled" : true,
  "customerDto.hasCustomGraphicIdentity" : true,
  "customerDto.id" : "string",
  "customerDto.identifier" : "string",
  "customerDto.language" : "string",
  "customerDto.name" : "string",
  "customerDto.otp" : "string",
  "customerDto.owners[0].address.city" : "string",
  "customerDto.owners[0].address.country" : "string",
  "customerDto.owners[0].address.street" : "string",
  "customerDto.owners[0].address.zipCode" : "string",
  "customerDto.owners[0].code" : "string",
  "customerDto.owners[0].companyName" : "string",
  "customerDto.owners[0].customerId" : "string",
  "customerDto.owners[0].id" : "string",
  "customerDto.owners[0].identifier" : "string",
  "customerDto.owners[0].name" : "string",
  "customerDto.owners[0].readonly" : true,
  "customerDto.passwordRevocationDelay" : 0,
  "customerDto.readonly" : true,
  "customerDto.subrogeable" : true,
  "logo" : "file"
}
Exemple de réponse HTTP
Réponse 201
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "readonly" : true,
  "subrogeable" : true
}

2.1.2. Get all entities

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

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/customers
Requête header
"string"
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "readonly" : true,
  "subrogeable" : true
} ]

2.1.3. Check entity exist by criteria

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

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
requis

criteria

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
/identity-api/customers/check
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.1.4. getMyCustomer

GET /identity-api/customers/me
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/customers/me
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "readonly" : true,
  "subrogeable" : true
}

2.1.5. Get entity

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

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/customers/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "readonly" : true,
  "subrogeable" : true
}

2.1.6. Update entity

PUT /identity-api/customers/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

entityDto
requis

entityDto

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/customers/string
Requête header
"string"
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "readonly" : true,
  "subrogeable" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "readonly" : true,
  "subrogeable" : true
}

2.1.7. Patch entity

PATCH /identity-api/customers/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

Identifiant du client à mettre à jour

string

FormData

logo
optionnel

Fichier du logo du client. Paramètre optionnel qui n’est présent que dans le cas d’une modification de l’identité graphique personnalisée du client

file

FormData

partialCustomerDto
optionnel

Map<String, Object> contenant obligatoirement une clé id avec l’id du client à mettre à jour 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

Non trouvée

Pas de contenu

Consomme
  • application/json

  • multipart/form-data

Exemple de requête HTTP
Requête path
/identity-api/customers/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "defaultEmailDomain" : "string",
  "emailDomains" : [ "string" ],
  "enabled" : true,
  "hasCustomGraphicIdentity" : true,
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "name" : "string",
  "otp" : "string",
  "owners" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "code" : "string",
    "companyName" : "string",
    "customerId" : "string",
    "id" : "string",
    "identifier" : "string",
    "name" : "string",
    "readonly" : true
  } ],
  "passwordRevocationDelay" : 0,
  "readonly" : true,
  "subrogeable" : true
}

2.1.8. get history by customer’s id

GET /identity-api/customers/{id}/history
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/customers/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "events" : [ {
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string"
    } ],
    "obId" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string"
  } ]
}

2.1.9. Get entity logo

GET /identity-api/customers/{id}/logo
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Resource

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/customers/string/logo
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : {
    "absolute" : true,
    "absoluteFile" : {
      "absolute" : true,
      "absoluteFile" : "...",
      "absolutePath" : "string",
      "canonicalFile" : "...",
      "canonicalPath" : "string",
      "directory" : true,
      "file" : true,
      "freeSpace" : 0,
      "hidden" : true,
      "name" : "string",
      "parent" : "string",
      "parentFile" : "...",
      "path" : "string",
      "totalSpace" : 0,
      "usableSpace" : 0
    },
    "absolutePath" : "string",
    "canonicalFile" : "...",
    "canonicalPath" : "string",
    "directory" : true,
    "file" : true,
    "freeSpace" : 0,
    "hidden" : true,
    "name" : "string",
    "parent" : "string",
    "parentFile" : "...",
    "path" : "string",
    "totalSpace" : 0,
    "usableSpace" : 0
  },
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : {
    "absolute" : true,
    "authority" : "string",
    "fragment" : "string",
    "host" : "string",
    "opaque" : true,
    "path" : "string",
    "port" : 0,
    "query" : "string",
    "rawAuthority" : "string",
    "rawFragment" : "string",
    "rawPath" : "string",
    "rawQuery" : "string",
    "rawSchemeSpecificPart" : "string",
    "rawUserInfo" : "string",
    "scheme" : "string",
    "schemeSpecificPart" : "string",
    "userInfo" : "string"
  },
  "url" : {
    "authority" : "string",
    "content" : "object",
    "defaultPort" : 0,
    "file" : "string",
    "host" : "string",
    "path" : "string",
    "port" : 0,
    "protocol" : "string",
    "query" : "string",
    "ref" : "string",
    "userInfo" : "string"
  }
}

2.2. Groups

Group Controller

2.2.1. Create entity

POST /identity-api/groups
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Body

entityDto
requis

entityDto

GroupDto

Réponses
Code HTTP Description Schéma

201

Created

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
/identity-api/groups
Requête header
"string"
Requête body
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}
Exemple de réponse HTTP
Réponse 201
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.2.2. Get entities paginated

GET /identity-api/groups
Paramètres
Type Nom Description Schéma Défaut

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

string

Query

direction
optionnel

direction

enum (ASC, DESC)

Query

embedded
optionnel

embedded

string

"ALL"

Query

orderBy
optionnel

orderBy

string

Query

page
requis

page

string

Query

size
requis

size

string

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/groups
Requête header
"string"
Requête query
{
  "criteria" : "string",
  "direction" : "string",
  "embedded" : "string",
  "orderBy" : "string",
  "page" : "string",
  "size" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "hasMore" : true,
  "pageNum" : 0,
  "pageSize" : 0,
  "values" : [ {
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "profileIds" : [ "string" ],
    "profiles" : [ {
      "applicationName" : "string",
      "customerId" : "string",
      "description" : "string",
      "enabled" : true,
      "externalParamId" : "string",
      "externalParamIdentifier" : "string",
      "groupsCount" : 0,
      "id" : "string",
      "identifier" : "string",
      "level" : "string",
      "name" : "string",
      "readonly" : true,
      "roles" : [ {
        "name" : "string"
      } ],
      "tenantIdentifier" : 0,
      "tenantName" : "string",
      "usersCount" : 0
    } ],
    "readonly" : true,
    "usersCount" : 0
  } ]
}

2.2.3. Check entity exist by criteria

HEAD /identity-api/groups/check
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
requis

criteria

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
/identity-api/groups/check
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.2.4. getLevels

GET /identity-api/groups/levels
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/groups/levels
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.2.5. Get entity, can be filter by enabled value

GET /identity-api/groups/{id}
Paramètres
Type Nom Description Schéma Défaut

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Query

embedded
optionnel

embedded

string

"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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/groups/string
Requête header
"string"
Requête query
{
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.2.6. Update partially group

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

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

partialDto
requis

partialDto

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/groups/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "profileIds" : [ "string" ],
  "profiles" : [ {
    "applicationName" : "string",
    "customerId" : "string",
    "description" : "string",
    "enabled" : true,
    "externalParamId" : "string",
    "externalParamIdentifier" : "string",
    "groupsCount" : 0,
    "id" : "string",
    "identifier" : "string",
    "level" : "string",
    "name" : "string",
    "readonly" : true,
    "roles" : [ {
      "name" : "string"
    } ],
    "tenantIdentifier" : 0,
    "tenantName" : "string",
    "usersCount" : 0
  } ],
  "readonly" : true,
  "usersCount" : 0
}

2.2.7. get history by group’s id

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

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/groups/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "events" : [ {
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string"
    } ],
    "obId" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string"
  } ]
}

2.3. Owners

Owner Controller

2.3.1. Create entity

POST /identity-api/owners
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Body

entityDto
requis

entityDto

OwnerDto

Réponses
Code HTTP Description Schéma

201

Created

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
/identity-api/owners
Requête header
"string"
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 201
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "readonly" : true
}

2.3.2. Check entity exist by criteria

HEAD /identity-api/owners/check
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
requis

criteria

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
/identity-api/owners/check
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.3.3. Get entity

GET /identity-api/owners/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/owners/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "readonly" : true
}

2.3.4. Update entity

PUT /identity-api/owners/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

entityDto
requis

entityDto

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/owners/string
Requête header
"string"
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "readonly" : true
}

2.3.5. Patch entity

PATCH /identity-api/owners/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

partialDto
requis

partialDto

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/owners/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "code" : "string",
  "companyName" : "string",
  "customerId" : "string",
  "id" : "string",
  "identifier" : "string",
  "name" : "string",
  "readonly" : true
}

2.3.6. get history by owner’s id

GET /identity-api/owners/{id}/history
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/owners/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "events" : [ {
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string"
    } ],
    "obId" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string"
  } ]
}

2.4. Profiles

Profile Controller

2.4.1. Create entity

POST /identity-api/profiles
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Body

entityDto
requis

entityDto

ProfileDto

Réponses
Code HTTP Description Schéma

201

Created

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
/identity-api/profiles
Requête header
"string"
Requête body
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}
Exemple de réponse HTTP
Réponse 201
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}

2.4.2. Get all entities

GET /identity-api/profiles
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

string

Query

embedded
optionnel

embedded

string

Réponses
Code HTTP Description Schéma

200

OK

< ProfileDto > 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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/profiles
Requête header
"string"
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
} ]

2.4.3. Check entity exists by criteria

HEAD /identity-api/profiles/check
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
requis

criteria

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
/identity-api/profiles/check
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.4.4. getLevels

GET /identity-api/profiles/levels
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/profiles/levels
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.4.5. Get entity

GET /identity-api/profiles/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Query

embedded
optionnel

embedded

string

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/profiles/string
Requête header
"string"
Requête query
{
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}

2.4.6. Update partially entity

PATCH /identity-api/profiles/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

profile
requis

profile

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/profiles/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "applicationName" : "string",
  "customerId" : "string",
  "description" : "string",
  "enabled" : true,
  "externalParamId" : "string",
  "externalParamIdentifier" : "string",
  "groupsCount" : 0,
  "id" : "string",
  "identifier" : "string",
  "level" : "string",
  "name" : "string",
  "readonly" : true,
  "roles" : [ {
    "name" : "string"
  } ],
  "tenantIdentifier" : 0,
  "tenantName" : "string",
  "usersCount" : 0
}

2.4.7. get history by profile’s id

GET /identity-api/profiles/{id}/history
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/profiles/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "events" : [ {
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string"
    } ],
    "obId" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string"
  } ]
}

2.5. Providers

Provider Controller

2.5.1. Get all entities

GET /identity-api/providers
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

string

Query

embedded
optionnel

embedded

string

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/providers
Requête header
"string"
Requête query
{
  "criteria" : "string",
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
} ]

2.5.2. Get entity

GET /identity-api/providers/{id}
Paramètres
Type Nom Description Schéma Défaut

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Query

embedded
optionnel

embedded

string

"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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/providers/string
Requête header
"string"
Requête query
{
  "embedded" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
}

2.5.3. Update partially provider

PATCH /identity-api/providers/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

provider
requis

provider

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/providers/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : "string",
  "idpMetadata" : "string",
  "internal" : true,
  "keystoreBase64" : "string",
  "keystorePassword" : "string",
  "maximumAuthenticationLifetime" : 0,
  "name" : "string",
  "patterns" : [ "string" ],
  "privateKeyPassword" : "string",
  "readonly" : true,
  "spMetadata" : "string",
  "technicalName" : "string"
}

2.5.4. Get metadata provider

GET /identity-api/providers/{id}/idpMetadata
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Query

tenantId
requis

tenantId

integer (int32)

Réponses
Code HTTP Description Schéma

200

OK

Resource

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/providers/string/idpMetadata
Requête header
"string"
Requête query
{
  "tenantId" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : {
    "absolute" : true,
    "absoluteFile" : {
      "absolute" : true,
      "absoluteFile" : "...",
      "absolutePath" : "string",
      "canonicalFile" : "...",
      "canonicalPath" : "string",
      "directory" : true,
      "file" : true,
      "freeSpace" : 0,
      "hidden" : true,
      "name" : "string",
      "parent" : "string",
      "parentFile" : "...",
      "path" : "string",
      "totalSpace" : 0,
      "usableSpace" : 0
    },
    "absolutePath" : "string",
    "canonicalFile" : "...",
    "canonicalPath" : "string",
    "directory" : true,
    "file" : true,
    "freeSpace" : 0,
    "hidden" : true,
    "name" : "string",
    "parent" : "string",
    "parentFile" : "...",
    "path" : "string",
    "totalSpace" : 0,
    "usableSpace" : 0
  },
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : {
    "absolute" : true,
    "authority" : "string",
    "fragment" : "string",
    "host" : "string",
    "opaque" : true,
    "path" : "string",
    "port" : 0,
    "query" : "string",
    "rawAuthority" : "string",
    "rawFragment" : "string",
    "rawPath" : "string",
    "rawQuery" : "string",
    "rawSchemeSpecificPart" : "string",
    "rawUserInfo" : "string",
    "scheme" : "string",
    "schemeSpecificPart" : "string",
    "userInfo" : "string"
  },
  "url" : {
    "authority" : "string",
    "content" : "object",
    "defaultPort" : 0,
    "file" : "string",
    "host" : "string",
    "path" : "string",
    "port" : 0,
    "protocol" : "string",
    "query" : "string",
    "ref" : "string",
    "userInfo" : "string"
  }
}

2.6. Tenants

Tenant Controller

2.6.1. Create entity

POST /identity-api/tenants
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Body

entityDto
requis

entityDto

TenantDto

Réponses
Code HTTP Description Schéma

201

Created

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
/identity-api/tenants
Requête header
"string"
Requête body
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 201
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.6.2. Get all entities

GET /identity-api/tenants
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/tenants
Requête header
"string"
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
} ]

2.6.3. Check entity exist by criteria

HEAD /identity-api/tenants/check
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
requis

criteria

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
/identity-api/tenants/check
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.6.4. Get entity

GET /identity-api/tenants/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/tenants/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.6.5. Update entity

PUT /identity-api/tenants/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

entityDto
requis

entityDto

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/tenants/string
Requête header
"string"
Requête body
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}
Exemple de réponse HTTP
Réponse 200
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.6.6. Patch entity

PATCH /identity-api/tenants/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

partialDto
requis

partialDto

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/tenants/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "accessContractHoldingIdentifier" : "string",
  "accessContractLogbookIdentifier" : "string",
  "customerId" : "string",
  "enabled" : true,
  "id" : "string",
  "identifier" : 0,
  "ingestContractHoldingIdentifier" : "string",
  "itemIngestContractIdentifier" : "string",
  "name" : "string",
  "ownerId" : "string",
  "proof" : true,
  "readonly" : true
}

2.7. Users

User Controller

2.7.1. Create entity

POST /identity-api/users
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Body

dto
requis

dto

UserDto

Réponses
Code HTTP Description Schéma

201

Created

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
/identity-api/users
Requête header
"string"
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "customerId" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}
Exemple de réponse HTTP
Réponse 201
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "customerId" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.7.2. Find users by customer

GET /identity-api/users
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

string

Query

direction
optionnel

direction

enum (ASC, DESC)

Query

orderBy
optionnel

orderBy

string

Query

page
requis

page

integer (int32)

Query

size
requis

size

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/users
Requête header
"string"
Requête query
{
  "criteria" : "string",
  "direction" : "string",
  "orderBy" : "string",
  "page" : 0,
  "size" : 0
}
Exemple de réponse HTTP
Réponse 200
{
  "hasMore" : true,
  "pageNum" : 0,
  "pageSize" : 0,
  "values" : [ {
    "address" : {
      "city" : "string",
      "country" : "string",
      "street" : "string",
      "zipCode" : "string"
    },
    "customerId" : "string",
    "email" : "string",
    "firstname" : "string",
    "groupId" : "string",
    "id" : "string",
    "identifier" : "string",
    "language" : "string",
    "lastConnection" : "string",
    "lastname" : "string",
    "level" : "string",
    "mobile" : "string",
    "nbFailedAttempts" : 0,
    "otp" : true,
    "passwordExpirationDate" : "string",
    "phone" : "string",
    "readonly" : true,
    "status" : "string",
    "subrogeable" : true,
    "type" : "string"
  } ]
}

2.7.3. Check entity exist by params

HEAD /identity-api/users/check
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
requis

criteria

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
/identity-api/users/check
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.7.4. getLevels

GET /identity-api/users/levels
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Query

criteria
optionnel

criteria

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/users/levels
Requête header
"string"
Requête query
{
  "criteria" : "string"
}

2.7.5. Get entity

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

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

Identifiant 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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/users/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "customerId" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.7.6. Update entity

PUT /identity-api/users/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Body

userDto
requis

userDto

UserDto

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/users/{id}
Requête header
"string"
Requête body
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "customerId" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "customerId" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.7.7. Patch entity

PATCH /identity-api/users/{id}
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Body

partialDto
requis

partialDto

object

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

Non trouvée

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/identity-api/users/string
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "address" : {
    "city" : "string",
    "country" : "string",
    "street" : "string",
    "zipCode" : "string"
  },
  "customerId" : "string",
  "email" : "string",
  "firstname" : "string",
  "groupId" : "string",
  "id" : "string",
  "identifier" : "string",
  "language" : "string",
  "lastConnection" : "string",
  "lastname" : "string",
  "level" : "string",
  "mobile" : "string",
  "nbFailedAttempts" : 0,
  "otp" : true,
  "passwordExpirationDate" : "string",
  "phone" : "string",
  "readonly" : true,
  "status" : "string",
  "subrogeable" : true,
  "type" : "string"
}

2.7.8. get history by user’s id

GET /identity-api/users/{id}/history
Paramètres
Type Nom Description Schéma

Header

X-Application-Id
optionnel

Identifiant unique transférer 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ée la requête

integer (int32)

Header

X-User-Token
requis

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

string

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

LogbookOperationsResponseDto

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

Non trouvée

Pas de contenu

Exemple de requête HTTP
Requête path
/identity-api/users/string/history
Requête header
"string"
Exemple de réponse HTTP
Réponse 200
{
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "evDateTime" : "string",
    "evDetData" : "string",
    "evId" : "string",
    "evIdAppSession" : "string",
    "evParentId" : "string",
    "evType" : "string",
    "events" : [ {
      "evDateTime" : "string",
      "evDetData" : "string",
      "evId" : "string",
      "evIdAppSession" : "string",
      "evParentId" : "string",
      "evType" : "string",
      "obId" : "string",
      "obIdReq" : "string",
      "outDetail" : "string",
      "outMessg" : "string",
      "outcome" : "string"
    } ],
    "obId" : "string",
    "obIdReq" : "string",
    "outDetail" : "string",
    "outMessg" : "string",
    "outcome" : "string"
  } ]
}

3. Définitions

3.1. AddressDto

Nom Description Schéma

city
optionnel

Exemple : "string"

string

country
optionnel

Exemple : "string"

string

street
optionnel

Exemple : "string"

string

zipCode
optionnel

Exemple : "string"

string

3.2. CustomerDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

code
optionnel

Exemple : "string"

string

companyName
optionnel

Exemple : "string"

string

defaultEmailDomain
optionnel

Exemple : "string"

string

emailDomains
optionnel

Exemple : [ "string" ]

< string > array

enabled
optionnel

Exemple : true

boolean

hasCustomGraphicIdentity
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

language
optionnel

Exemple : "string"

enum (FRENCH, ENGLISH, GERMANY)

name
optionnel

Exemple : "string"

string

otp
optionnel

Exemple : "string"

enum (OPTIONAL, DISABLED, MANDATORY)

owners
optionnel

Exemple : [ "OwnerDto" ]

< OwnerDto > array

passwordRevocationDelay
optionnel

Exemple : 0

integer (int32)

readonly
optionnel

Exemple : true

boolean

subrogeable
optionnel

Exemple : true

boolean

3.3. File

Nom Description Schéma

absolute
optionnel

Exemple : true

boolean

absoluteFile
optionnel

Exemple : "File"

File

absolutePath
optionnel

Exemple : "string"

string

canonicalFile
optionnel

Exemple : "File"

File

canonicalPath
optionnel

Exemple : "string"

string

directory
optionnel

Exemple : true

boolean

file
optionnel

Exemple : true

boolean

freeSpace
optionnel

Exemple : 0

integer (int64)

hidden
optionnel

Exemple : true

boolean

name
optionnel

Exemple : "string"

string

parent
optionnel

Exemple : "string"

string

parentFile
optionnel

Exemple : "File"

File

path
optionnel

Exemple : "string"

string

totalSpace
optionnel

Exemple : 0

integer (int64)

usableSpace
optionnel

Exemple : 0

integer (int64)

3.4. GroupDto

Nom Description Schéma

customerId
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

level
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

profileIds
optionnel

Exemple : [ "string" ]

< string > array

profiles
optionnel

Exemple : [ "ProfileDto" ]

< ProfileDto > array

readonly
optionnel

Exemple : true

boolean

usersCount
optionnel

Exemple : 0

integer (int64)

3.5. HitsDto

Nom Description Schéma

limit
optionnel

Exemple : 0

integer (int32)

offset
optionnel

Exemple : 0

integer (int32)

size
optionnel

Exemple : 0

integer (int32)

total
optionnel

Exemple : 0

integer (int32)

3.6. IdentityProviderDto

Nom Description Schéma

customerId
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

idpMetadata
optionnel

Exemple : "string"

string

internal
optionnel

Exemple : true

boolean

keystoreBase64
optionnel

Exemple : "string"

string

keystorePassword
optionnel

Exemple : "string"

string

maximumAuthenticationLifetime
optionnel

Exemple : 0

integer (int32)

name
optionnel

Exemple : "string"

string

patterns
optionnel

Exemple : [ "string" ]

< string > array

privateKeyPassword
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

spMetadata
optionnel

Exemple : "string"

string

technicalName
optionnel

Exemple : "string"

string

3.7. InputStream

Type : object

3.8. LogbookEventDto

Nom Description Schéma

evDateTime
optionnel

Exemple : "string"

string

evDetData
optionnel

Exemple : "string"

string

evId
optionnel

Exemple : "string"

string

evIdAppSession
optionnel

Exemple : "string"

string

evParentId
optionnel

Exemple : "string"

string

evType
optionnel

Exemple : "string"

string

obId
optionnel

Exemple : "string"

string

obIdReq
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessg
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

3.9. LogbookOperationDto

Nom Description Schéma

evDateTime
optionnel

Exemple : "string"

string

evDetData
optionnel

Exemple : "string"

string

evId
optionnel

Exemple : "string"

string

evIdAppSession
optionnel

Exemple : "string"

string

evParentId
optionnel

Exemple : "string"

string

evType
optionnel

Exemple : "string"

string

events
optionnel

Exemple : [ "LogbookEventDto" ]

< LogbookEventDto > array

obId
optionnel

Exemple : "string"

string

obIdReq
optionnel

Exemple : "string"

string

outDetail
optionnel

Exemple : "string"

string

outMessg
optionnel

Exemple : "string"

string

outcome
optionnel

Exemple : "string"

string

3.10. LogbookOperationsResponseDto

Nom Description Schéma

$hits
optionnel

Exemple : "HitsDto"

HitsDto

$results
optionnel

Exemple : [ "LogbookOperationDto" ]

< LogbookOperationDto > array

3.11. OwnerDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

code
optionnel

Exemple : "string"

string

companyName
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

3.12. PaginatedValuesDto«CustomerDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "CustomerDto" ]

< CustomerDto > array

3.13. PaginatedValuesDto«GroupDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "GroupDto" ]

< GroupDto > array

3.14. PaginatedValuesDto«ProfileDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "ProfileDto" ]

< ProfileDto > array

3.15. PaginatedValuesDto«UserDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "UserDto" ]

< UserDto > array

3.16. ProfileDto

Nom Description Schéma

applicationName
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

description
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

externalParamId
optionnel

Exemple : "string"

string

externalParamIdentifier
optionnel

Exemple : "string"

string

groupsCount
optionnel

Exemple : 0

integer (int64)

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

level
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

roles
optionnel

Exemple : [ "Role" ]

< Role > array

tenantIdentifier
optionnel

Exemple : 0

integer (int32)

tenantName
optionnel

Exemple : "string"

string

usersCount
optionnel

Exemple : 0

integer (int64)

3.17. Resource

Nom Description Schéma

description
optionnel

Exemple : "string"

string

file
optionnel

Exemple : "File"

File

filename
optionnel

Exemple : "string"

string

inputStream
optionnel

Exemple : "InputStream"

InputStream

open
optionnel

Exemple : true

boolean

readable
optionnel

Exemple : true

boolean

uri
optionnel

Exemple : "URI"

URI

url
optionnel

Exemple : "URL"

URL

3.18. Role

Nom Description Schéma

name
optionnel

Exemple : "string"

string

3.19. TenantDto

Nom Description Schéma

accessContractHoldingIdentifier
optionnel

Exemple : "string"

string

accessContractLogbookIdentifier
optionnel

Exemple : "string"

string

customerId
optionnel

Exemple : "string"

string

enabled
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : 0

integer (int32)

ingestContractHoldingIdentifier
optionnel

Exemple : "string"

string

itemIngestContractIdentifier
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

ownerId
optionnel

Exemple : "string"

string

proof
optionnel

Exemple : true

boolean

readonly
optionnel

Exemple : true

boolean

3.20. URI

Nom Description Schéma

absolute
optionnel

Exemple : true

boolean

authority
optionnel

Exemple : "string"

string

fragment
optionnel

Exemple : "string"

string

host
optionnel

Exemple : "string"

string

opaque
optionnel

Exemple : true

boolean

path
optionnel

Exemple : "string"

string

port
optionnel

Exemple : 0

integer (int32)

query
optionnel

Exemple : "string"

string

rawAuthority
optionnel

Exemple : "string"

string

rawFragment
optionnel

Exemple : "string"

string

rawPath
optionnel

Exemple : "string"

string

rawQuery
optionnel

Exemple : "string"

string

rawSchemeSpecificPart
optionnel

Exemple : "string"

string

rawUserInfo
optionnel

Exemple : "string"

string

scheme
optionnel

Exemple : "string"

string

schemeSpecificPart
optionnel

Exemple : "string"

string

userInfo
optionnel

Exemple : "string"

string

3.21. URL

Nom Description Schéma

authority
optionnel

Exemple : "string"

string

content
optionnel

Exemple : "object"

object

defaultPort
optionnel

Exemple : 0

integer (int32)

file
optionnel

Exemple : "string"

string

host
optionnel

Exemple : "string"

string

path
optionnel

Exemple : "string"

string

port
optionnel

Exemple : 0

integer (int32)

protocol
optionnel

Exemple : "string"

string

query
optionnel

Exemple : "string"

string

ref
optionnel

Exemple : "string"

string

userInfo
optionnel

Exemple : "string"

string

3.22. UserDto

Nom Description Schéma

address
optionnel

Exemple : "AddressDto"

AddressDto

customerId
optionnel

Exemple : "string"

string

email
optionnel

Exemple : "string"

string

firstname
optionnel

Exemple : "string"

string

groupId
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

language
optionnel

Exemple : "string"

string

lastConnection
optionnel

Exemple : "string"

string (date-time)

lastname
optionnel

Exemple : "string"

string

level
optionnel

Exemple : "string"

string

mobile
optionnel

Exemple : "string"

string

nbFailedAttempts
optionnel

Exemple : 0

integer (int32)

otp
optionnel

Exemple : true

boolean

passwordExpirationDate
optionnel

Exemple : "string"

string (date-time)

phone
optionnel

Exemple : "string"

string

readonly
optionnel

Exemple : true

boolean

status
optionnel

Exemple : "string"

enum (ENABLED, DISABLED, BLOCKED, ANONYM)

subrogeable
optionnel

Exemple : true

boolean

type
optionnel

Exemple : "string"

enum (GENERIC, NOMINATIVE)