1. Vue générale

This API is used to manage certificates for HTTPS access and their associated contexts. This API is used for internal purposes only.

1.2. Information de contact

Contact : Direction de la diffusion et des partenariats
Email de contact : contact@programmevitam.fr

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

  • certificates : Certificates Management

  • contexts : Contexts Management

1.6. Produit

  • application/json

2. Ressources

2.1. Certificates

Certificates Management

2.1.1. create

POST /security/v1/certificates
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

CertificateDto

Réponses
Code HTTP Description Schéma

200

OK

CertificateDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/certificates
Requête body
{
  "contextId" : "string",
  "data" : "string",
  "id" : "string",
  "issuerDN" : "string",
  "serialNumber" : "string",
  "subjectDN" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "contextId" : "string",
  "data" : "string",
  "id" : "string",
  "issuerDN" : "string",
  "serialNumber" : "string",
  "subjectDN" : "string"
}

2.1.2. getAll

GET /security/v1/certificates
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< CertificateDto > array

Exemple de requête HTTP
Requête path
/security/v1/certificates
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "contextId" : "string",
  "data" : "string",
  "id" : "string",
  "issuerDN" : "string",
  "serialNumber" : "string",
  "subjectDN" : "string"
} ]

2.1.3. getOne

GET /security/v1/certificates/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

CertificateDto

Exemple de requête HTTP
Requête path
/security/v1/certificates/string
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "contextId" : "string",
  "data" : "string",
  "id" : "string",
  "issuerDN" : "string",
  "serialNumber" : "string",
  "subjectDN" : "string"
}

2.1.4. update

PUT /security/v1/certificates/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

CertificateDto

Réponses
Code HTTP Description Schéma

200

OK

CertificateDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/certificates/string
Requête body
{
  "contextId" : "string",
  "data" : "string",
  "id" : "string",
  "issuerDN" : "string",
  "serialNumber" : "string",
  "subjectDN" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "contextId" : "string",
  "data" : "string",
  "id" : "string",
  "issuerDN" : "string",
  "serialNumber" : "string",
  "subjectDN" : "string"
}

2.1.5. delete

DELETE /security/v1/certificates/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/security/v1/certificates/string

2.1.6. checkExist

HEAD /security/v1/certificates/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/certificates/string

2.2. Contexts

Contexts Management

2.2.1. create

POST /security/v1/contexts
Paramètres
Type Nom Description Schéma

Body

dto
requis

dto

ContextDto

Réponses
Code HTTP Description Schéma

200

OK

ContextDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/contexts
Requête body
{
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
}
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
}

2.2.2. getAll

GET /security/v1/contexts
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< ContextDto > array

Exemple de requête HTTP
Requête path
/security/v1/contexts
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
} ]

2.2.3. findByCertificate

POST /security/v1/contexts/certificate
Paramètres
Type Nom Description Schéma

Body

data
requis

data

string

Réponses
Code HTTP Description Schéma

200

OK

ContextDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/contexts/certificate
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
}

2.2.4. getOne

GET /security/v1/contexts/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Query

criteria
requis

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

ContextDto

Exemple de requête HTTP
Requête path
/security/v1/contexts/string
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
}

2.2.5. update

PUT /security/v1/contexts/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Body

dto
requis

dto

ContextDto

Réponses
Code HTTP Description Schéma

200

OK

ContextDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/contexts/string
Requête body
{
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
}
Exemple de réponse HTTP
Réponse 200
{
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
}

2.2.6. delete

DELETE /security/v1/contexts/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/security/v1/contexts/string

2.2.7. checkExist

HEAD /security/v1/contexts/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/contexts/string

2.2.8. addTenant

PUT /security/v1/contexts/{id}/tenant/{tenantIdentifier}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Path

tenantIdentifier
requis

tenantIdentifier

integer (int32)

Réponses
Code HTTP Description Schéma

201

Created

ContextDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/security/v1/contexts/string/tenant/0
Exemple de réponse HTTP
Réponse 201
{
  "fullAccess" : true,
  "id" : "string",
  "name" : "string",
  "roleNames" : [ "string" ],
  "tenants" : [ 0 ]
}

3. Définitions

3.1. CertificateDto

Nom Description Schéma

contextId
optionnel

Exemple : "string"

string

data
optionnel

Exemple : "string"

string

id
optionnel

Exemple : "string"

string

issuerDN
optionnel

Exemple : "string"

string

serialNumber
optionnel

Exemple : "string"

string

subjectDN
optionnel

Exemple : "string"

string

3.2. ContextDto

Nom Description Schéma

fullAccess
optionnel

Exemple : true

boolean

id
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

roleNames
optionnel

Exemple : [ "string" ]

< string > array

tenants
optionnel

Exemple : [ 0 ]

< integer (int32) > array