1. Overview

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

1.2. Contact information

Contact : Emmanuel DEVILLER
Contact Email : emmanuel.deviller@teamvitamui.com

1.3. License information

License : License to be defined …​
License URL : URL not defined.
Terms of service : Terms of service

1.4. URI scheme

Host : localhost
BasePath : /

1.5. Tags

  • certificates : Certificates Management

  • contexts : Contexts Management

2. Resources

2.1. Certificates

Certificates Management

2.1.1. create

POST /security/v1/certificates
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Body

dto
required

dto

CertificateDto

Responses
HTTP Code Description Schema

200

OK

CertificateDto

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.1.2. getAll

GET /security/v1/certificates
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Responses
HTTP Code Description Schema

200

OK

< CertificateDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.3. getOne

GET /security/v1/certificates/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Query

criteria
optional

criteria

string

Responses
HTTP Code Description Schema

200

OK

CertificateDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.4. update

PUT /security/v1/certificates/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Body

dto
required

dto

CertificateDto

Responses
HTTP Code Description Schema

200

OK

CertificateDto

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.1.5. delete

DELETE /security/v1/certificates/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.1.6. checkExist

HEAD /security/v1/certificates/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

2.2. Contexts

Contexts Management

2.2.1. create

POST /security/v1/contexts
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Body

dto
required

dto

ContextDto

Responses
HTTP Code Description Schema

200

OK

ContextDto

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.2.2. getAll

GET /security/v1/contexts
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Responses
HTTP Code Description Schema

200

OK

< ContextDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.3. findByCertificate

POST /security/v1/contexts/certificate
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Body

data
required

data

string

Responses
HTTP Code Description Schema

200

OK

ContextDto

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.2.4. getOne

GET /security/v1/contexts/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Query

criteria
optional

criteria

string

Responses
HTTP Code Description Schema

200

OK

ContextDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.5. update

PUT /security/v1/contexts/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Body

dto
required

dto

ContextDto

Responses
HTTP Code Description Schema

200

OK

ContextDto

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.2.6. delete

DELETE /security/v1/contexts/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.2.7. checkExist

HEAD /security/v1/contexts/{id}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

2.2.8. addTenant

PUT /security/v1/contexts/{id}/tenant/{tenantIdentifier}
Parameters
Type Name Description Schema

Header

X-Tenant-Id
required

Tenant’s Identifier

integer (int32)

Header

X-XSRF-Token
optional

XSRF Token

string

Path

id
required

id

string

Path

tenantIdentifier
required

tenantIdentifier

integer (int32)

Responses
HTTP Code Description Schema

201

Created

ContextDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

3. Definitions

3.1. CertificateDto

Name Schema

contextId
optional

string

data
optional

string

id
optional

string

issuerDN
optional

string

serialNumber
optional

string

subjectDN
optional

string

3.2. ContextDto

Name Schema

fullAccess
optional

boolean

id
optional

string

name
optional

string

roleNames
optional

< string > array

tenants
optional

< integer (int32) > array