Endpoints

Admin

archiveEntitiesBatch

POST /api/v1/admin/batch-archive

Batch Archive resources from an Entity

Parameters
Body Parameter
Name Description Required Default Pattern

ArchiveAllEntitiesRequestDto

ArchiveAllEntitiesRequestDto

X
Query Parameters
Name Description Required Default Pattern

entity

Dynamically specified Type of Entity

X

null

archive

The requested update for the archived property of the desired resource

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 1. http response codes
Code Message Datatype

204

Archived the requested resources of an Entity

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

archiveSingleEntity

PATCH /api/v1/admin/{id}/archive

Archive a resource from an Entity

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the resource's archived status that will be updated

X

null
Query Parameters
Name Description Required Default Pattern

entity

Dynamically specified Type of Entity

X

null

archive

The requested update for the archived property of the desired resource

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 2. http response codes
Code Message Datatype

204

Archived the requested resource of an Entity

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteArchived

DELETE /api/v1/admin/archived

Delete archived resources from an Entity

Parameters
Query Parameters
Name Description Required Default Pattern

entity

Dynamically specified Type of Entity for which the deletion will be ordered

X

null

until

The date until which all the archived resources of the entity will be deleted

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 3. http response codes
Code Message Datatype

204

Deleted the archived resource of an Entity

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteArchivedEntities

POST /api/v1/admin/batch-delete

Batch Delete archived resources from an Entity

Parameters
Body Parameter
Name Description Required Default Pattern

DeleteArchivedEntitiesRequestDto

DeleteArchivedEntitiesRequestDto

X
Query Parameters
Name Description Required Default Pattern

entity

Dynamically specified Type of Entity for which the deletion will be ordered

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 4. http response codes
Code Message Datatype

204

Deleted the requested resources

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

ApiClient

createNewApiClient

POST /api/v1/api-clients/

Create an Api Client

Parameters
Body Parameter
Name Description Required Default Pattern

CreateNewApiClientRequest

CreateNewApiClientRequest

X
Return Type

CreateNewApiClientResponse

Content Type

  • application/json

Responses
Table 5. http response codes
Code Message Datatype

201

Api Client created

CreateNewApiClientResponse[CreateNewApiClientResponse]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteApiClient

DELETE /api/v1/api-clients/{id}

Delete Api Client

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired resource

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 6. http response codes
Code Message Datatype

204

Api Client Deleted

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getApiClientDetails

GET /api/v1/api-clients/{id}

Get Api Client

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired resource

X

null
Return Type

GetApiClientDetailsResponse

Content Type

  • application/json

Responses
Table 7. http response codes
Code Message Datatype

200

Found Api Client

GetApiClientDetailsResponse[GetApiClientDetailsResponse]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

resetApiClientSecret

POST /api/v1/api-clients/{id}/reset-secret

Reset Api Client’s secret

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired resource

X

null
Return Type

ResetApiClientSecretResponse

Content Type

  • application/json

Responses
Table 8. http response codes
Code Message Datatype

200

Api Client's secret was reset

ResetApiClientSecretResponse[ResetApiClientSecretResponse]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchApiClients

POST /api/v1/api-clients/search

Search Api Clients

Parameters
Body Parameter
Name Description Required Default Pattern

ApiClientSearchRequestDto

ApiClientSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetApiClientResponseDtoPage

Content Type

  • application/json

Responses
Table 9. http response codes
Code Message Datatype

200

Found Api Clients

GetApiClientResponseDtoPage[GetApiClientResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateApiClient

PUT /api/v1/api-clients/{id}

Update an Api Client

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Api Client

X

null
Body Parameter
Name Description Required Default Pattern

UpdateApiClientRequest

UpdateApiClientRequest

X
Return Type

UpdateApiClientResponse

Content Type

  • application/json

Responses
Table 10. http response codes
Code Message Datatype

200

Api Client updated

UpdateApiClientResponse[UpdateApiClientResponse]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

AsyncCertificate

orderCertificate

POST /api/v2/certificates/cert-requests/{id}

Order a Certificate by Certificate Request

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request that will be used to order the Certificate

X

null
Return Type

OrderCertificateResponseDto

Content Type

  • application/json

Responses
Table 11. http response codes
Code Message Datatype

201

Certificate Ordered

OrderCertificateResponseDto[OrderCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

orderMultipleCertificates

POST /api/v2/certificates/cert-requests

Order Multiple Certificates by Certificate Requests

Parameters
Body Parameter
Name Description Required Default Pattern

UUID

[UUID]

X
Query Parameters
Name Description Required Default Pattern

omitArtifacts

Decides whether to omit artifacts of the created certificates or not

-

false
Return Type

OrderMultipleCertificatesResponseDto

Content Type

  • application/json

Responses
Table 12. http response codes
Code Message Datatype

201

Certificates ordered

OrderMultipleCertificatesResponseDto[OrderMultipleCertificatesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

AuthenticatedPrincipal

getAuthenticatedPrincipal

GET /api/v1/authenticated-principal/

Get Authenticated Principal

Parameters
Return Type

AuthenticatedPrincipalResponseDto

Content Type

  • application/json

Responses
Table 13. http response codes
Code Message Datatype

200

Authenticated Principal Found

AuthenticatedPrincipalResponseDto[AuthenticatedPrincipalResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getAuthenticatedPrincipalPermissions

GET /api/v1/authenticated-principal/permissions

Get Authenticated Principal concatenated permissions

Parameters
Return Type

GetAuthenticatedPrincipalPermissionsResponseDto

Content Type

  • application/json

Responses
Table 14. http response codes
Code Message Datatype

200

Authenticated Principal Permissions Found

GetAuthenticatedPrincipalPermissionsResponseDto[GetAuthenticatedPrincipalPermissionsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Ca

downloadCaCertificate

GET /api/v1/cas/{id}/download

Download CA Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the requested CA Certificate

X

null
Return Type

CaCertificateDataPemDto

Content Type

  • application/json

Responses
Table 15. http response codes
Code Message Datatype

200

CA Certificate Downloaded

CaCertificateDataPemDto[CaCertificateDataPemDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCa

GET /api/v1/cas/{id}

Get CA by Id

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the requested Ca

X

null
Return Type

GetCaResponseDto

Content Type

  • application/json

Responses
Table 16. http response codes
Code Message Datatype

200

Found CA

GetCaResponseDto[GetCaResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getTrustedCas

POST /api/v1/cas/get-trusted

Get trusted CAs in PEM format according to the search criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

GetTrustedCasRequestDto

GetTrustedCasRequestDto

X
Return Type

GetTrustedCasResponseDto

Content Type

  • application/json

Responses
Table 17. http response codes
Code Message Datatype

200

Trusted CAs acquired

GetTrustedCasResponseDto[GetTrustedCasResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

importCaCertificates

POST /api/v1/cas/import

Import CA Certificate(s) from pem file content

Parameters
Body Parameter
Name Description Required Default Pattern

ImportCaRequestDto

ImportCaRequestDto

X
Return Type

ImportCaResponseDto

Content Type

  • application/json

Responses
Table 18. http response codes
Code Message Datatype

201

CA Certificate(s) Imported

ImportCaResponseDto[ImportCaResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchCas

POST /api/v1/cas/search

Search CA

Parameters
Body Parameter
Name Description Required Default Pattern

CaSearchRequestDto

CaSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

SearchCaResponseDtoPage

Content Type

  • application/json

Responses
Table 19. http response codes
Code Message Datatype

200

Found CA

SearchCaResponseDtoPage[SearchCaResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateCa

PATCH /api/v1/cas/{id}

Update a CA

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the CA that will be updated

X

null
Body Parameter
Name Description Required Default Pattern

UpdateCaRequestDto

UpdateCaRequestDto

X
Return Type

UpdateCaResponseDto

Content Type

  • application/json

Responses
Table 20. http response codes
Code Message Datatype

200

CA Updated

UpdateCaResponseDto[UpdateCaResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

verifyCaCertificates

POST /api/v1/cas/import/verify

Verify CA Certificate(s) from PEM file content

Parameters
Body Parameter
Name Description Required Default Pattern

ImportCaRequestDto

ImportCaRequestDto

X
Return Type

VerifyImportCaResponseDto

Content Type

  • application/json

Responses
Table 21. http response codes
Code Message Datatype

200

CA Certificate(s) Verified

VerifyImportCaResponseDto[VerifyImportCaResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

CertRequest

approveCertRequest

PATCH /api/v1/cert-requests/{id}/approve

Approve a Certificate Request

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
Return Type

ApproveCertReqResponseDto

Content Type

  • application/json

Responses
Table 22. http response codes
Code Message Datatype

200

Certificate Request Approved

ApproveCertReqResponseDto[ApproveCertReqResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createCertRequest

POST /api/v1/cert-requests/

Create a Certificate Request

Parameters
Body Parameter
Name Description Required Default Pattern

CreateCertReqRequestDto

CreateCertReqRequestDto

X
Return Type

CreateCertReqResponseDto

Content Type

  • application/json

Responses
Table 23. http response codes
Code Message Datatype

201

Certificate Request Created

CreateCertReqResponseDto[CreateCertReqResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createMultipleCertRequest

POST /api/v1/cert-requests/multiple

Create a Certificate Request for multiple End Entities

Parameters
Body Parameter
Name Description Required Default Pattern

CreateMultipleCertReqRequestDto

CreateMultipleCertReqRequestDto

X
Return Type

CreateMultipleCertReqResponseDto

Content Type

  • application/json

Responses
Table 24. http response codes
Code Message Datatype

201

Certificate Request Created

CreateMultipleCertReqResponseDto[CreateMultipleCertReqResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

declineCertRequest

PATCH /api/v1/cert-requests/{id}/decline

Decline a Certificate Request

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
Return Type

DeclineCertReqResponseDto

Content Type

  • application/json

Responses
Table 25. http response codes
Code Message Datatype

200

Certificate Request Declined

DeclineCertReqResponseDto[DeclineCertReqResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

examinePkcs10Request

PUT /api/v1/cert-requests/examine-pkcs10-request

Examine PKCS10 request against End Entity and Policy

Parameters
Body Parameter
Name Description Required Default Pattern

ExaminePkcs10RequestRequestDto

ExaminePkcs10RequestRequestDto

X
Return Type

ExaminePkcs10RequestResponseDto

Content Type

  • application/json

Responses
Table 26. http response codes
Code Message Datatype

200

Examination completed

ExaminePkcs10RequestResponseDto[ExaminePkcs10RequestResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertRequest

GET /api/v1/cert-requests/{id}

Get a Certificate Request

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
Return Type

GetCertReqResponseDto

Content Type

  • application/json

Responses
Table 27. http response codes
Code Message Datatype

200

Certificate Request Found

GetCertReqResponseDto[GetCertReqResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertRequestAdditionalData

PATCH /api/v1/cert-requests/{id}/additional-data

Get Certificate Request additional data

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
Return Type

GetCertRequestAdditionalDataResponseDto

Content Type

  • application/json

Responses
Table 28. http response codes
Code Message Datatype

200

Certificate Request Found

GetCertRequestAdditionalDataResponseDto[GetCertRequestAdditionalDataResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertRequestByPkcs10AndEndEntity

POST /api/v1/cert-requests/end-entities/{id}/by-pkcs10

Get Certificate Request by End Entity and PKCS10

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the End Entity, used to find the desired Certificate Request

X

null
Body Parameter
Name Description Required Default Pattern

CertReqSearchByPkcs10

CertReqSearchByPkcs10

X
Return Type

GetCertReqResponseDto

Content Type

  • application/json

Responses
Table 29. http response codes
Code Message Datatype

200

Certificate Request found

GetCertReqResponseDto[GetCertReqResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getMostRecentPendingCertificates

GET /api/v1/cert-requests/realms/{id}/pending

Get pending Certificate Requests of a specific Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the pending Certificate Requests are requested

X

null
Query Parameters
Name Description Required Default Pattern

size

The limit of the requested pending Certificate Requests

X

null
Return Type

GetPendingCertReqResponseDtoPage

Content Type

  • application/json

Responses
Table 30. http response codes
Code Message Datatype

200

Pending Certificate Requests of Realm Found

GetPendingCertReqResponseDtoPage[GetPendingCertReqResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNameOfRolesWithCertRequestAccess

GET /api/v1/cert-requests/{id}/roles

Get role names of respective certificate request

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Certificate Request that will be used to fetch role names with access to it

X

null
Return Type

GetEntityRoleNamesResponseDto

Content Type

  • application/json

Responses
Table 31. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

importCertificates

POST /api/v1/cert-requests/import-certificates

Import certificates

Parameters
Body Parameter
Name Description Required Default Pattern

ImportCertificatesRequestDto

ImportCertificatesRequestDto

X
Return Type

ImportCertificatesResponseDto

Content Type

  • application/json

Responses
Table 32. http response codes
Code Message Datatype

201

Certificates imported

ImportCertificatesResponseDto[ImportCertificatesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

resendEmailVerificationForCertRequest

POST /api/v1/cert-requests/{id}/resend-verification-email

Resend E-Mail verification for a Certificate Request

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request for which the resend verification E-Mail is requested

X

null
Body Parameter
Name Description Required Default Pattern

EmailDto

EmailDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 33. http response codes
Code Message Datatype

204

E-Mail verification sent

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchAllCertRequests

POST /api/v1/cert-requests/search-all

Search all Certificate Requests

Parameters
Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

SearchAllRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCertReqResponseDtoPage

Content Type

  • application/json

Responses
Table 34. http response codes
Code Message Datatype

200

Certificate Requests Found

GetCertReqResponseDtoPage[GetCertReqResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchCertRequests

POST /api/v1/cert-requests/search

Search Certificate Requests

Parameters
Body Parameter
Name Description Required Default Pattern

CertReqSearchRequestDto

CertReqSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCertReqResponseDtoPage

Content Type

  • application/json

Responses
Table 35. http response codes
Code Message Datatype

200

Certificate Requests Found

GetCertReqResponseDtoPage[GetCertReqResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

verifyImportCertificates

POST /api/v1/cert-requests/import-certificates/verify

Verify import certificates request

Parameters
Body Parameter
Name Description Required Default Pattern

VerifyImportCertificatesRequestDto

VerifyImportCertificatesRequestDto

X
Return Type

VerifyImportCertificatesResponseDto

Content Type

  • application/json

Responses
Table 36. http response codes
Code Message Datatype

200

Import certificates request verified

VerifyImportCertificatesResponseDto[VerifyImportCertificatesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Certificate

createCertificate

POST /api/v1/certificates/cert-requests/{id}

Create Certificate by Certificate Request

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request that will be used to create the Certificate

X

null
Return Type

CreateCertificateResponseDto

Content Type

  • application/json

Responses
Table 37. http response codes
Code Message Datatype

201

Certificate Created

CreateCertificateResponseDto[CreateCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createMultipleCertificates

POST /api/v1/certificates/cert-requests

Create Multiple Certificates by Certificate Requests

Parameters
Body Parameter
Name Description Required Default Pattern

UUID

[UUID]

X
Query Parameters
Name Description Required Default Pattern

omitArtifacts

Decides whether to omit artifacts of the created certificates or not

-

false
Return Type

CreateMultipleCertificateFromCertRequestsResponseDto

Content Type

  • application/json

Responses
Table 38. http response codes
Code Message Datatype

201

Certificates Created

CreateMultipleCertificateFromCertRequestsResponseDto[CreateMultipleCertificateFromCertRequestsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadCaChainForPolicy

GET /api/v1/certificates/policies/{id}/download-ca-chain

Download the CA chain for a specified Policy

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Policy for which the CA chain is requested

X

null
Return Type

CaCertificatePemDto

Content Type

  • application/json

Responses
Table 39. http response codes
Code Message Datatype

200

Policy CA chain downloaded successfully

CaCertificatePemDto[CaCertificatePemDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadCertificate

GET /api/v1/certificates/{id}/download

Download Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Return Type

CertificatePemDto

Content Type

  • application/json

Responses
Table 40. http response codes
Code Message Datatype

200

Certificate Downloaded

CertificatePemDto[CertificatePemDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadCertificateChain

GET /api/v1/certificates/{id}/download-chain

Download Chain of Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Query Parameters
Name Description Required Default Pattern

casFirst

Decides if the chain will start with the EE certificate or not

X

null
Return Type

CertificatePemDto

Content Type

  • application/json

Responses
Table 41. http response codes
Code Message Datatype

200

Certificate Chain Downloaded

CertificatePemDto[CertificatePemDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadCertificatePrivateKey

GET /api/v1/certificates/{id}/download-private-key

Download private key of the Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Return Type

CertificatePrivateKeyPemDto

Content Type

  • application/json

Responses
Table 42. http response codes
Code Message Datatype

200

Certificate private key downloaded

CertificatePrivateKeyPemDto[CertificatePrivateKeyPemDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadCertificatesAsZip

GET /api/v1/certificates/batch-download

Batch Download Certificates

Parameters
Query Parameters
Name Description Required Default Pattern

ids

The list of ids in order to specify the desired Certificates [UUID]

X

null
Return Type

ZippedFileDto

Content Type

  • application/json

Responses
Table 43. http response codes
Code Message Datatype

200

Certificates Downloaded

ZippedFileDto[ZippedFileDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadCrl

GET /api/v1/certificates/{id}/crl

Download crl for a Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Return Type

CrlDto

Content Type

  • application/json

Responses
Table 44. http response codes
Code Message Datatype

200

Certificate's crl downloaded

CrlDto[CrlDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

emailCertificate

POST /api/v1/certificates/{id}/email

Send Certificate E-Mail

Parameters
Path Parameters
Name Description Required Default Pattern

id

ID of the Certificate that will be sent to the Certificate's End Entity E-Mail

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 45. http response codes
Code Message Datatype

204

Certificate E-Mail sent

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getAuditEventsForCertificate

GET /api/v1/certificates/{id}/audit-events

Get Audit Events for a Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Return Type

GetAuditEventResponseDtoList

Content Type

  • application/json

Responses
Table 46. http response codes
Code Message Datatype

200

Certificate's Audit Events Found

GetAuditEventResponseDtoList[GetAuditEventResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateByFingerprint

GET /api/v1/certificates/by-fingerprint

Get Certificate by fingerprint

Parameters
Query Parameters
Name Description Required Default Pattern

fingerprint

The fingerprint used to get the desired Certificate

X

null
Return Type

GetCertificateResponseDto

Content Type

  • application/json

Responses
Table 47. http response codes
Code Message Datatype

200

Found Certificate

GetCertificateResponseDto[GetCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateByIssuerDnBinAndSerialNumber

POST /api/v1/certificates/by-issuer-dn-bin-and-serial-number

Get Certificate by issuer dn bin and serial number

Parameters
Body Parameter
Name Description Required Default Pattern

GetCertByIssuerDnBinAndSnDto

GetCertByIssuerDnBinAndSnDto

X
Return Type

GetCertificateResponseDto

Content Type

  • application/json

Responses
Table 48. http response codes
Code Message Datatype

200

Found Certificate

GetCertificateResponseDto[GetCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateDetails

GET /api/v1/certificates/{id}

Get Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Return Type

GetCertificateResponseDto

Content Type

  • application/json

Responses
Table 49. http response codes
Code Message Datatype

200

Found Certificate

GetCertificateResponseDto[GetCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificatesByRealmId

GET /api/v1/certificates/realms/{id}

Get available Certificates in Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm which will be used to get the Certificates that are a part of it

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCertificateResponseDtoPage

Content Type

  • application/json

Responses
Table 50. http response codes
Code Message Datatype

200

Found Certificates

GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNameOfRolesWithCertificateAccess

GET /api/v1/certificates/{id}/roles

Get role names of respective certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Certificate that will be used to fetch role names with access to it

X

null
Return Type

GetEntityRoleNamesResponseDto

Content Type

  • application/json

Responses
Table 51. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getOcspStatus

GET /api/v1/certificates/{id}/ocsp-status

Get the OCSP status of a Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Return Type

OcspStatusCheckDto

Content Type

  • application/json

Responses
Table 52. http response codes
Code Message Datatype

200

OCSP status of Certificate Found

OcspStatusCheckDto[OcspStatusCheckDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSoonExpiringCertificates

GET /api/v1/certificates/realms/{id}/expiring

Get the Certificates that are expiring soon of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the expiring Certificates were requested

X

null
Query Parameters
Name Description Required Default Pattern

size

The limit of the requested expiring Certificates

X

null
Return Type

GetCertificateResponseDtoPage

Content Type

  • application/json

Responses
Table 53. http response codes
Code Message Datatype

200

Expiring soon Certificates for the Realm Found

GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

markCertificatesAsRevoked

PATCH /api/v1/certificates/mark-as-revoked

Mark Certificates as revoked

Parameters
Body Parameter
Name Description Required Default Pattern

MarkCertificatesAsRevokedRequestDto

MarkCertificatesAsRevokedRequestDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 54. http response codes
Code Message Datatype

204

Certificates Marked As Revoked

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

retrieveCertificateP12

GET /api/v1/certificates/{id}/pkcs12

Retrieve P12 Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
Return Type

KeystoreFileDto

Content Type

  • application/json

Responses
Table 55. http response codes
Code Message Datatype

200

P12 Certificate Retrieved

KeystoreFileDto[KeystoreFileDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

revokeCertificate

POST /api/v1/certificates/revoke

Revoke Certificate

Parameters
Query Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null

revocationReason

The reason of the revoke

-

UNSPECIFIED
Return Type

RevokeCertificateResponseDto

Content Type

  • application/json

Responses
Table 56. http response codes
Code Message Datatype

200

Certificate Revoked

RevokeCertificateResponseDto[RevokeCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

revokeMultipleCertificates

POST /api/v1/certificates/batch-revoke

Batch Revoke Certificates

Parameters
Body Parameter
Name Description Required Default Pattern

RevokeCertificateRequestDto

RevokeCertificateRequestDto

X
Return Type

RevokeMultipleCertificateResponseDto

Content Type

  • application/json

Responses
Table 57. http response codes
Code Message Datatype

200

Certificates Revoked

RevokeMultipleCertificateResponseDto[RevokeMultipleCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchAllCertificates

POST /api/v1/certificates/search-all

Search all Certificates

Parameters
Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

SearchAllRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCertificateResponseDtoPage

Content Type

  • application/json

Responses
Table 58. http response codes
Code Message Datatype

200

Found Certificates

GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchCertificates

POST /api/v1/certificates/search

Search Certificates

Parameters
Body Parameter
Name Description Required Default Pattern

CertificateSearchRequestDto

CertificateSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCertificateResponseDtoPage

Content Type

  • application/json

Responses
Table 59. http response codes
Code Message Datatype

200

Found Certificates

GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

validateCertificate

POST /api/v1/certificates/validate

Validates a PEM certificate returning true/false and CA chain, if the certificate can be validated by the known CAs in the system

Parameters
Body Parameter
Name Description Required Default Pattern

RawPemCertificateDto

RawPemCertificateDto

X
Return Type

CertificateValidationResponseDto

Content Type

  • application/json

Responses
Table 60. http response codes
Code Message Datatype

200

Certificate is validated

CertificateValidationResponseDto[CertificateValidationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

validateCertificatePlain

POST /api/v1/certificates/validate-plain

Validates a PEM certificate returning true/false, if the certificate can be validated by the known CAs in the system

Parameters
Body Parameter
Name Description Required Default Pattern

RawPemCertificateDto

RawPemCertificateDto

X
Return Type

CertificatePlainValidationResponseDto

Content Type

  • application/json

Responses
Table 61. http response codes
Code Message Datatype

200

Certificate is validated

CertificatePlainValidationResponseDto[CertificatePlainValidationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

CertificateProvider

checkCertificateProviderConnection

POST /api/v1/certificate-providers/{id}/check-connection

Check connected of the Certificate Provider

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of Certificate Provider that will be checked for connection

X

null
Return Type

CheckCertificateProviderConnectionDto

Content Type

  • application/json

Responses
Table 62. http response codes
Code Message Datatype

200

Certificate Provider connected Checked

CheckCertificateProviderConnectionDto[CheckCertificateProviderConnectionDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createCertificateProvider

POST /api/v1/certificate-providers/

Create a Certificate Provider

Parameters
Body Parameter
Name Description Required Default Pattern

CreateCertificateProviderRequestDto

CreateCertificateProviderRequestDto

X
Return Type

CreateCertificateProviderResponseDto

Content Type

  • application/json

Responses
Table 63. http response codes
Code Message Datatype

201

Created Certificate Provider

CreateCertificateProviderResponseDto[CreateCertificateProviderResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateProvider

GET /api/v1/certificate-providers/{id}

Get Certificate Provider by Id

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the requested Certificate Provider

X

null
Return Type

GetCertificateProviderResponseDto

Content Type

  • application/json

Responses
Table 64. http response codes
Code Message Datatype

200

Found Certificate Provider

GetCertificateProviderResponseDto[GetCertificateProviderResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchCertificateProviders

POST /api/v1/certificate-providers/search

Find the Certificate Providers

Parameters
Body Parameter
Name Description Required Default Pattern

CertificateProviderSearchRequestDto

CertificateProviderSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCertificateProviderResponseDtoPage

Content Type

  • application/json

Responses
Table 65. http response codes
Code Message Datatype

200

Certificate Providers Found

GetCertificateProviderResponseDtoPage[GetCertificateProviderResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchCertificateProvidersForPolicyCreateUpdate

POST /api/v1/certificate-providers/minimal/search

Find the Certificate Providers (non admin)

Parameters
Body Parameter
Name Description Required Default Pattern

CertificateProviderSearchRequestDto

CertificateProviderSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCertificateProviderMinimalResponseDtoPage

Content Type

  • application/json

Responses
Table 66. http response codes
Code Message Datatype

200

Certificate Providers Found

GetCertificateProviderMinimalResponseDtoPage[GetCertificateProviderMinimalResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateCertificateProvider

PATCH /api/v1/certificate-providers/{id}

Update a Certificate Provider

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of Certificate Provider that will be updated

X

null
Body Parameter
Name Description Required Default Pattern

UpdateCertificateProviderRequestDto

UpdateCertificateProviderRequestDto

X
Return Type

UpdateCertificateProviderResponseDto

Content Type

  • application/json

Responses
Table 67. http response codes
Code Message Datatype

200

Certificate Provider Updated

UpdateCertificateProviderResponseDto[UpdateCertificateProviderResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

CertificateProviderOptions

getAllTemplateSignersByCertificateProviderId

GET /api/v1/certificate-providers-options/{id}/all-cara-template-signers

Returns all Template Signers of the Certificate Provider with this ID and the RA Template Signers

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Certificate Provider for which the Template Signers are requested

X

null
Return Type

CaraTemplateSignerDtoList

Content Type

  • application/json

Responses
Table 68. http response codes
Code Message Datatype

200

Template Signers Found

CaraTemplateSignerDtoList[CaraTemplateSignerDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getMscaTemplatesByCertificateProviderId

GET /api/v1/certificate-providers-options/{id}/msca-templates

Returns the MS CA Templates of the Certificate Provider with this ID

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Certificate Provider for which the MS CA Templates are requested

X

null
Return Type

MscaTemplatesResponseDto

Content Type

  • application/json

Responses
Table 69. http response codes
Code Message Datatype

200

MS CA Templates Found

MscaTemplatesResponseDto[MscaTemplatesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getPublicCasProducts

GET /api/v1/certificate-providers-options/{id}/public-cas-products

Returns the Public CAs products of the Certificate Provider with this ID

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Certificate Provider for which the products are requested

X

null
Return Type

PublicCAsProductsResponseDto

Content Type

  • application/json

Responses
Table 70. http response codes
Code Message Datatype

200

Public CAs Products Found

PublicCAsProductsResponseDto[PublicCAsProductsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getTemplateSignersByCertificateProviderId

GET /api/v1/certificate-providers-options/{id}/cara-template-signers

Returns the Template Signers of the Certificate Provider with this ID

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Certificate Provider for which the Template Signers are requested

X

null
Return Type

CaraTemplateSignerDtoList

Content Type

  • application/json

Responses
Table 71. http response codes
Code Message Datatype

200

Template Signers Found

CaraTemplateSignerDtoList[CaraTemplateSignerDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Cmp

calculateMac

POST /api/v1/cmp/calculate-mac

Perform a MAC calculation with an End Entity password and a policy

Parameters
Body Parameter
Name Description Required Default Pattern

CmpCalculateMacRequestDto

CmpCalculateMacRequestDto

X
Return Type

CmpCalculateMacResponseDto

Content Type

  • application/json

Responses
Table 72. http response codes
Code Message Datatype

200

Mac calculation operation was completed without errors. See response for verification result.

CmpCalculateMacResponseDto[CmpCalculateMacResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCmpConfigurationByPolicyId

GET /api/v1/cmp/policies/{policyId}/configuration

Find a CMP configuration by a policy ID

Parameters
Path Parameters
Name Description Required Default Pattern

policyId

Id of Policy associated with CMP configuration

X

null
Return Type

GetCmpConfigurationResponseDto

Content Type

  • application/json

Responses
Table 73. http response codes
Code Message Datatype

200

CMP configuration Found

GetCmpConfigurationResponseDto[GetCmpConfigurationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

signData

POST /api/v1/cmp/sign

Signs the data with CMP signer for the policy provided in the parameters

Parameters
Body Parameter
Name Description Required Default Pattern

CmpSignRequestDto

CmpSignRequestDto

X
Return Type

SignDataResponseDto

Content Type

  • application/json

Responses
Table 74. http response codes
Code Message Datatype

200

Data signed

SignDataResponseDto[SignDataResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

verifyMacEndEntityCommonName

POST /api/v1/cmp/verify-mac/cn

Verifies a MAC using an end-entity password and policy by searching for the end-entity using its common name.

Parameters
Body Parameter
Name Description Required Default Pattern

CmpVerifyMacEndEntityCommonNameRequestDto

CmpVerifyMacEndEntityCommonNameRequestDto

X
Return Type

CmpVerifyMacResponseDto

Content Type

  • application/json

Responses
Table 75. http response codes
Code Message Datatype

200

Mac verify operation was completed without errors. See response for verification result.

CmpVerifyMacResponseDto[CmpVerifyMacResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

verifyMacEndEntityId

POST /api/v1/cmp/verify-mac/id

Verifies a MAC using an end-entity password and a policy by searching for the end-entity using its ID.

Parameters
Body Parameter
Name Description Required Default Pattern

CmpVerifyMacEndEntityIdRequestDto

CmpVerifyMacEndEntityIdRequestDto

X
Return Type

CmpVerifyMacResponseDto

Content Type

  • application/json

Responses
Table 76. http response codes
Code Message Datatype

200

Mac verify operation was completed without errors. See response for verification result.

CmpVerifyMacResponseDto[CmpVerifyMacResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Configuration

checkEmailConnection

POST /api/v1/configuration/check-email-connection

Check the connection of the configuration E-Mail

Parameters
Return Type

-

Content Type

  • application/json

Responses
Table 77. http response codes
Code Message Datatype

204

The Configuration E-Mail connection was checked successfully

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createConfiguration

POST /api/v1/configuration/

Create new Configuration

Parameters
Body Parameter
Name Description Required Default Pattern

CreateConfigurationRequestDto

CreateConfigurationRequestDto

X
Return Type

CreateConfigurationResponseDto

Content Type

  • application/json

Responses
Table 78. http response codes
Code Message Datatype

201

Configuration Created

CreateConfigurationResponseDto[CreateConfigurationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteConfiguration

DELETE /api/v1/configuration/{settingsKey}

Delete Configuration

Parameters
Path Parameters
Name Description Required Default Pattern

settingsKey

The setting key for which the Configuration object should be deleted

X

null
Query Parameters
Name Description Required Default Pattern

version

The version of the resource that will be deleted

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 79. http response codes
Code Message Datatype

204

Configuration Deleted

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getConfiguration

GET /api/v1/configuration/{settingsKey}

Retrieve Configuration by Setting key

Parameters
Path Parameters
Name Description Required Default Pattern

settingsKey

The setting key for which the Configuration object should be retrieved

X

null
Return Type

GetConfigurationResponseDto

Content Type

  • application/json

Responses
Table 80. http response codes
Code Message Datatype

200

Configuration Found

GetConfigurationResponseDto[GetConfigurationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNotificationConfigurations

GET /api/v1/configuration/notifications

Get notifications related Configurations

Parameters
Return Type

GetNotificationConfigurationsDto

Content Type

  • application/json

Responses
Table 81. http response codes
Code Message Datatype

200

Found Configurations

GetNotificationConfigurationsDto[GetNotificationConfigurationsDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchConfiguration

POST /api/v1/configuration/search

Search Configuration

Parameters
Body Parameter
Name Description Required Default Pattern

SearchConfigurationRequestDto

SearchConfigurationRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetConfigurationResponseDtoPage

Content Type

  • application/json

Responses
Table 82. http response codes
Code Message Datatype

200

Found Configuration

GetConfigurationResponseDtoPage[GetConfigurationResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateConfiguration

PATCH /api/v1/configuration/

Update Configuration

Parameters
Body Parameter
Name Description Required Default Pattern

UpdateConfigurationRequestDto

UpdateConfigurationRequestDto

X
Return Type

UpdateConfigurationResponseDto

Content Type

  • application/json

Responses
Table 83. http response codes
Code Message Datatype

200

Configuration Updated

UpdateConfigurationResponseDto[UpdateConfigurationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateConfigurationBatch

PATCH /api/v1/configuration/batch

Update Configuration values in batch mode

Parameters
Body Parameter
Name Description Required Default Pattern

UpdateConfigurationBatchRequestDto

UpdateConfigurationBatchRequestDto

X
Return Type

UpdateConfigurationBatchResponseDto

Content Type

  • application/json

Responses
Table 84. http response codes
Code Message Datatype

200

Configuration values Updated

UpdateConfigurationBatchResponseDto[UpdateConfigurationBatchResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Contact

createContact

POST /api/v1/contacts/

Create Contact

Parameters
Body Parameter
Name Description Required Default Pattern

CreateContactRequestDto

CreateContactRequestDto

X
Return Type

CreateResourceResponseDto

Content Type

  • application/json

Responses
Table 85. http response codes
Code Message Datatype

201

Created Contact

CreateResourceResponseDto[CreateResourceResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteContact

DELETE /api/v1/contacts/{contactId}

Delete Contact

Parameters
Path Parameters
Name Description Required Default Pattern

contactId

The id of the desired Contact

X

null
Query Parameters
Name Description Required Default Pattern

version

The version of the Contact that will be deleted

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 86. http response codes
Code Message Datatype

204

Contact Deleted

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteContacts

POST /api/v1/contacts/batch-delete

Delete Contacts

Parameters
Body Parameter
Name Description Required Default Pattern

BatchDeleteContactsRequestDto

BatchDeleteContactsRequestDto

X
Return Type

BatchDeleteContactsResponseDto

Content Type

  • application/json

Responses
Table 87. http response codes
Code Message Datatype

200

Contact(s) Deleted

BatchDeleteContactsResponseDto[BatchDeleteContactsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getContact

GET /api/v1/contacts/{contactId}

Get Contact

Parameters
Path Parameters
Name Description Required Default Pattern

contactId

The id of the requested Contact

X

null
Return Type

GetContactResponseDto

Content Type

  • application/json

Responses
Table 88. http response codes
Code Message Datatype

200

Found Contact

GetContactResponseDto[GetContactResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSubscriptionsOfContact

GET /api/v1/contacts/{contactId}/subscriptions

Get Contact Subscriptions

Parameters
Path Parameters
Name Description Required Default Pattern

contactId

The id of the requested Contact

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetSubscriptionResponseDtoPage

Content Type

  • application/json

Responses
Table 89. http response codes
Code Message Datatype

200

Found Contact Subscriptions

GetSubscriptionResponseDtoPage[GetSubscriptionResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchContacts

PUT /api/v1/contacts/search

Search Contacts

Parameters
Body Parameter
Name Description Required Default Pattern

ContactSearchRequestDto

ContactSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetContactResponseDtoPage

Content Type

  • application/json

Responses
Table 90. http response codes
Code Message Datatype

200

Found Contacts

GetContactResponseDtoPage[GetContactResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateContact

PUT /api/v1/contacts/{contactId}

Update Contact

Parameters
Path Parameters
Name Description Required Default Pattern

contactId

The id of the desired Contact

X

null
Body Parameter
Name Description Required Default Pattern

UpdateContactRequestDto

UpdateContactRequestDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 91. http response codes
Code Message Datatype

204

Contact Updated

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

CryptoModules

createCryptoModule

POST /api/v1/crypto-modules/

Create a Crypto Module

Parameters
Body Parameter
Name Description Required Default Pattern

CreateCryptoModuleRequestDto

CreateCryptoModuleRequestDto

X
Return Type

CreateCryptoModuleResponseDto

Content Type

  • application/json

Responses
Table 92. http response codes
Code Message Datatype

201

Created Crypto Module

CreateCryptoModuleResponseDto[CreateCryptoModuleResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCryptoModule

GET /api/v1/crypto-modules/{id}

Get Crypto Module by ID

Parameters
Path Parameters
Name Description Required Default Pattern

id

The ID of the requested Crypto Module

X

null
Return Type

GetCryptoModuleResponseDto

Content Type

  • application/json

Responses
Table 93. http response codes
Code Message Datatype

200

Crypto Module found

GetCryptoModuleResponseDto[GetCryptoModuleResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

performHealthCheck

PATCH /api/v1/crypto-modules/{id}/health-check

Perform health check for Crypto Module

Parameters
Path Parameters
Name Description Required Default Pattern

id

The ID of the Crypto Module the health check is requested for

X

null
Return Type

GetCryptoModuleHealthCheckResponseDto

Content Type

  • application/json

Responses
Table 94. http response codes
Code Message Datatype

200

Health check for crypto module performed

GetCryptoModuleHealthCheckResponseDto[GetCryptoModuleHealthCheckResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchCryptoModules

POST /api/v1/crypto-modules/search

Search the Crypto Modules

Parameters
Body Parameter
Name Description Required Default Pattern

CryptoModuleSearchRequestDto

CryptoModuleSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetCryptoModuleResponseDtoPage

Content Type

  • application/json

Responses
Table 95. http response codes
Code Message Datatype

200

Crypto Modules found

GetCryptoModuleResponseDtoPage[GetCryptoModuleResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

CtScan

scanCertificates

POST /api/v1/ct-scan

Search Certificates in Sectigo

Parameters
Body Parameter
Name Description Required Default Pattern

CTScanRequestDto

CTScanRequestDto

X
Return Type

CTScanResponseDto

Content Type

  • application/json

Responses
Table 96. http response codes
Code Message Datatype

200

Certificates Found

CTScanResponseDto[CTScanResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

EndEntity

createNewEndEntity

POST /api/v1/end-entities/

Create an End Entity

Parameters
Body Parameter
Name Description Required Default Pattern

CreateEndEntityRequestDto

CreateEndEntityRequestDto

X
Return Type

CreateEndEntityResponseDto

Content Type

  • application/json

Responses
Table 97. http response codes
Code Message Datatype

201

Created End Entity

CreateEndEntityResponseDto[CreateEndEntityResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

findEeByCertBytes

POST /api/v1/end-entities/find-by-cert-bytes

Get End Entity by certificate bytes

Parameters
Body Parameter
Name Description Required Default Pattern

FindEeByCertBytesRequestDto

FindEeByCertBytesRequestDto

X
Return Type

GetEndEntityResponseDto

Content Type

  • application/json

Responses
Table 98. http response codes
Code Message Datatype

200

Found End Entity

GetEndEntityResponseDto[GetEndEntityResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

findEndEntityByPolicyIdAndEndEntityDataset

POST /api/v1/end-entities/policies/{id}/by-end-entity-dataset

Find End Entity by Policy and End Entity dataset

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id passed in the url is the id of the Policy that will be used for the search of the End Entity

X

null
Body Parameter
Name Description Required Default Pattern

EndEntityDatasetRequestDto

EndEntityDatasetRequestDto

X
Return Type

GetEndEntityResponseDto

Content Type

  • application/json

Responses
Table 99. http response codes
Code Message Datatype

200

End Entity found by Policy and dataset

GetEndEntityResponseDto[GetEndEntityResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEndEntity

GET /api/v1/end-entities/{id}

Get End Entity by Id

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of End Entity to be searched

X

null
Return Type

GetEndEntityResponseDto

Content Type

  • application/json

Responses
Table 100. http response codes
Code Message Datatype

200

Found End Entity

GetEndEntityResponseDto[GetEndEntityResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEndEntityByRealmIdAndExternalId

GET /api/v1/end-entities/realms/{realmId}/externals/{externalId}

Get End Entity by Realm and External Id

Parameters
Path Parameters
Name Description Required Default Pattern

realmId

Id of Realm to be searched

X

null

externalId

Id of External to be searched

X

null
Return Type

GetEndEntityResponseDto

Content Type

  • application/json

Responses
Table 101. http response codes
Code Message Datatype

200

Found End Entity

GetEndEntityResponseDto[GetEndEntityResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNameOfRolesWithEndEntityAccess

GET /api/v1/end-entities/{id}/roles

Get role names of respective end entity

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the End Entity that will be used to fetch role names with access to it

X

null
Return Type

GetEntityRoleNamesResponseDto

Content Type

  • application/json

Responses
Table 102. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchAllEndEntities

POST /api/v1/end-entities/search-all

Search all End Entities

Parameters
Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

SearchAllRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetEndEntityResponseDtoPage

Content Type

  • application/json

Responses
Table 103. http response codes
Code Message Datatype

200

Found End Entities

GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchEndEntities

POST /api/v1/end-entities/search

Search End Entities

Parameters
Body Parameter
Name Description Required Default Pattern

EndEntitySearchRequestDto

EndEntitySearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetEndEntityResponseDtoPage

Content Type

  • application/json

Responses
Table 104. http response codes
Code Message Datatype

200

Found End Entities

GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

uploadEndEntitiesCsv

POST /api/v1/end-entities/upload-csv

Add multiple End Entities from csv file

Parameters
Body Parameter
Name Description Required Default Pattern

EndEntitiesCsvDto

EndEntitiesCsvDto

X
Return Type

EndEntityMassImportResponseDto

Content Type

  • application/json

Responses
Table 105. http response codes
Code Message Datatype

201

The End Entities were saved successfully

EndEntityMassImportResponseDto[EndEntityMassImportResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

EndEntityPassword

authorizeWithEEidAndPassword

POST /api/v1/end-entity-passwords/authenticate

Authenticate with End Entity and Password

Parameters
Body Parameter
Name Description Required Default Pattern

EndEntityAuthenticationRequestDto

EndEntityAuthenticationRequestDto

X
Return Type

EndEntityAuthenticationResponseDto

Content Type

  • application/json

Responses
Table 106. http response codes
Code Message Datatype

200

Authenticated successfully

EndEntityAuthenticationResponseDto[EndEntityAuthenticationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createNewEndEntityPassword

POST /api/v1/end-entity-passwords/

Create Password for End Entity

Parameters
Body Parameter
Name Description Required Default Pattern

CreateEndEntityPasswordRequestDto

CreateEndEntityPasswordRequestDto

X
Return Type

CreateEndEntityPasswordResponseDto

Content Type

  • application/json

Responses
Table 107. http response codes
Code Message Datatype

201

Password for End Entity created

CreateEndEntityPasswordResponseDto[CreateEndEntityPasswordResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteEndEntityPassword

DELETE /api/v1/end-entity-passwords/

Delete Password of End Entity

Parameters
Body Parameter
Name Description Required Default Pattern

EndEntityPasswordRequestDto

EndEntityPasswordRequestDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 108. http response codes
Code Message Datatype

204

Password for End Entity Deleted

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEndEntityPasswordByEndEntityIdAndPolicyId

GET /api/v1/end-entity-passwords/end-entities/{endEntityId}/policies/{policyId}

Get End Entity Password by End Entity Id and Policy Id

Parameters
Path Parameters
Name Description Required Default Pattern

endEntityId

Id of End Entity to be searched

X

null

policyId

Id of Policy to be searched

X

null
Return Type

GetEndEntityPasswordResponseDto

Content Type

  • application/json

Responses
Table 109. http response codes
Code Message Datatype

200

Found End Entity Password

GetEndEntityPasswordResponseDto[GetEndEntityPasswordResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEndEntityPasswordsByEndEntityId

GET /api/v1/end-entity-passwords/end-entities/{id}/

Find the End Entity Passwords connected with the specific End Entity

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the End Entity for which the search is requested

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetEndEntityPasswordResponseDtoPage

Content Type

  • application/json

Responses
Table 110. http response codes
Code Message Datatype

200

End Entity Passwords Found

GetEndEntityPasswordResponseDtoPage[GetEndEntityPasswordResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

resetEndEntityPassword

POST /api/v1/end-entity-passwords/reset

Reset Password of End Entity

Parameters
Body Parameter
Name Description Required Default Pattern

EndEntityPasswordRequestDto

EndEntityPasswordRequestDto

X
Return Type

ResetEndEntityPasswordResponseDto

Content Type

  • application/json

Responses
Table 111. http response codes
Code Message Datatype

200

Password for End Entity was reset

ResetEndEntityPasswordResponseDto[ResetEndEntityPasswordResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Enum

getApiErrorValues

GET /api/v1/public/enum/api-error-values

Get Api Error values

Parameters
Return Type

GetApiErrorValuesResponseDtoList

Content Type

  • application/json

Responses
Table 112. http response codes
Code Message Datatype

200

Api Error values found

GetApiErrorValuesResponseDtoList[GetApiErrorValuesResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertRequestPermissionsValues

GET /api/v1/public/enum/cert-request-permissions

Get Certificate Request Permissions values

Parameters
Return Type

GetCertRequestPermissionResponseDtoList

Content Type

  • application/json

Responses
Table 113. http response codes
Code Message Datatype

200

Certificate Request Permissions values found

GetCertRequestPermissionResponseDtoList[GetCertRequestPermissionResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertStatusValues

GET /api/v1/public/enum/cert-status-values

Get Certificate Status values

Parameters
Return Type

GetCertStatusResponseDtoList

Content Type

  • application/json

Responses
Table 114. http response codes
Code Message Datatype

200

Certificate Status values found

GetCertStatusResponseDtoList[GetCertStatusResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificatePermissionsValues

GET /api/v1/public/enum/certificate-permissions

Get Certificate Permissions values

Parameters
Return Type

GetCertificatePermissionResponseDtoList

Content Type

  • application/json

Responses
Table 115. http response codes
Code Message Datatype

200

Certificate Permissions values found

GetCertificatePermissionResponseDtoList[GetCertificatePermissionResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateProviderTypeResponseDtoList

GET /api/v1/public/enum/certificate-provider-type-values

Get Certificate Provider type values

Parameters
Return Type

GetCertificateProviderTypeResponseDtoList

Content Type

  • application/json

Responses
Table 116. http response codes
Code Message Datatype

200

Certificate Provider type values found

GetCertificateProviderTypeResponseDtoList[GetCertificateProviderTypeResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateSearchKeyValues

GET /api/v1/public/enum/cert-search-key-values

Get Certificate Search Key values

Parameters
Return Type

GetCertificateSearchKeyResponseDtoList

Content Type

  • application/json

Responses
Table 117. http response codes
Code Message Datatype

200

Certificate Search Key values found

GetCertificateSearchKeyResponseDtoList[GetCertificateSearchKeyResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getChannelTypes

GET /api/v1/public/enum/channel-type-values

Get notification channel type values

Parameters
Return Type

GetChannelTypeListResponseDto

Content Type

  • application/json

Responses
Table 118. http response codes
Code Message Datatype

200

Notification channel type values found

GetChannelTypeListResponseDto[GetChannelTypeListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCmpSignatureAlgorithmValues

GET /api/v1/public/enum/cmp-signature-algorithm-values

Get CMP Signature Algorithm values

Parameters
Return Type

GetCmpSignatureAlgorithmResponseDtoList

Content Type

  • application/json

Responses
Table 119. http response codes
Code Message Datatype

200

CMP Signature Algorithm values found

GetCmpSignatureAlgorithmResponseDtoList[GetCmpSignatureAlgorithmResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCryptoAlgorithmValues

GET /api/v1/public/enum/crypto-algorithm-values

Get Crypto Algorithm values

Parameters
Return Type

GetCryptoAlgorithmResponseDtoList

Content Type

  • application/json

Responses
Table 120. http response codes
Code Message Datatype

200

Crypto Algorithm values found

GetCryptoAlgorithmResponseDtoList[GetCryptoAlgorithmResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCryptoModuleTypes

GET /api/v1/public/enum/crypto-module-type-values

Get Crypto Module type values

Parameters
Return Type

GetCryptoModuleTypeListResponseDto

Content Type

  • application/json

Responses
Table 121. http response codes
Code Message Datatype

200

Crypto Module type values found

GetCryptoModuleTypeListResponseDto[GetCryptoModuleTypeListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEcNamedCurvesValues

GET /api/v1/public/enum/ec-named-curves-values

Get EC Named Curves values

Parameters
Return Type

GetECNamedCurveResponseDtoList

Content Type

  • application/json

Responses
Table 122. http response codes
Code Message Datatype

200

EC Named Curves values found

GetECNamedCurveResponseDtoList[GetECNamedCurveResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEdDSANamedCurvesValues

GET /api/v1/public/enum/eddsa-named-curves-values

Get EdDSA Named Curves values

Parameters
Return Type

GetEdDSANamedCurveResponseDtoList

Content Type

  • application/json

Responses
Table 123. http response codes
Code Message Datatype

200

EdDSA Named Curves values found

GetEdDSANamedCurveResponseDtoList[GetEdDSANamedCurveResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEndEntityPermissionsValues

GET /api/v1/public/enum/end-entity-permissions

Get End Entity Permissions values

Parameters
Return Type

GetEndEntityPermissionResponseDtoList

Content Type

  • application/json

Responses
Table 124. http response codes
Code Message Datatype

200

End Entity Permissions values found

GetEndEntityPermissionResponseDtoList[GetEndEntityPermissionResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEndEntityPropertiesValues

GET /api/v1/public/enum/end-entity-properties

Get End Entity Properties values

Parameters
Return Type

GetEndEntityPropertyResponseDtoList

Content Type

  • application/json

Responses
Table 125. http response codes
Code Message Datatype

200

End Entity Properties values found

GetEndEntityPropertyResponseDtoList[GetEndEntityPropertyResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEntitiesEnumValues

GET /api/v1/public/enum/entities-enum-values

Get End Entity Enum values

Parameters
Return Type

GetEntitiesEnumResponseDtoList

Content Type

  • application/json

Responses
Table 126. http response codes
Code Message Datatype

200

End Entity Enum values found

GetEntitiesEnumResponseDtoList[GetEntitiesEnumResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEntityStrategyEnumValues

GET /api/v1/public/enum/entity-strategy-enum-values

Get Entity Strategy Enum values

Parameters
Return Type

GetEndEntityStrategyResponseDtoList

Content Type

  • application/json

Responses
Table 127. http response codes
Code Message Datatype

200

Entity Strategy Enum values found

GetEndEntityStrategyResponseDtoList[GetEndEntityStrategyResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getEventTypes

GET /api/v1/public/enum/event-type-values

Get notification event type values

Parameters
Return Type

GetEventTypeListResponseDto

Content Type

  • application/json

Responses
Table 128. http response codes
Code Message Datatype

200

Notification event type values found

GetEventTypeListResponseDto[GetEventTypeListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getGlobalPermissionsValues

GET /api/v1/public/enum/global-permissions

Get Global Permissions values

Parameters
Return Type

GetGlobalPermissionResponseDtoList

Content Type

  • application/json

Responses
Table 129. http response codes
Code Message Datatype

200

Global Permissions values found

GetGlobalPermissionResponseDtoList[GetGlobalPermissionResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getKeyPairModeValues

GET /api/v1/public/enum/key-pair-mode-values

Get Key Pair Mode values

Parameters
Return Type

GetKeyPairModeResponseDtoList

Content Type

  • application/json

Responses
Table 130. http response codes
Code Message Datatype

200

Key Pair Mode values found

GetKeyPairModeResponseDtoList[GetKeyPairModeResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getLanguages

GET /api/v1/public/enum/language-values

Get notification language values

Parameters
Return Type

GetLanguageListResponseDto

Content Type

  • application/json

Responses
Table 131. http response codes
Code Message Datatype

200

Notification language values found

GetLanguageListResponseDto[GetLanguageListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNotificationRecipientTypes

GET /api/v1/public/enum/notification-recipient-type-values

Get notification recipient type values

Parameters
Return Type

GetRecipientTypeListResponseDto

Content Type

  • application/json

Responses
Table 132. http response codes
Code Message Datatype

200

Notification recipient type values found

GetRecipientTypeListResponseDto[GetRecipientTypeListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNotificationStatuses

GET /api/v1/public/enum/notification-status-values

Get notification status values

Parameters
Return Type

GetNotificationStatusListResponseDto

Content Type

  • application/json

Responses
Table 133. http response codes
Code Message Datatype

200

Notification status values found

GetNotificationStatusListResponseDto[GetNotificationStatusListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getPolicyPermissionsValues

GET /api/v1/public/enum/policy-permissions

Get Policy Permissions values

Parameters
Return Type

GetPolicyPermissionResponseDtoList

Content Type

  • application/json

Responses
Table 134. http response codes
Code Message Datatype

200

Policy Permissions values found

GetPolicyPermissionResponseDtoList[GetPolicyPermissionResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getRealmPermissionsValues

GET /api/v1/public/enum/realm-permissions

Get Realm Permissions values

Parameters
Return Type

GetRealmPermissionResponseDtoList

Content Type

  • application/json

Responses
Table 135. http response codes
Code Message Datatype

200

Realm Permissions values found

GetRealmPermissionResponseDtoList[GetRealmPermissionResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getRevocationReasonValues

GET /api/v1/public/enum/revocation-reason-values

Get Revocation Reason values

Parameters
Return Type

GetRevocationReasonResponseDtoList

Content Type

  • application/json

Responses
Table 136. http response codes
Code Message Datatype

200

Revocation Reason values found

GetRevocationReasonResponseDtoList[GetRevocationReasonResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getRsaKeySizeValues

GET /api/v1/public/enum/rsa-key-size-values

Get RSA Key Size values

Parameters
Return Type

GetRSAKeySizeResponseDtoList

Content Type

  • application/json

Responses
Table 137. http response codes
Code Message Datatype

200

RSA Key Size values found

GetRSAKeySizeResponseDtoList[GetRSAKeySizeResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSearchTemplateLanguages

GET /api/v1/public/enum/template-language-values

Get search template language values

Parameters
Return Type

GetSearchTemplateLanguageListResponseDto

Content Type

  • application/json

Responses
Table 138. http response codes
Code Message Datatype

200

Template language values found

GetSearchTemplateLanguageListResponseDto[GetSearchTemplateLanguageListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSubscriptionTargetTypes

GET /api/v1/public/enum/subscription-target-type-values

Get subscription target type values

Parameters
Return Type

GetSubscriptionTargetTypeListResponseDto

Content Type

  • application/json

Responses
Table 139. http response codes
Code Message Datatype

200

Subscription target type values found

GetSubscriptionTargetTypeListResponseDto[GetSubscriptionTargetTypeListResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getValidForValues

GET /api/v1/public/enum/valid-for-values

Get Valid For values

Parameters
Return Type

GetValidForResponseDtoList

Content Type

  • application/json

Responses
Table 140. http response codes
Code Message Datatype

200

Valid For values found

GetValidForResponseDtoList[GetValidForResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

License

getLicenseInfo

GET /api/v1/license/info

Get CLM license information

Parameters
Return Type

GetClmLicenseInfoResponseDto

Content Type

  • application/json

Responses
Table 141. http response codes
Code Message Datatype

200

CLM license information

GetClmLicenseInfoResponseDto[GetClmLicenseInfoResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Notification

cancelNotification

DELETE /api/v1/notifications/{notificationId}

Cancel Notification

Parameters
Path Parameters
Name Description Required Default Pattern

notificationId

The id of the Notification to cancel

X

null
Query Parameters
Name Description Required Default Pattern

version

The version of the Notification

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 142. http response codes
Code Message Datatype

200

Notification canceled successfully

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

204

No Content

<<>>

getNotification

GET /api/v1/notifications/{notificationId}

Get Notification

Parameters
Path Parameters
Name Description Required Default Pattern

notificationId

The id of the requested Notification

X

null
Return Type

GetNotificationResponseDto

Content Type

  • application/json

Responses
Table 143. http response codes
Code Message Datatype

200

Found Notification

GetNotificationResponseDto[GetNotificationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

retryNotification

PUT /api/v1/notifications/{notificationId}

Retry Notification

Parameters
Path Parameters
Name Description Required Default Pattern

notificationId

The id of the Notification to retry

X

null
Query Parameters
Name Description Required Default Pattern

version

The version of the Notification

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 144. http response codes
Code Message Datatype

200

Notification retry successful

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

204

No Content

<<>>

searchNotifications

PUT /api/v1/notifications/search

Search Notifications

Parameters
Body Parameter
Name Description Required Default Pattern

NotificationSearchRequestDto

NotificationSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetNotificationResponseDtoPage

Content Type

  • application/json

Responses
Table 145. http response codes
Code Message Datatype

200

Found Notifications

GetNotificationResponseDtoPage[GetNotificationResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Pkcs10

createPkcs10Request

POST /api/v1/pkcs10/

Create a PKCS10 Request

Parameters
Body Parameter
Name Description Required Default Pattern

CreatePkcs10RequestDto

CreatePkcs10RequestDto

X
Return Type

CreatePkcs10ResponseDto

Content Type

  • application/json

Responses
Table 146. http response codes
Code Message Datatype

200

PKCS10 Request Created

CreatePkcs10ResponseDto[CreatePkcs10ResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

parsePkcs10

POST /api/v1/pkcs10/parse

Parse a PKCS10 Request

Parameters
Body Parameter
Name Description Required Default Pattern

Pkcs10Dto

Pkcs10Dto

X
Return Type

ParsePkcs10ResponseDto

Content Type

  • application/json

Responses
Table 147. http response codes
Code Message Datatype

200

PKCS10 Request Parsed

ParsePkcs10ResponseDto[ParsePkcs10ResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Policy

availablePoliciesWithoutPasswordByEndEntityId

GET /api/v1/policies/end-entities/{id}/no-password

Find the Policies without an End Entity Password for a specific End Entity

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the End Entity for which the search is requested

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetPolicyResponseDtoPage

Content Type

  • application/json

Responses
Table 148. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

checkEndEntityWithRules

POST /api/v1/policies/{id}/rules

Check End Entity Rules

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Body Parameter
Name Description Required Default Pattern

CheckEndEntityRequestDto

CheckEndEntityRequestDto

X
Return Type

CheckEndEntityResponseDto

Content Type

  • application/json

Responses
Table 149. http response codes
Code Message Datatype

200

End Entity Rules Checked

CheckEndEntityResponseDto[CheckEndEntityResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createNewPolicy

POST /api/v1/policies/

Create a Policy

Parameters
Body Parameter
Name Description Required Default Pattern

CreatePolicyRequestDto

CreatePolicyRequestDto

X
Return Type

CreatePolicyResponseDto

Content Type

  • application/json

Responses
Table 150. http response codes
Code Message Datatype

201

Policy Created

CreatePolicyResponseDto[CreatePolicyResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getAllowedCryptoParameters

PUT /api/v1/policies/allowed-crypto-params

Get policy allowed crypto parameters for provider provider and provider configuration

Parameters
Body Parameter
Name Description Required Default Pattern

GetAllowedCryptoParametersRequestDto

GetAllowedCryptoParametersRequestDto

X
Return Type

CryptoParametersDto

Content Type

  • application/json

Responses
Table 151. http response codes
Code Message Datatype

200

End Entity Rules Checked

CryptoParametersDto[CryptoParametersDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNameOfRolesWithPolicyAccess

GET /api/v1/policies/{id}/roles

Get role names of respective policy

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Policy that will be used to fetch role names with access to it

X

null
Return Type

GetEntityRoleNamesResponseDto

Content Type

  • application/json

Responses
Table 152. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getPoliciesByCertificateProviderId

GET /api/v1/policies/certificate-providers/{id}

Search Policies that use a specific Certificate Provider

Parameters
Path Parameters
Name Description Required Default Pattern

id

ID of the Certificate Provider for which the search of Policies is requested

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetPolicyResponseDtoPage

Content Type

  • application/json

Responses
Table 153. http response codes
Code Message Datatype

200

Policies Found connected to the specific Certificate Provider

GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getPoliciesInRealms

POST /api/v1/policies/realms

Find the Policies of multiple Realms

Parameters
Body Parameter
Name Description Required Default Pattern

GetPoliciesInRealmsDto

GetPoliciesInRealmsDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetPolicyResponseDtoPage

Content Type

  • application/json

Responses
Table 154. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getPoliciesWithAllowedImport

PUT /api/v1/policies/search-for-import

Search Policies with Allowed Import

Parameters
Body Parameter
Name Description Required Default Pattern

PolicyWithAllowedImportSearchRequestDto

PolicyWithAllowedImportSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetPolicyResponseDtoPage

Content Type

  • application/json

Responses
Table 155. http response codes
Code Message Datatype

200

Policies with Allowed Import found

GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getPolicy

GET /api/v1/policies/{id}

Find a specific Policy

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of Policy to be searched

X

null
Return Type

GetPolicyResponseDto

Content Type

  • application/json

Responses
Table 156. http response codes
Code Message Datatype

200

Policy Found

GetPolicyResponseDto[GetPolicyResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getPolicyByRealmId

GET /api/v1/policies/realms/{id}

Find the Policies of a Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of Realm for which Policies will be searched

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetPolicyResponseDtoPage

Content Type

  • application/json

Responses
Table 157. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSubscriptionsOnPolicy

GET /api/v1/policies/{policyId}/subscriptions

Get Subscriptions on Policy

Parameters
Path Parameters
Name Description Required Default Pattern

policyId

The id of the requested Policy

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetSubscriptionResponseDtoPage

Content Type

  • application/json

Responses
Table 158. http response codes
Code Message Datatype

200

Found Subscriptions on Policy

GetSubscriptionResponseDtoPage[GetSubscriptionResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchAllPolicies

POST /api/v1/policies/search-all

Search all Policies

Parameters
Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

SearchAllRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetPolicyResponseDtoPage

Content Type

  • application/json

Responses
Table 159. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchPolicies

POST /api/v1/policies/search

Search Policies

Parameters
Body Parameter
Name Description Required Default Pattern

PolicySearchRequestDto

PolicySearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetPolicyResponseDtoPage

Content Type

  • application/json

Responses
Table 160. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updatePolicy

PATCH /api/v1/policies/{id}

Update a Policy

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of Policy that will be updated

X

null
Body Parameter
Name Description Required Default Pattern

UpdatePolicyRequestDto

UpdatePolicyRequestDto

X
Return Type

UpdatePolicyResponseDto

Content Type

  • application/json

Responses
Table 161. http response codes
Code Message Datatype

200

Policy Updated

UpdatePolicyResponseDto[UpdatePolicyResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

PublicUser

extractEndEntityInfoFromPemEncodedPkcs10

POST /api/v1/public/extract-end-entity-from-pkcs10

Extract End Entity info from PEM encoded PKCS10 Request

Parameters
Body Parameter
Name Description Required Default Pattern

ExtractEndEntityInfoFromPkcs10RequestDto

ExtractEndEntityInfoFromPkcs10RequestDto

X
Return Type

ExtractEndEntityInfoFromPkcs10ResponseDto

Content Type

  • application/json

Responses
Table 162. http response codes
Code Message Datatype

200

Extracted End Entity info from PEM encoded PKCS10 Request

ExtractEndEntityInfoFromPkcs10ResponseDto[ExtractEndEntityInfoFromPkcs10ResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

verifyCertificateRequestByEmail

POST /api/v1/public/verify-cert-request-with-email

Verify Certificate Request by E-Mail

Parameters
Body Parameter
Name Description Required Default Pattern

VerifyTokenRequestDto

VerifyTokenRequestDto

X
Return Type

EmailVerifiedCertReqResponseDto

Content Type

  • application/json

Responses
Table 163. http response codes
Code Message Datatype

200

Verified Certificate Request and sent an E-Mail

EmailVerifiedCertReqResponseDto[EmailVerifiedCertReqResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

RaCertificate

createBatchRaCertificateForUsers

POST /api/v1/ra-certificates/users/batch

Create Batch Ra Certificates for a User

Parameters
Body Parameter
Name Description Required Default Pattern

CreateRaCertBatchRequestDto

CreateRaCertBatchRequestDto

X
Return Type

ZippedCertsBatchDto

Content Type

  • application/json

Responses
Table 164. http response codes
Code Message Datatype

200

User's Ra Certificates Created

ZippedCertsBatchDto[ZippedCertsBatchDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createRaCertificateForSingleUser

POST /api/v1/ra-certificates/users/{id}

Create/renew Ra Certificate for a single User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are creating

X

null
Body Parameter
Name Description Required Default Pattern

CreateSingleRaCertRequestDto

CreateSingleRaCertRequestDto

X
Return Type

UpdateUserRaCertificateDto

Content Type

  • application/json

Responses
Table 165. http response codes
Code Message Datatype

200

User's Ra Certificate Created

UpdateUserRaCertificateDto[UpdateUserRaCertificateDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadRaCertCrl

GET /api/v1/ra-certificates/users/{id}/crl

Download the Ra Certificate of a User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate CRL we are downloading

X

null
Return Type

CrlDto

Content Type

  • application/json

Responses
Table 166. http response codes
Code Message Datatype

200

Ra Certificate of the User Downloaded

CrlDto[CrlDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadUserRaCertificate

GET /api/v1/ra-certificates/users/{id}/download

Download the Ra Certificate of a User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are downloading

X

null
Return Type

RaCertificatePemDto

Content Type

  • application/json

Responses
Table 167. http response codes
Code Message Datatype

200

User's Ra Certificate Downloaded

RaCertificatePemDto[RaCertificatePemDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

downloadUserRaCertificateChain

GET /api/v1/ra-certificates/users/{id}/download-chain

Download the Certificate Chain of a User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Certificate Chain we are downloading

X

null
Query Parameters
Name Description Required Default Pattern

casFirst

Decides if the chain will start with the EE certificate or not

X

null
Return Type

RaCertificatePemDto

Content Type

  • application/json

Responses
Table 168. http response codes
Code Message Datatype

200

User's Certificate Chain Downloaded

RaCertificatePemDto[RaCertificatePemDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getRaOcspStatus

GET /api/v1/ra-certificates/users/{id}/ocsp-status

Get the Ra OCSP Status of a User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose OCSP Status we are getting

X

null
Return Type

OcspStatusCheckDto

Content Type

  • application/json

Responses
Table 169. http response codes
Code Message Datatype

200

Got the Ra OCSP Status of the User

OcspStatusCheckDto[OcspStatusCheckDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getUserRaCertificate

GET /api/v1/ra-certificates/users/{id}

Find a specific User’s Ra Certificate

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are searching for

X

null
Return Type

GetRaCertificateResponseDto

Content Type

  • application/json

Responses
Table 170. http response codes
Code Message Datatype

200

Ra Certificate Found

GetRaCertificateResponseDto[GetRaCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

retrieveRaCertificateP12

GET /api/v1/ra-certificates/users/{id}/pkcs12

Retrieve the Ra PKCS12 Certificate of a User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra PKCS12 Certificate we are retrieving

X

null
Return Type

KeystoreFileDto

Content Type

  • application/json

Responses
Table 171. http response codes
Code Message Datatype

200

User's Ra PKCS12 Certificate Retrieved

KeystoreFileDto[KeystoreFileDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

revokeRaCertificate

POST /api/v1/ra-certificates/users/{id}/revoke

Revoke the Ra Certificate of a User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are revoking

X

null
Query Parameters
Name Description Required Default Pattern

revReason

The reason of the Revocation request

-

null
Return Type

RevokeRaCertificateResponseDto

Content Type

  • application/json

Responses
Table 172. http response codes
Code Message Datatype

200

User's Ra Certificate Revoked

RevokeRaCertificateResponseDto[RevokeRaCertificateResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Realm

createNewRealm

POST /api/v1/realms/

Create a Realm

Parameters
Body Parameter
Name Description Required Default Pattern

CreateRealmRequestDto

CreateRealmRequestDto

X
Return Type

CreateRealmResponseDto

Content Type

  • application/json

Responses
Table 173. http response codes
Code Message Datatype

201

Realm Created

CreateRealmResponseDto[CreateRealmResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getNameOfRolesWithRealmAccess

GET /api/v1/realms/{id}/roles

Get role names of respective realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Realm that will be used to fetch role names with access to it

X

null
Return Type

GetEntityRoleNamesResponseDto

Content Type

  • application/json

Responses
Table 174. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getRealm

GET /api/v1/realms/{id}

Find Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Realm that requesting to be found

X

null
Return Type

GetRealmResponseDto

Content Type

  • application/json

Responses
Table 175. http response codes
Code Message Datatype

200

Realm Found

GetRealmResponseDto[GetRealmResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getRealms

GET /api/v1/realms/

Find Realms

Parameters
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetRealmResponseDtoPage

Content Type

  • application/json

Responses
Table 176. http response codes
Code Message Datatype

200

Realms Found

GetRealmResponseDtoPage[GetRealmResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSubscriptionsOnRealm

GET /api/v1/realms/{realmId}/subscriptions

Get Subscriptions on Realm

Parameters
Path Parameters
Name Description Required Default Pattern

realmId

The id of the requested Realm

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetSubscriptionResponseDtoPage

Content Type

  • application/json

Responses
Table 177. http response codes
Code Message Datatype

200

Found Subscriptions on Realm

GetSubscriptionResponseDtoPage[GetSubscriptionResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

POST /api/v1/realms/search

Search Realms

Parameters
Body Parameter
Name Description Required Default Pattern

RealmSearchRequestDto

RealmSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetRealmResponseDtoPage

Content Type

  • application/json

Responses
Table 178. http response codes
Code Message Datatype

200

Realms Found

GetRealmResponseDtoPage[GetRealmResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateRealm

PATCH /api/v1/realms/{id}

Update a Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Realm that will be updated

X

null
Body Parameter
Name Description Required Default Pattern

UpdateRealmRequestDto

UpdateRealmRequestDto

X
Return Type

UpdateRealmResponseDto

Content Type

  • application/json

Responses
Table 179. http response codes
Code Message Datatype

200

Realm Updated

UpdateRealmResponseDto[UpdateRealmResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

RealmStatistics

getCertRequestStatusStatisticsForRealm

GET /api/v1/realm-statistics/{id}/cert-request-status

Get the Certificate Request Status Statistics of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the Certificate Request Status Statistics were requested

X

null
Return Type

GetCertRequestStatusStatisticsResponseDto

Content Type

  • application/json

Responses
Table 180. http response codes
Code Message Datatype

200

Certificate Request Status Statistics for the Realm Found

GetCertRequestStatusStatisticsResponseDto[GetCertRequestStatusStatisticsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateIssuerStatisticsForRealm

GET /api/v1/realm-statistics/{id}/certificate-issuer

Get the Certificate Issuer Statistics of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the Certificate Issuer Statistics were requested

X

null
Return Type

GetCertificateIssuerStatisticsResponseDto

Content Type

  • application/json

Responses
Table 181. http response codes
Code Message Datatype

200

Certificate Issuer Statistics for the Realm Found

GetCertificateIssuerStatisticsResponseDto[GetCertificateIssuerStatisticsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateProviderTypeStatisticsForRealm

GET /api/v1/realm-statistics/{id}/certificate-provider-type

Get the Certificate Provider Type Statistics of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the Certificate Provider Type Statistics were requested

X

null
Return Type

GetCertificateProviderTypeStatisticsResponseDto

Content Type

  • application/json

Responses
Table 182. http response codes
Code Message Datatype

200

Certificate Provider Type Statistics for the Realm Found

GetCertificateProviderTypeStatisticsResponseDto[GetCertificateProviderTypeStatisticsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificatePublicKeyAlgorithmStatisticsForRealm

GET /api/v1/realm-statistics/{id}/certificate-public-key-algorithm

Get the Certificate Public Key Algorithm Statistics of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the Certificate Public Key Algorithm Statistics were requested

X

null
Return Type

GetCertificatePublicKeyAlgorithmStatisticsResponseDto

Content Type

  • application/json

Responses
Table 183. http response codes
Code Message Datatype

200

Certificate Public Key Algorithm Statistics for the Realm Found

GetCertificatePublicKeyAlgorithmStatisticsResponseDto[GetCertificatePublicKeyAlgorithmStatisticsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getCertificateStatusStatisticsForRealm

GET /api/v1/realm-statistics/{id}/certificate-status

Get the Certificate Status Statistics of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the Certificate Status Statistics were requested

X

null
Return Type

GetCertificateStatusStatisticsResponseDto

Content Type

  • application/json

Responses
Table 184. http response codes
Code Message Datatype

200

Certificate Status Statistics for the Realm Found

GetCertificateStatusStatisticsResponseDto[GetCertificateStatusStatisticsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getImportedCertificatesStatisticsForRealm

GET /api/v1/realm-statistics/{id}/imported-certificates

Get the Imported Certificates Statistics of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the Imported Certificates Statistics were requested

X

null
Return Type

GetImportedCertificatesStatisticsResponseDto

Content Type

  • application/json

Responses
Table 185. http response codes
Code Message Datatype

200

Imported Certificates Statistics for the Realm Found

GetImportedCertificatesStatisticsResponseDto[GetImportedCertificatesStatisticsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getLatestAuditEvents

GET /api/v1/realm-statistics/{id}/latest-audit-events

Get the latest Certificate Audit Events of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the Certificate Audit Events events were requested

X

null
Return Type

GetAuditEventResponseDtoList

Content Type

  • application/json

Responses
Table 186. http response codes
Code Message Datatype

200

Latest Certificate Audit Events

GetAuditEventResponseDtoList[GetAuditEventResponseDtoList]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSelfSignedCertificatesStatisticsForRealm

GET /api/v1/realm-statistics/{id}/self-signed-certificates

Get the Self-signed Certificates Statistics of the requested Realm

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the Realm for which the SelfSigned Certificates Statistics were requested

X

null
Return Type

GetSelfSignedCertificatesStatisticsResponseDto

Content Type

  • application/json

Responses
Table 187. http response codes
Code Message Datatype

200

Self-signed Certificates Statistics for the Realm Found

GetSelfSignedCertificatesStatisticsResponseDto[GetSelfSignedCertificatesStatisticsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Roles

batchAssignApiClientRoles

PUT /api/v1/roles/api-clients/assign

Assign Roles for multiple API Clients

Parameters
Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

UpdateSecurityIdentityRolesBatchRequestDto

X
Return Type

UpdateSecurityIdentityRolesBatchResponseDto

Content Type

  • application/json

Responses
Table 188. http response codes
Code Message Datatype

200

API Client Roles assigned

UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

batchAssignUserRoles

PUT /api/v1/roles/users/assign

Assign Roles for multiple Users

Parameters
Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

UpdateSecurityIdentityRolesBatchRequestDto

X
Return Type

UpdateSecurityIdentityRolesBatchResponseDto

Content Type

  • application/json

Responses
Table 189. http response codes
Code Message Datatype

200

User Roles assigned

UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

batchUnassignApiClientRoles

PUT /api/v1/roles/api-clients/unassign

Unassign Roles from multiple API Clients

Parameters
Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

UpdateSecurityIdentityRolesBatchRequestDto

X
Return Type

UpdateSecurityIdentityRolesBatchResponseDto

Content Type

  • application/json

Responses
Table 190. http response codes
Code Message Datatype

200

API Client Roles unassigned

UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

batchUnassignUserRoles

PUT /api/v1/roles/users/unassign

Unassign Roles from multiple Users

Parameters
Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

UpdateSecurityIdentityRolesBatchRequestDto

X
Return Type

UpdateSecurityIdentityRolesBatchResponseDto

Content Type

  • application/json

Responses
Table 191. http response codes
Code Message Datatype

200

User Roles unassigned

UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createRole

POST /api/v1/roles/

Create Role

Parameters
Body Parameter
Name Description Required Default Pattern

CreateRoleRequestDto

CreateRoleRequestDto

X
Return Type

CreateRoleResponseDto

Content Type

  • application/json

Responses
Table 192. http response codes
Code Message Datatype

201

Role created

CreateRoleResponseDto[CreateRoleResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteRole

DELETE /api/v1/roles/{name}

Delete Role

Parameters
Path Parameters
Name Description Required Default Pattern

name

The name of the Role

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 193. http response codes
Code Message Datatype

204

Role deleted

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteRoles

POST /api/v1/roles/batch-delete

Batch Delete Roles

Parameters
Body Parameter
Name Description Required Default Pattern

BatchDeleteRolesRequestDto

BatchDeleteRolesRequestDto

X
Return Type

BatchDeleteRolesResponseDto

Content Type

  • application/json

Responses
Table 194. http response codes
Code Message Datatype

200

Role(s) deleted

BatchDeleteRolesResponseDto[BatchDeleteRolesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getApiClientRoles

GET /api/v1/roles/api-clients/{apiClientId}

Get API Client Roles

Parameters
Path Parameters
Name Description Required Default Pattern

apiClientId

The id of the API Client

X

null
Return Type

GetSecurityIdentityRolesResponseDto

Content Type

  • application/json

Responses
Table 195. http response codes
Code Message Datatype

200

API Client Roles Found

GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getRoleDetails

GET /api/v1/roles/{name}

Get Role

Parameters
Path Parameters
Name Description Required Default Pattern

name

The name of the Role

X

null
Return Type

GetRoleDetailsResponseDto

Content Type

  • application/json

Responses
Table 196. http response codes
Code Message Datatype

200

Role Found

GetRoleDetailsResponseDto[GetRoleDetailsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSecurityIdentitiesOfRole

GET /api/v1/roles/{role}/security-identities

Get security identities of a role

Parameters
Path Parameters
Name Description Required Default Pattern

role

The id of the API Client

X

null
Return Type

GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto

Content Type

  • application/json

Responses
Table 197. http response codes
Code Message Datatype

200

Security identities Found

GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto[GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getUserRoles

GET /api/v1/roles/users/{userId}

Get User Roles

Parameters
Path Parameters
Name Description Required Default Pattern

userId

The id of the User

X

null
Return Type

GetSecurityIdentityRolesResponseDto

Content Type

  • application/json

Responses
Table 198. http response codes
Code Message Datatype

200

User Roles Found

GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchRoles

POST /api/v1/roles/search

Search Roles

Parameters
Body Parameter
Name Description Required Default Pattern

SearchRoleRequestDto

SearchRoleRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetRoleResponseDtoPage

Content Type

  • application/json

Responses
Table 199. http response codes
Code Message Datatype

200

Roles Found

GetRoleResponseDtoPage[GetRoleResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateApiClientRoles

PUT /api/v1/roles/api-clients/{apiClientId}

Update API Client Roles

Parameters
Path Parameters
Name Description Required Default Pattern

apiClientId

The id of the API Client

X

null
Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesRequestDto

UpdateSecurityIdentityRolesRequestDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 200. http response codes
Code Message Datatype

204

API Client Roles Updated

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateRole

PUT /api/v1/roles/{name}

Update Role

Parameters
Path Parameters
Name Description Required Default Pattern

name

The name of the Role

X

null
Body Parameter
Name Description Required Default Pattern

UpdateRoleRequestDto

UpdateRoleRequestDto

X
Return Type

UpdateRoleResponseDto

Content Type

  • application/json

Responses
Table 201. http response codes
Code Message Datatype

200

Role updated

UpdateRoleResponseDto[UpdateRoleResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateUserRoles

PUT /api/v1/roles/users/{userId}

Update User Roles

Parameters
Path Parameters
Name Description Required Default Pattern

userId

The id of the User

X

null
Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesRequestDto

UpdateSecurityIdentityRolesRequestDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 202. http response codes
Code Message Datatype

204

User Roles Updated

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Scep

decryptData

POST /api/v1/scep/decrypt

Decrypts the data with the signer of the policy provided in the parameters

Parameters
Body Parameter
Name Description Required Default Pattern

ScepDecryptDataRequestDto

ScepDecryptDataRequestDto

X
Return Type

ScepDecryptDataResponseDto

Content Type

  • application/json

Responses
Table 203. http response codes
Code Message Datatype

200

Data decrypted

ScepDecryptDataResponseDto[ScepDecryptDataResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

raDecryptData

POST /api/v1/scep/ra-decrypt

Decrypts the data with the RA signer of the policy provided in the parameters

Parameters
Body Parameter
Name Description Required Default Pattern

ScepDecryptDataRequestDto

ScepDecryptDataRequestDto

X
Return Type

ScepDecryptDataResponseDto

Content Type

  • application/json

Responses
Table 204. http response codes
Code Message Datatype

200

Data decrypted

ScepDecryptDataResponseDto[ScepDecryptDataResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

raSignDataScep

POST /api/v1/scep/ra-sign

Signs the data with the RA signer of the policy provided in the parameters

Parameters
Body Parameter
Name Description Required Default Pattern

ScepSignRequestDto

ScepSignRequestDto

X
Return Type

ScepSignDataResponseDto

Content Type

  • application/json

Responses
Table 205. http response codes
Code Message Datatype

200

Data signed

ScepSignDataResponseDto[ScepSignDataResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

signDataScep

POST /api/v1/scep/sign

Signs the data with the signer of the policy provided in the parameters

Parameters
Body Parameter
Name Description Required Default Pattern

ScepSignRequestDto

ScepSignRequestDto

X
Return Type

ScepSignDataResponseDto

Content Type

  • application/json

Responses
Table 206. http response codes
Code Message Datatype

200

Data signed

ScepSignDataResponseDto[ScepSignDataResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Sign

signDataWithCA

POST /api/v1/sign/sign-with-ca

Signs the data with the CA of the policy provided in the parameters

Parameters
Body Parameter
Name Description Required Default Pattern

SignDataRequestDto

SignDataRequestDto

X
Return Type

SignDataResponseDto

Content Type

  • application/json

Responses
Table 207. http response codes
Code Message Datatype

200

Data signed

SignDataResponseDto[SignDataResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Subscription

createSelfSubscription

POST /api/v1/subscriptions/self

Create Subscription

Parameters
Body Parameter
Name Description Required Default Pattern

CreateSelfSubscriptionRequestDto

CreateSelfSubscriptionRequestDto

X
Return Type

CreateResourceResponseDto

Content Type

  • application/json

Responses
Table 208. http response codes
Code Message Datatype

201

Subscription Created

CreateResourceResponseDto[CreateResourceResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

createSubscriptions

POST /api/v1/subscriptions/

Create Subscription(s)

Parameters
Body Parameter
Name Description Required Default Pattern

CreateSubscriptionsRequestDto

CreateSubscriptionsRequestDto

X
Return Type

CreateSubscriptionsResponseDto

Content Type

  • application/json

Responses
Table 209. http response codes
Code Message Datatype

201

Subscription(s) Created

CreateSubscriptionsResponseDto[CreateSubscriptionsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

deleteSubscription

DELETE /api/v1/subscriptions/{subscriptionId}

Delete Subscription

Parameters
Path Parameters
Name Description Required Default Pattern

subscriptionId

The id of the desired Subscription

X

null
Query Parameters
Name Description Required Default Pattern

version

The version of the Subscription that will be deleted

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 210. http response codes
Code Message Datatype

204

Subscription Deleted

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getContactsAbleToSubscribeToTarget

PUT /api/v1/subscriptions/contacts

Get Contacts available for Subscription on provided target

Parameters
Body Parameter
Name Description Required Default Pattern

GetTargetsForSubscriptionRequestDto

GetTargetsForSubscriptionRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetContactForSubscriptionResponseDtoPage

Content Type

  • application/json

Responses
Table 211. http response codes
Code Message Datatype

200

Found Contacts

GetContactForSubscriptionResponseDtoPage[GetContactForSubscriptionResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSubscription

GET /api/v1/subscriptions/{subscriptionId}

Get Subscription

Parameters
Path Parameters
Name Description Required Default Pattern

subscriptionId

The id of the requested Subscription

X

null
Return Type

GetSubscriptionResponseDto

Content Type

  • application/json

Responses
Table 212. http response codes
Code Message Datatype

200

Found Subscription

GetSubscriptionResponseDto[GetSubscriptionResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getUsersAbleToSubscribeToTarget

PUT /api/v1/subscriptions/users

Get Users available for Subscription on provided target

Parameters
Body Parameter
Name Description Required Default Pattern

GetTargetsForSubscriptionRequestDto

GetTargetsForSubscriptionRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetUserForSubscriptionResponseDtoPage

Content Type

  • application/json

Responses
Table 213. http response codes
Code Message Datatype

200

Found Contacts

GetUserForSubscriptionResponseDtoPage[GetUserForSubscriptionResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateSubscription

PUT /api/v1/subscriptions/{subscriptionId}

Update Subscription

Parameters
Path Parameters
Name Description Required Default Pattern

subscriptionId

The id of the desired Subscription

X

null
Body Parameter
Name Description Required Default Pattern

UpdateSubscriptionRequestDto

UpdateSubscriptionRequestDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 214. http response codes
Code Message Datatype

204

Subscription Updated

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Template

getTemplate

GET /api/v1/templates/{id}

Find Template

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Template to be searched

X

null
Return Type

GetTemplateDetailsResponseDto

Content Type

  • application/json

Responses
Table 215. http response codes
Code Message Datatype

200

Template Found

GetTemplateDetailsResponseDto[GetTemplateDetailsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getTemplateVariablePlaceholders

GET /api/v1/templates/{id}/variable-placeholders

Get allowed variable placeholders

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Template whose variable placeholders are requested

X

null
Return Type

GetAllowedVariablePlaceholdersDto

Content Type

  • application/json

Responses
Table 216. http response codes
Code Message Datatype

200

Allowed variable placeholders Found

GetAllowedVariablePlaceholdersDto[GetAllowedVariablePlaceholdersDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchTemplates

PUT /api/v1/templates/search

Search Templates

Parameters
Body Parameter
Name Description Required Default Pattern

TemplateSearchRequestDto

TemplateSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetTemplateResponseDtoPage

Content Type

  • application/json

Responses
Table 217. http response codes
Code Message Datatype

200

Found Templates

GetTemplateResponseDtoPage[GetTemplateResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateTemplate

PUT /api/v1/templates/{id}

Update a Template

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the Template that will be updated

X

null
Body Parameter
Name Description Required Default Pattern

body

[AnyType]

X
Return Type

-

Content Type

  • application/json

Responses
Table 218. http response codes
Code Message Datatype

204

Template Updated

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

User

editPasswordLoginRoleToUser

POST /api/v1/users/{id}/update-password-login

Set or unset disable_password_login Role to User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User

X

null
Query Parameters
Name Description Required Default Pattern

enablePasswordLogin

X

null
Return Type

-

Content Type

  • application/json

Responses
Table 219. http response codes
Code Message Datatype

204

Set disable_password_login role

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

findUserByRaCertificate

POST /api/v1/users/certificates/ra-certificate

Find User by the RA Certificate

Parameters
Body Parameter
Name Description Required Default Pattern

FindUserByRaCertificateRequestDto

FindUserByRaCertificateRequestDto

X
Return Type

GetUserDetailsResponseDto

Content Type

  • application/json

Responses
Table 220. http response codes
Code Message Datatype

200

User Found

GetUserDetailsResponseDto[GetUserDetailsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getSubscriptionsOfUser

GET /api/v1/users/{userId}/subscriptions

Get Subscriptions of User

Parameters
Path Parameters
Name Description Required Default Pattern

userId

The id of the requested User

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetSubscriptionResponseDtoPage

Content Type

  • application/json

Responses
Table 221. http response codes
Code Message Datatype

200

Found User Subscriptions

GetSubscriptionResponseDtoPage[GetSubscriptionResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getUser

GET /api/v1/users/{id}

Find User

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of the User to be searched

X

null
Return Type

GetUserDetailsResponseDto

Content Type

  • application/json

Responses
Table 222. http response codes
Code Message Datatype

200

User Found

GetUserDetailsResponseDto[GetUserDetailsResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

getUserContact

GET /api/v1/users/{id}/contact

Get Contact of a user

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the User

X

null
Return Type

GetUserContactResponseDto

Content Type

  • application/json

Responses
Table 223. http response codes
Code Message Datatype

200

Found User Contact

GetUserContactResponseDto[GetUserContactResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

registerUser

POST /api/v1/users/

Register a User

Parameters
Body Parameter
Name Description Required Default Pattern

CreateNewUserDetailsDto

CreateNewUserDetailsDto

X
Return Type

GetUserResponseDto

Content Type

  • application/json

Responses
Table 224. http response codes
Code Message Datatype

201

User Registered

GetUserResponseDto[GetUserResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

409

Conflict, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

searchUsers

POST /api/v1/users/search

Search Users

Parameters
Body Parameter
Name Description Required Default Pattern

UserSearchRequestDto

UserSearchRequestDto

X
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

GetUserResponseDtoPage

Content Type

  • application/json

Responses
Table 225. http response codes
Code Message Datatype

200

Users Found

GetUserResponseDtoPage[GetUserResponseDtoPage]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

sendUpdatePasswordEmailBatch

POST /api/v1/users/email-update-password-batch

Send Batch update password E-Mails

Parameters
Body Parameter
Name Description Required Default Pattern

UserListDto

UserListDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 226. http response codes
Code Message Datatype

204

Batch update password E-Mails sent

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

setUserCertificateDetails

PUT /api/v1/users/{id}/set-details

Set a user’s Certificate Details

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id of User whose details will be set

X

null
Body Parameter
Name Description Required Default Pattern

UpdateUserCertificateDetailsRequestDto

UpdateUserCertificateDetailsRequestDto

X
Return Type

GetUserResponseDto

Content Type

  • application/json

Responses
Table 227. http response codes
Code Message Datatype

200

User's Certificate Details Set

GetUserResponseDto[GetUserResponseDto]

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

updateUserContact

PUT /api/v1/users/{id}/contact

Update the Contact of a user

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id of the desired User

X

null
Body Parameter
Name Description Required Default Pattern

UpdateUserContactRequestDto

UpdateUserContactRequestDto

X
Return Type

-

Content Type

  • application/json

Responses
Table 228. http response codes
Code Message Datatype

204

User's Contact updated

<<>>

400

Bad Request

ApiExceptionResponse[ApiExceptionResponse]

401

Authentication Failed

ApiExceptionResponse[ApiExceptionResponse]

403

Access Denied

ApiExceptionResponse[ApiExceptionResponse]

404

Not Found, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

405

Http method not allowed

ApiExceptionResponse[ApiExceptionResponse]

415

Specified media not supported for this endpoint

ApiExceptionResponse[ApiExceptionResponse]

500

Internal Error, check the result for more information

ApiExceptionResponse[ApiExceptionResponse]

Models

ApiClientSearchRequestDto

It includes filters that will be used to search for the desired resources

Field Name Required Type Description Format

simpleSearchTerm

String

ApiError

Field Name Required Type Description Format

ApiExceptionResponse

Field Name Required Type Description Format

apiError

X

ApiError

errorMessage

String

ApproveCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

certificateId

UUID

uuid

certRequestStatus

CertRequestStatus

userResponses

List of UserResponseDto

metadata

AuditedAndVersionDtoUUID

ArchiveAllEntitiesRequestDto

It includes all the desired ids of a specific Type of Entity that will have their archived status updated

Field Name Required Type Description Format

archiveEntityRequestDtoList

List of [UUID]

uuid

ArchivedDtoUUID

Field Name Required Type Description Format

archived

Boolean

archivedDate

Date

date-time

archivedBy

UUID

uuid

archivedByType

SecurityIdentityType

AuditEventDto

Field Name Required Type Description Format

objectId

UUID

uuid

eventDescription

String

occurredDate

Date

date-time

AuditedAndVersionDtoUUID

Field Name Required Type Description Format

createdBy

UUID

uuid

createdByType

SecurityIdentityType

createdDate

Date

date-time

lastModifiedBy

UUID

uuid

lastModifiedByType

SecurityIdentityType

lastModifiedDate

Date

date-time

version

Integer

int32

AuthenticatedPrincipalResponseDto

Field Name Required Type Description Format

id

UUID

uuid

authenticatedPrincipalType

SecurityIdentityType

BatchCertificateCreationErrorResponseDto

Field Name Required Type Description Format

failedUserId

UUID

uuid

apiError

ApiError

BatchDeleteContactsRequestDto

It includes all the required data of the contacts to be deleted

Field Name Required Type Description Format

contacts

X

List of DeleteContactRequestDto

BatchDeleteContactsResponseDto

Field Name Required Type Description Format

successful

X

Set of [UUID]

uuid

failed

X

Map of ApiError

BatchDeleteRolesRequestDto

It includes all the names of the roles to be deleted

Field Name Required Type Description Format

roleNames

X

Set of [string]

BatchDeleteRolesResponseDto

Field Name Required Type Description Format

successful

Set of [string]

failed

Map of ApiError

CTScanCertificateDto

Field Name Required Type Description Format

pemCertificate

X

String

domain

X

String

subjectDN

X

String

issuerDN

X

String

serialNumber

X

String

expirationDate

X

Date

date-time

CTScanRequestDto

It includes the respective search term for scanning and optional proxy host and port.

Field Name Required Type Description Format

searchTerm

X

String

proxyHost

String

proxyPort

Integer

int32

CTScanResponseDto

Field Name Required Type Description Format

ctScanCertificatesDtoList

X

Set of CTScanCertificateDto

CaCertificateDataPemDto

Field Name Required Type Description Format

id

UUID

uuid

filename

String

pemCertificate

String

CaCertificatePemDto

Field Name Required Type Description Format

pemCertificate

String

CaSearchRequestDto

It includes filters that will be used to search for the desired resources

Field Name Required Type Description Format

simpleSearchTerm

String

issuerSearch

Boolean

caIds

Set of [UUID]

uuid

validNotBeforeStart

Date

date-time

validNotBeforeEnd

Date

date-time

validNotAfterStart

Date

date-time

validNotAfterEnd

Date

date-time

archived

Boolean

CaraTemplateSignerDto

Field Name Required Type Description Format

id

Long

int64

name

String

caSubjectDn

String

CaraTemplateSignerDtoList

Field Name Required Type Description Format

caraTemplateSignerList

List of CaraTemplateSignerDto

CertReqSearchByPkcs10

It includes the PKCS10, which is needed to find the desired Certificate Request

Field Name Required Type Description Format

pkcs10ReqBase64

X

String

CertReqSearchRequestDto

It includes all the properties that can be used for the search

Field Name Required Type Description Format

realmId

X

UUID

uuid

simpleSearchTerm

String

policyId

UUID

uuid

certRequestIds

Set of [UUID]

uuid

archived

Boolean

CertRequestAction

Field Name Required Type Description Format

CertRequestPermission

Field Name Required Type Description Format

CertRequestStatus

Field Name Required Type Description Format

CertStatus

Field Name Required Type Description Format

CertificateDto

Field Name Required Type Description Format

id

UUID

uuid

endEntityId

UUID

uuid

policyId

UUID

uuid

serialNumber

String

subjectDn

String

subjectCommonName

String

issuerDn

String

issuerCommonName

String

validNotBefore

String

validNotAfter

String

certStatus

CertStatus

certPublicKeyAlgorithm

CryptoAlgorithm

fingerprint

String

certRequestId

UUID

uuid

metadata

AuditedAndVersionDtoUUID

CertificatePemDto

Field Name Required Type Description Format

id

UUID

uuid

fileName

String

pemCertificate

String

CertificatePermission

Field Name Required Type Description Format

CertificatePlainValidationResponseDto

Field Name Required Type Description Format

result

Boolean

CertificatePrivateKeyPemDto

Field Name Required Type Description Format

id

UUID

uuid

fileName

String

pemPrivateKey

String

CertificateProviderDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

CertificateProviderSearchRequestDto

It includes filters that will be used to search for the desired resources

Field Name Required Type Description Format

certificateProviderIds

Set of [UUID]

uuid

archived

Boolean

certificateProviderType

CertificateProviderType

CertificateProviderType

Field Name Required Type Description Format

CertificateRevocationResult

Field Name Required Type Description Format

CertificateSearchKey

Field Name Required Type Description Format

CertificateSearchRequestDto

It includes filters that will be used to search for the desired resources

Field Name Required Type Description Format

realmId

UUID

uuid

simpleSearchTerm

String

certificateIds

Set of [UUID]

uuid

endEntityIds

Set of [UUID]

uuid

policyIds

Set of [UUID]

uuid

certStatuses

Set of CertStatus

certPublicKeyAlgorithms

Set of CryptoAlgorithm

serialNumber

String

issuerDn

String

subjectDn

String

issuerDnBin

String

subjectDnBin

String

validNotBeforeStart

Date

date-time

validNotBeforeEnd

Date

date-time

validNotAfterStart

Date

date-time

validNotAfterEnd

Date

date-time

selfSigned

Boolean

imported

Boolean

archived

Boolean

CertificateValidationResponseDto

Field Name Required Type Description Format

result

Boolean

errorDescription

String

certificateChain

String

ChannelType

Field Name Required Type Description Format

CheckCertificateProviderConnectionDto

Field Name Required Type Description Format

connected

Boolean

CheckEndEntityRequestDto

Field Name Required Type Description Format

commonName

X

String

organization

String

organizationalUnit

String

country

String

email

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

CheckEndEntityResponseDto

Field Name Required Type Description Format

endEntityPropertyApiErrorMap

Map of ApiError

ClmLicenseType

Field Name Required Type Description Format

CmpCalculateMacRequestDto

Field Name Required Type Description Format

data

X

byte[]

byte

encodedPBMParameter

X

byte[]

byte

policyId

X

UUID

uuid

endEntityId

X

UUID

uuid

CmpCalculateMacResponseDto

Field Name Required Type Description Format

macValue

X

byte[]

byte

CmpConfigurationDto

Field Name Required Type Description Format

certificateProviderDto

X

CertificateProviderDto

signerConfigurationDto

X

SignerConfigurationDto

CmpConfigurationRequestDto

Field Name Required Type Description Format

certificateProviderId

X

UUID

uuid

signerConfigurationDto

X

SignerConfigurationDto

CmpConfigurationResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

policyId

X

UUID

uuid

cmpConfigurationDto

X

CmpConfigurationDto

CmpMacVerificationResult

Field Name Required Type Description Format

CmpSignRequestDto

Field Name Required Type Description Format

data

X

byte[]

byte

policyId

X

UUID

uuid

CmpSignatureAlgorithm

Field Name Required Type Description Format

CmpVerifyMacEndEntityCommonNameRequestDto

Field Name Required Type Description Format

macValue

X

byte[]

byte

data

X

byte[]

byte

encodedPBMParameter

X

byte[]

byte

policyId

X

UUID

uuid

endEntityCommonName

X

String

CmpVerifyMacEndEntityIdRequestDto

Field Name Required Type Description Format

macValue

X

byte[]

byte

data

X

byte[]

byte

encodedPBMParameter

X

byte[]

byte

policyId

X

UUID

uuid

endEntityId

X

UUID

uuid

CmpVerifyMacResponseDto

Field Name Required Type Description Format

cmpMacVerificationResult

X

CmpMacVerificationResult

endEntityId

UUID

uuid

ContactRecipientDetailsRequestDto

Field Name Required Type Description Format

emailRecipientData

EmailRecipientDataRequestDto

ContactSearchRequestDto

It includes all the properties that can be searched with

Field Name Required Type Description Format

simpleSearchTerm

String

realmId

UUID

uuid

ContactType

Field Name Required Type Description Format

ContactTypeDetails

Field Name Required Type Description Format

type

X

ContactType

realmId

UUID

uuid

CreateCertReqRequestDto

It includes all the properties needed for the creation of a Certificate Request

Field Name Required Type Description Format

policyId

X

UUID

uuid

endEntityId

X

UUID

uuid

validFor

ValidFor

keyPairMode

X

KeyPairMode

keyGenParamsDto

KeyGenParamsDto

pkcs10ReqBase64

String

publicKeyBase64

String

isSelfSigned

Boolean

CreateCertReqResponseDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

metadata

AuditedAndVersionDtoUUID

CreateCertificateProviderRequestDto

It includes all the necessary values to create a new Certificate Provider

Field Name Required Type Description Format

name

X

String

certificateProviderType

X

CertificateProviderType

configuration

X

oas_any_type_not_mapped

CreateCertificateProviderResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

configuration

X

oas_any_type_not_mapped

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

CreateCertificateResponseDto

Field Name Required Type Description Format

certificate

CertificateDto

base64EncodedPkcs12

String

base64EncodedJceKs

String

fileName

String

filePassword

String

version

Integer

int32

accessiblePrivateKey

Boolean

errorOccurred

Boolean

CreateConfigurationRequestDto

It includes all the necessary values to create a new Configuration

Field Name Required Type Description Format

setting

X

SettingsKey

configurationValue

X

String

CreateConfigurationResponseDto

Field Name Required Type Description Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

CreateContactRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

name

X

String

preferredLanguage

X

Language

typeDetails

ContactTypeDetails

recipientDetails

ContactRecipientDetailsRequestDto

description

String

CreateCryptoModuleRequestDto

It includes all the necessary values to create a new Crypto Module

Field Name Required Type Description Format

cryptoModuleType

X

CryptoModuleType

name

X

String

configuration

X

oas_any_type_not_mapped

CreateCryptoModuleResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

cryptoModuleType

X

CryptoModuleType

configuration

X

oas_any_type_not_mapped

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

CreateEndEntityPasswordRequestDto

It includes all the properties needed for the creation of a Password for and End Entity

Field Name Required Type Description Format

endEntityIds

X

List of [UUID]

uuid

policyId

X

UUID

uuid

CreateEndEntityPasswordResponseDto

Field Name Required Type Description Format

endEntityIds

List of [UUID]

uuid

policyId

UUID

uuid

password

String

metadata

AuditedAndVersionDtoUUID

CreateEndEntityRequestDto

It includes all the necessary values to create a new End Entity

Field Name Required Type Description Format

realmId

X

UUID

uuid

commonName

X

String

organization

String

organizationalUnit

String

country

String

externalId

String

email

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

CreateEndEntityResponseDto

Field Name Required Type Description Format

id

UUID

uuid

commonName

String

organization

String

organizationalUnit

String

country

String

externalId

String

email

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

metadata

AuditedAndVersionDtoUUID

CreateMultipleCertReqRequestDto

It includes all the properties needed for the creation of a Certificate Request for multiple End Entities

Field Name Required Type Description Format

policyId

X

UUID

uuid

endEntitiesIds

X

List of [UUID]

uuid

validFor

ValidFor

keyPairMode

X

KeyPairMode

keyGenParamsDto

KeyGenParamsDto

pkcs10ReqBase64

String

publicKeyBase64

String

isSelfSigned

Boolean

CreateMultipleCertReqResponseDto

Field Name Required Type Description Format

certRequestsCreated

Map of CreateCertReqResponseDto

certRequestsFailed

Map of ApiError

CreateMultipleCertificateFromCertRequestsResponseDto

Field Name Required Type Description Format

zipFileInBase64

String

filePassword

String

certificatesFailed

Map of ApiError

certificatesSuccessful

Map of [UUID]

uuid

CreateNewApiClientRequest

It includes all the properties needed for the creation of an Api Client

Field Name Required Type Description Format

realmIds

X

List of [UUID]

uuid

name

X

String

defaultPolicyId

UUID

uuid

CreateNewApiClientResponse

Field Name Required Type Description Format

id

X

UUID

uuid

secret

String

clientId

String

name

String

CreateNewUserDetailsDto

It includes the basic properties needed for the creation

Field Name Required Type Description Format

firstName

X

String

lastName

X

String

email

X

String

passwordLoginEnabled

Boolean

CreatePkcs10RequestDto

It includes all the properties necessary for the creation

Field Name Required Type Description Format

keyGenParamsDto

KeyGenParamsDto

endEntityInfoDto

EndEntityInfoDto

CreatePkcs10ResponseDto

Field Name Required Type Description Format

pkcs10RequestPemEncoded

X

String

pkcs10RequestFileName

X

String

encryptedPrivateKeyInPemFormat

X

String

privateKeyName

X

String

privateKeyPassword

X

String

CreatePolicyRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

realmId

X

UUID

uuid

name

X

String

certificateProviderId

X

UUID

uuid

certificateProviderConfiguration

X

String

requiresManualApproval

Boolean

allowedKeyPairModes

X

Set of KeyPairMode

allowedValidForValues

X

Set of ValidFor

cryptoRestrictions

X

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

endEntityStrategy

X

EndEntityStrategy

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationRequestDto

CmpConfigurationRequestDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

CreatePolicyResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

certificateProviderDto

CertificateProviderDto

certificateProviderConfiguration

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of KeyPairMode

allowedValidForValues

Set of ValidFor

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

metadata

AuditedAndVersionDtoUUID

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationResponseDto

CmpConfigurationResponseDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

CreateRaCertBatchRequestDto

It includes all the properties needed for the batch creation

Field Name Required Type Description Format

validFor

ValidFor

keyGenParamsDto

KeyGenParamsDto

userIds

List of [UUID]

uuid

CreateRealmRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

name

X

String

CreateRealmResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

archived

X

Boolean

metadata

X

AuditedAndVersionDtoUUID

CreateResourceResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

CreateRoleRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

name

X

String

globalPermissions

Set of GlobalPermission

realmPermissions

X

Set of RoleEntityPermissionsDtoRealmPermission

policyPermissions

X

Set of RoleEntityPermissionsDtoPolicyPermission

endEntityPermissions

X

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

X

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

X

Set of RoleEntityPermissionsDtoCertificatePermission

CreateRoleResponseDto

Field Name Required Type Description Format

name

String

globalPermissions

Set of GlobalPermission

realmPermissions

Set of RoleEntityPermissionsDtoRealmPermission

policyPermissions

Set of RoleEntityPermissionsDtoPolicyPermission

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

CreateSelfSubscriptionRequestDto

It includes all the properties needed for the subscription

Field Name Required Type Description Format

targetType

X

SubscriptionTargetType

targetId

X

UUID

uuid

notificationsConfiguration

NotificationsConfigurationDto

CreateSingleRaCertRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

validFor

ValidFor

keyPairMode

X

KeyPairMode

keyGenParamsDto

KeyGenParamsDto

pkcs10ReqBase64

String

publicKeyBase64

String

CreateSubscriptionsRequestDto

It includes all the properties needed for the subscription(s)

Field Name Required Type Description Format

targetType

X

SubscriptionTargetType

targetId

X

UUID

uuid

notificationsConfiguration

NotificationsConfigurationDto

contactIds

X

Set of [UUID]

uuid

userIds

X

Set of [UUID]

uuid

CreateSubscriptionsResponseDto

Field Name Required Type Description Format

successfulContacts

X

Map of [UUID]

uuid

failedContacts

X

Map of ApiError

successfulUsers

X

Map of [UUID]

uuid

failedUsers

X

Map of ApiError

CrlDto

Field Name Required Type Description Format

fileName

String

crl

String

CryptoAlgorithm

Field Name Required Type Description Format

CryptoModuleSearchRequestDto

It includes filters that will be used to search for the desired resources

Field Name Required Type Description Format

simpleSearchTerm

String

archived

Boolean

CryptoModuleType

Field Name Required Type Description Format

CryptoParametersDto

Field Name Required Type Description Format

keyPairModes

Set of KeyPairMode

cryptoRestrictions

CryptoRestrictionsDto

CryptoRestrictionsDto

Field Name Required Type Description Format

allowedCryptoAlgorithms

X

List of CryptoAlgorithm

rsaKeyGenParams

X

List of RsaKeyGenParams

ecKeyGenParams

X

List of EcKeyGenParams

edDsaKeyGenParams

X

List of EdDsaKeyGenParams

DeclineCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

certRequestStatus

CertRequestStatus

userResponses

List of UserResponseDto

metadata

AuditedAndVersionDtoUUID

DeleteArchivedEntitiesRequestDto

It includes all the desired ids of a specific Type of Entity that will be deleted

Field Name Required Type Description Format

entitiesId

X

List of [UUID]

The list of Entity Ids that will be parsed to Delete them. These Entities must be archived and the Ids must be of Type UUID

uuid

DeleteContactRequestDto

Field Name Required Type Description Format

id

X

UUID

uuid

version

Integer

int32

EcKeyGenParams

Field Name Required Type Description Format

namedCurve

X

String

cryptoAlgorithm

X

CryptoAlgorithm

EcNamedCurve

Field Name Required Type Description Format

EdDsaCurve

Field Name Required Type Description Format

EdDsaKeyGenParams

Field Name Required Type Description Format

edDsaCurve

X

EdDsaCurve

cryptoAlgorithm

X

CryptoAlgorithm

EmailDto

It includes the E-Mail address that the E-Mail will be sent to

Field Name Required Type Description Format

email

X

String

EmailRecipientDataRequestDto

Field Name Required Type Description Format

address

X

String

cc

Set of [string]

bcc

Set of [string]

EmailRecipientDataResponseDto

Field Name Required Type Description Format

address

X

String

cc

Set of [string]

bcc

Set of [string]

EmailUserRecipientDataRequestDto

Field Name Required Type Description Format

cc

X

Set of [string]

bcc

X

Set of [string]

EmailVerifiedCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

certRequestStatus

CertRequestStatus

metadata

AuditedAndVersionDtoUUID

EndEntitiesCsvDto

It includes the multipart file in Base64 format and the realm's id

Field Name Required Type Description Format

realmId

X

UUID

uuid

csvFile

X

String

EndEntityAuthenticationRequestDto

It includes all the properties needed to authenticate with an End Entity and it's set Password

Field Name Required Type Description Format

endEntityId

X

UUID

uuid

password

X

String

EndEntityAuthenticationResponseDto

Field Name Required Type Description Format

endEntity

X

GetEndEntityResponseDto

policy

X

GetPolicyResponseDto

endEntityId

UUID

uuid

policyId

UUID

uuid

EndEntityDatasetRequestDto

It includes the End-Entity details required to identify the End-Entity

Field Name Required Type Description Format

commonName

X

String

organization

String

organizationalUnit

String

country

String

email

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

EndEntityFilterDto

Field Name Required Type Description Format

commonName

String

organization

String

organizationalUnit

String

country

String

email

String

externalId

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

EndEntityInfoDto

Field Name Required Type Description Format

commonName

X

String

organization

String

organizationalUnit

String

country

String

email

String

domains

List of [string]

ips

List of [string]

EndEntityMassImportResponseDto

Field Name Required Type Description Format

endEntityIds

List of [UUID]

uuid

EndEntityPasswordRequestDto

It includes all the properties needed for the deletion of an End Entity's Password

Field Name Required Type Description Format

endEntityId

X

UUID

uuid

policyId

X

UUID

uuid

version

Integer

int32

EndEntityPermission

Field Name Required Type Description Format

EndEntityProperty

Field Name Required Type Description Format

EndEntityRule

Field Name Required Type Description Format

required

Boolean

endEntityProperty

X

EndEntityProperty

allowedValues

X

Set of [string]

EndEntitySearchRequestDto

It includes all the properties that can be searched with

Field Name Required Type Description Format

realmId

X

UUID

uuid

simpleSearchTerm

String

policyId

UUID

uuid

endEntityIds

Set of [UUID]

uuid

endEntityFilterDto

EndEntityFilterDto

archived

Boolean

EndEntityStrategy

Field Name Required Type Description Format

EntitiesEnum

Field Name Required Type Description Format

EventType

Field Name Required Type Description Format

ExaminePkcs10RequestRequestDto

It includes all the necessary properties to examine the PKCS10 request

Field Name Required Type Description Format

policyId

X

UUID

uuid

endEntityId

X

UUID

uuid

pkcs10ReqBase64

X

String

ExaminePkcs10RequestResponseDto

Field Name Required Type Description Format

isValid

Boolean

ExtractEndEntityInfoFromPkcs10RequestDto

It contains the PEM encoded PKCS10 Request

Field Name Required Type Description Format

pemEncodedPkcs10

X

String

ExtractEndEntityInfoFromPkcs10ResponseDto

Field Name Required Type Description Format

commonName

String

organization

String

organizationalUnit

String

country

String

email

String

domains

List of [string]

ips

List of [string]

FailedCertificateOrderResultDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

apiError

ApiError

FailedImportCertRequestResponseDto

Field Name Required Type Description Format

certificateFingerprint

String

apiError

ApiError

FindEeByCertBytesRequestDto

It includes the properties needed to find the End Entity

Field Name Required Type Description Format

realmId

X

UUID

uuid

base64EncodedBytes

X

String

FindUserByRaCertificateRequestDto

It includes the Base64 version of the User's RA Certificate that we are searching for

Field Name Required Type Description Format

base64EncodedBytes

X

String

GenericDto

Field Name Required Type Description Format

key

X

String

value

X

String

GetAllowedCryptoParametersRequestDto

Field Name Required Type Description Format

certificateProviderId

X

UUID

uuid

certificateProviderConfiguration

String

GetAllowedVariablePlaceholdersDto

Field Name Required Type Description Format

allowedVariablePlaceholders

X

List of [string]

GetApiClientDetailsResponse

Field Name Required Type Description Format

id

X

UUID

uuid

realmIds

X

List of [UUID]

uuid

name

String

clientId

X

String

defaultPolicyId

UUID

uuid

GetApiClientResponse

Field Name Required Type Description Format

id

X

UUID

uuid

name

String

clientId

X

String

GetApiClientResponseDtoPage

Field Name Required Type Description Format

content

List of GetApiClientResponse

pageDetails

PageDetailsDto

GetApiErrorValuesResponseDtoList

Field Name Required Type Description Format

apiErrorList

List of ApiError

GetAuditEventResponseDtoList

Field Name Required Type Description Format

auditEventDtoList

List of AuditEventDto

GetAuthenticatedPrincipalPermissionsResponseDto

Field Name Required Type Description Format

globalPermissions

Set of GlobalPermission

realmPermissions

Map of [set]

policyPermissions

Map of [set]

endEntityPermissions

Map of [set]

certRequestPermissions

Map of [set]

certificatePermissions

Map of [set]

GetCaResponseDto

Field Name Required Type Description Format

id

UUID

uuid

validNotBefore

Date

date-time

validNotAfter

Date

date-time

fingerprint

String

issuerCaId

UUID

uuid

rootCa

Boolean

issuerDn

String

subjectDn

String

verifyServers

Boolean

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

GetCertByIssuerDnBinAndSnDto

It includes all the needed properties to get the desired Certificate

Field Name Required Type Description Format

issuerDnBin

X

String

serialNumber

X

String

GetCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

policyId

UUID

uuid

policyName

String

endEntityId

UUID

uuid

endEntityCommonName

String

endEntityEmailAddress

String

keyPairMode

KeyPairMode

validFor

ValidFor

certRequestStatus

CertRequestStatus

keyGenParamsDto

KeyGenParamsDto

certificateId

UUID

uuid

isImported

X

Boolean

isSelfSigned

X

Boolean

userResponses

List of UserResponseDto

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

GetCertReqResponseDtoPage

Field Name Required Type Description Format

content

List of GetCertReqResponseDto

pageDetails

PageDetailsDto

GetCertRequestAdditionalDataResponseDto

Field Name Required Type Description Format

additionalData

oas_any_type_not_mapped

isCertRequestUpdated

Boolean

GetCertRequestPermissionResponseDtoList

Field Name Required Type Description Format

certRequestPermissionList

List of CertRequestPermission

GetCertRequestStatusStatisticsResponseDto

Field Name Required Type Description Format

requiresEmailVerification

Long

int64

pendingApproval

Long

int64

approved

Long

int64

declined

Long

int64

pendingIssuance

Long

int64

issued

Long

int64

issuanceFailed

Long

int64

GetCertStatusResponseDtoList

Field Name Required Type Description Format

certStatusList

List of CertStatus

GetCertificateIssuerStatisticsResponseDto

Field Name Required Type Description Format

empty

Boolean

GetCertificatePermissionResponseDtoList

Field Name Required Type Description Format

certificatePermissionList

List of CertificatePermission

GetCertificateProviderMinimalResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

GetCertificateProviderMinimalResponseDtoPage

Field Name Required Type Description Format

content

List of GetCertificateProviderMinimalResponseDto

pageDetails

PageDetailsDto

GetCertificateProviderResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

configuration

X

oas_any_type_not_mapped

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

GetCertificateProviderResponseDtoPage

Field Name Required Type Description Format

content

List of GetCertificateProviderResponseDto

pageDetails

PageDetailsDto

GetCertificateProviderTypeResponseDtoList

Field Name Required Type Description Format

certificateProviderTypeList

List of CertificateProviderType

GetCertificateProviderTypeStatisticsResponseDto

Field Name Required Type Description Format

mtgCara

Long

int64

msNdes

Long

int64

msca

Long

int64

globalSign

Long

int64

pswPublicCas

Long

int64

GetCertificatePublicKeyAlgorithmStatisticsResponseDto

Field Name Required Type Description Format

rsa

Long

int64

ec

Long

int64

edDsa

Long

int64

GetCertificateResponseDto

Field Name Required Type Description Format

id

UUID

uuid

endEntityId

UUID

uuid

endEntityCommonName

String

policyId

UUID

uuid

policyName

String

serialNumber

String

subjectDn

String

subjectCommonName

String

issuerDn

String

issuerCommonName

String

validNotBefore

String

validNotAfter

String

certStatus

CertStatus

certRevocationReason

RevocationReason

certPublicKeyAlgorithm

CryptoAlgorithm

fingerprint

String

certRequestId

UUID

uuid

isImported

X

Boolean

isSelfSigned

X

Boolean

accessiblePrivateKey

X

Boolean

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

GetCertificateResponseDtoPage

Field Name Required Type Description Format

content

List of GetCertificateResponseDto

pageDetails

PageDetailsDto

GetCertificateSearchKeyResponseDtoList

Field Name Required Type Description Format

certificateSearchKeyList

List of CertificateSearchKey

GetCertificateStatusStatisticsResponseDto

Field Name Required Type Description Format

active

Long

int64

expired

Long

int64

revoked

Long

int64

GetChannelTypeListResponseDto

Field Name Required Type Description Format

channelTypes

List of ChannelType

GetClmLicenseInfoResponseDto

Field Name Required Type Description Format

licenseType

ClmLicenseType

totalAllowedCertificatesCount

Integer

int32

issuedCertificatesCount

Integer

int32

GetCmpConfigurationResponseDto

Field Name Required Type Description Format

id

UUID

uuid

cmpConfigurationDto

CmpConfigurationDto

policyId

UUID

uuid

signerCertChain

String

signerCertificateId

UUID

uuid

GetCmpSignatureAlgorithmResponseDtoList

Field Name Required Type Description Format

cmpSignatureAlgorithmList

List of CmpSignatureAlgorithm

GetConfigurationResponseDto

Field Name Required Type Description Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

GetConfigurationResponseDtoPage

Field Name Required Type Description Format

content

List of GetConfigurationResponseDto

pageDetails

PageDetailsDto

GetContactForSubscriptionResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

preferredLanguage

X

Language

typeDetails

X

ContactTypeDetails

recipientDetails

X

RecipientDetailsResponseDto

description

String

hasSubscription

X

Boolean

metadata

X

AuditedAndVersionDtoUUID

GetContactForSubscriptionResponseDtoPage

Field Name Required Type Description Format

content

X

List of GetContactForSubscriptionResponseDto

pageDetails

X

PageDetailsDto

GetContactResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

preferredLanguage

X

Language

typeDetails

X

ContactTypeDetails

recipientDetails

X

RecipientDetailsResponseDto

description

String

metadata

X

AuditedAndVersionDtoUUID

GetContactResponseDtoPage

Field Name Required Type Description Format

content

X

List of GetContactResponseDto

pageDetails

X

PageDetailsDto

GetCryptoAlgorithmResponseDtoList

Field Name Required Type Description Format

cryptoAlgorithmList

List of CryptoAlgorithm

GetCryptoModuleHealthCheckResponseDto

Field Name Required Type Description Format

isHealthy

Boolean

GetCryptoModuleResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

cryptoModuleType

X

CryptoModuleType

configuration

X

oas_any_type_not_mapped

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

GetCryptoModuleResponseDtoPage

Field Name Required Type Description Format

content

List of GetCryptoModuleResponseDto

pageDetails

PageDetailsDto

GetCryptoModuleTypeListResponseDto

Field Name Required Type Description Format

cryptoModuleTypes

List of CryptoModuleType

GetECNamedCurveResponseDtoList

Field Name Required Type Description Format

ecNamedCurveList

List of EcNamedCurve

GetEdDSANamedCurveResponseDtoList

Field Name Required Type Description Format

edDsaCurveList

List of EdDsaCurve

GetEndEntityPasswordResponseDto

Field Name Required Type Description Format

endEntityId

UUID

uuid

endEntityName

String

policyId

UUID

uuid

policyName

String

metadata

AuditedAndVersionDtoUUID

GetEndEntityPasswordResponseDtoPage

Field Name Required Type Description Format

content

List of GetEndEntityPasswordResponseDto

pageDetails

PageDetailsDto

GetEndEntityPermissionResponseDtoList

Field Name Required Type Description Format

endEntityPermissionList

List of EndEntityPermission

GetEndEntityPropertyResponseDtoList

Field Name Required Type Description Format

endEntityPropertyList

List of EndEntityProperty

GetEndEntityResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

realmId

X

UUID

uuid

commonName

X

String

organization

String

organizationalUnit

String

country

String

externalId

String

email

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

endEntityStrategy

EndEntityStrategy

alias

String

matchesPolicyEndEntityRules

Boolean

GetEndEntityResponseDtoPage

Field Name Required Type Description Format

content

List of GetEndEntityResponseDto

pageDetails

PageDetailsDto

GetEndEntityStrategyResponseDtoList

Field Name Required Type Description Format

endEntityStrategyList

List of EndEntityStrategy

GetEntitiesEnumResponseDtoList

Field Name Required Type Description Format

entitiesEnumList

List of EntitiesEnum

GetEntityRoleNamesResponseDto

Field Name Required Type Description Format

entityId

UUID

uuid

entityRoleNames

Set of [string]

GetEventTypeListResponseDto

Field Name Required Type Description Format

eventTypes

List of EventType

GetGlobalPermissionResponseDtoList

Field Name Required Type Description Format

globalPermissionList

List of GlobalPermission

GetImportedCertificatesStatisticsResponseDto

Field Name Required Type Description Format

imported

Long

int64

issued

Long

int64

GetKeyPairModeResponseDtoList

Field Name Required Type Description Format

keyPairModeList

List of KeyPairMode

GetLanguageListResponseDto

Field Name Required Type Description Format

languages

List of Language

GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto

Field Name Required Type Description Format

users

Set of MinimalSecurityIdentityRepresentationDto

apiClients

Set of MinimalSecurityIdentityRepresentationDto

GetNotificationConfigurationsDto

Field Name Required Type Description Format

daysBeforeCertificateExpirationOptions

X

Set of [integer]

int32

GetNotificationResponseDto

Field Name Required Type Description Format

id

UUID

uuid

status

NotificationStatus

eventRootType

String

Enum: CERTIFICATE, CERT_REQUEST,

eventRootId

UUID

uuid

subscriptionId

UUID

uuid

subscriptionTargetType

SubscriptionTargetType

subscriptionTargetId

UUID

uuid

subscriptionTargetName

String

recipientType

NotificationRecipientType

recipientId

UUID

uuid

recipientName

String

channelType

ChannelType

eventType

EventType

recipientDetails

GetNotificationResponseDto_recipientDetails

templateDetails

GetNotificationResponseDto_templateDetails

totalDeliveryAttempts

Integer

int32

createdDate

Date

date-time

lastModifiedDate

Date

date-time

lastDeliveryAttemptDate

Date

date-time

version

Integer

int32

GetNotificationResponseDtoPage

Field Name Required Type Description Format

content

X

List of GetNotificationResponseDto

pageDetails

X

PageDetailsDto

GetNotificationResponseDtoRecipientDetails

Field Name Required Type Description Format

address

String

cc

Set of [string]

bcc

Set of [string]

GetNotificationResponseDtoTemplateDetails

Field Name Required Type Description Format

subject

String

body

String

attachments

List of MailAttachment

GetNotificationStatusListResponseDto

Field Name Required Type Description Format

notificationStatuses

List of NotificationStatus

GetPendingCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

policyId

UUID

uuid

endEntityId

UUID

uuid

keyPairMode

KeyPairMode

validFor

ValidFor

certRequestStatus

CertRequestStatus

keyGenParamsDto

KeyGenParamsDto

metadata

AuditedAndVersionDtoUUID

GetPendingCertReqResponseDtoPage

Field Name Required Type Description Format

content

List of GetPendingCertReqResponseDto

pageDetails

PageDetailsDto

GetPoliciesInRealmsDto

It includes the Realm Ids, needed for the search

Field Name Required Type Description Format

realmIds

X

List of [UUID]

uuid

GetPolicyPermissionResponseDtoList

Field Name Required Type Description Format

policyPermissionList

List of PolicyPermission

GetPolicyResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderDto

X

CertificateProviderDto

certificateProviderConfiguration

X

String

realmId

X

UUID

uuid

requiresManualApproval

Boolean

allowedKeyPairModes

X

Set of KeyPairMode

allowedValidForValues

X

Set of ValidFor

cryptoRestrictions

X

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

metadata

AuditedAndVersionDtoUUID

endEntityStrategy

X

EndEntityStrategy

archival

ArchivedDtoUUID

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationResponseDto

CmpConfigurationResponseDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

GetPolicyResponseDtoPage

Field Name Required Type Description Format

content

List of GetPolicyResponseDto

pageDetails

PageDetailsDto

GetRSAKeySizeResponseDtoList

Field Name Required Type Description Format

rsaKeySizeList

List of RsaKeySize

GetRaCertificateResponseDto

Field Name Required Type Description Format

id

UUID

uuid

serialNumber

String

subjectDn

String

subjectCommonName

String

issuerDn

String

issuerCommonName

String

validNotBefore

Date

date-time

validNotAfter

Date

date-time

certStatus

CertStatus

certPublicKeyAlgorithm

CryptoAlgorithm

fingerprint

String

accessiblePrivateKey

Boolean

GetRealmPermissionResponseDtoList

Field Name Required Type Description Format

realmPermissionList

List of RealmPermission

GetRealmResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

archival

X

ArchivedDtoUUID

metadata

X

AuditedAndVersionDtoUUID

GetRealmResponseDtoPage

Field Name Required Type Description Format

content

List of GetRealmResponseDto

pageDetails

PageDetailsDto

GetRecipientTypeListResponseDto

Field Name Required Type Description Format

recipientTypes

List of NotificationRecipientType

GetRevocationReasonResponseDtoList

Field Name Required Type Description Format

revocationReasonList

List of [string]

GetRoleDetailsResponseDto

Field Name Required Type Description Format

name

String

providerId

UUID

uuid

globalPermissions

Set of GlobalPermission

realmPermissions

Set of RoleEntityPermissionsDtoRealmPermission

policyPermissions

Set of RoleEntityPermissionsDtoPolicyPermission

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

GetRoleResponseDto

Field Name Required Type Description Format

name

String

globalPermissions

Set of GlobalPermission

realmPermissions

Set of RoleEntityPermissionsDtoRealmPermission

policyPermissions

Set of RoleEntityPermissionsDtoPolicyPermission

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

GetRoleResponseDtoPage

Field Name Required Type Description Format

content

List of GetRoleResponseDto

pageDetails

PageDetailsDto

GetSearchTemplateLanguageListResponseDto

Field Name Required Type Description Format

languages

X

List of SearchTemplateLanguage

GetSecurityIdentityRolesResponseDto

Field Name Required Type Description Format

roles

X

Set of GetRoleResponseDto

GetSelfSignedCertificatesStatisticsResponseDto

Field Name Required Type Description Format

selfSigned

Long

int64

nonSelfSigned

Long

int64

GetSubscriptionResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

subscriberType

X

SubscriberType

subscriberId

X

UUID

uuid

targetType

X

SubscriptionTargetType

targetId

X

UUID

uuid

notificationsConfiguration

X

NotificationsConfigurationDto

metadata

X

AuditedAndVersionDtoUUID

GetSubscriptionResponseDtoPage

Field Name Required Type Description Format

content

X

List of GetSubscriptionResponseDto

pageDetails

X

PageDetailsDto

GetSubscriptionTargetTypeListResponseDto

Field Name Required Type Description Format

targetTypes

List of SubscriptionTargetType

GetTargetsForSubscriptionRequestDto

It includes all the information about the subscription target

Field Name Required Type Description Format

targetType

X

SubscriptionTargetType

targetId

X

UUID

uuid

simpleSearchTerm

String

GetTemplateDetailsResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

eventType

X

EventType

channelType

X

ChannelType

language

X

Language

content

X

oas_any_type_not_mapped

realmId

X

UUID

uuid

metadata

X

AuditedAndVersionDtoUUID

GetTemplateResponseDtoPage

Field Name Required Type Description Format

content

X

List of GetTemplateDetailsResponseDto

pageDetails

X

PageDetailsDto

GetTrustedCasRequestDto

The options regarding which CAs will be returned

Field Name Required Type Description Format

includeRootOnly

Boolean

includeVerifyServersOnly

Boolean

GetTrustedCasResponseDto

Field Name Required Type Description Format

trustedCas

List of [string]

GetUserContactResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

userId

X

UUID

uuid

preferredLanguage

X

Language

userRecipientsDetails

X

UserContactRecipientDetailsResponseDto

implicitNotificationsConfiguration

X

ImplicitNotificationsConfigurationDto

metadata

X

AuditedAndVersionDtoUUID

GetUserDetailsResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

username

X

String

firstName

String

lastName

String

email

X

String

commonName

String

organization

String

organizationalUnit

String

country

String

enabled

Boolean

passwordLoginEnabled

Boolean

GetUserForSubscriptionResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

username

X

String

firstName

String

lastName

String

email

String

commonName

String

organization

String

organizationalUnit

String

country

String

enabled

X

Boolean

hasSubscription

X

Boolean

GetUserForSubscriptionResponseDtoPage

Field Name Required Type Description Format

content

X

List of GetUserForSubscriptionResponseDto

pageDetails

X

PageDetailsDto

GetUserResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

username

X

String

firstName

String

lastName

String

email

X

String

commonName

String

organization

String

organizationalUnit

String

country

String

enabled

Boolean

GetUserResponseDtoPage

Field Name Required Type Description Format

content

List of GetUserResponseDto

pageDetails

PageDetailsDto

GetValidForResponseDtoList

Field Name Required Type Description Format

validForList

List of ValidFor

GlobalPermission

Field Name Required Type Description Format

ImplicitNotificationsConfigurationDto

Field Name Required Type Description Format

eventTypes

X

Set of EventType

variables

NotificationsVariables

ImportCaDto

Field Name Required Type Description Format

id

UUID

uuid

fingerprint

String

isRootCa

Boolean

ImportCaRequestDto

The content of the PEM file containing the CAs to be verified

Field Name Required Type Description Format

pemFileContents

X

String

ImportCaResponseDto

Field Name Required Type Description Format

importedCaDtoList

List of ImportCaDto

ImportCertificatesRequestDto

It includes encoded certificates and the necessary metadata for it

Field Name Required Type Description Format

policyId

X

UUID

uuid

discoveredCertsInPem

X

List of ImportPemCertificatesDto

ImportCertificatesResponseDto

Field Name Required Type Description Format

hashAlgorithmId

String

successful

List of SuccessfulImportCertRequestResponseDto

failed

List of FailedImportCertRequestResponseDto

ImportPemCertificatesDto

Field Name Required Type Description Format

server

String

port

Integer

int32

pemCertificates

X

String

KeyGenParamsDto

Field Name Required Type Description Format

cryptoAlgorithm

X

CryptoAlgorithm

keySize

RsaKeySize

exponent

Integer

namedCurve

String

edDsaCurve

EdDsaCurve

KeyPairMode

Field Name Required Type Description Format

KeystoreFileDto

Field Name Required Type Description Format

base64EncodedPkcs12

String

base64EncodedJceKs

String

fileName

String

filePassword

String

Language

Field Name Required Type Description Format

MailAttachment

Field Name Required Type Description Format

fileName

String

fileData

String

mimeType

String

MarkCertificatesAsRevokedRequestDto

It includes all the properties needed to mark the desired Certificates as revoked

Field Name Required Type Description Format

certificatesIds

X

List of [UUID]

uuid

MinimalSecurityIdentityRepresentationDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

MscaTemplatesResponseDto

Field Name Required Type Description Format

templateNames

List of [string]

NotificationEmailContent

Field Name Required Type Description Format

subject

String

body

String

attachments

List of MailAttachment

NotificationEmailRecipientDetails

Field Name Required Type Description Format

address

String

cc

Set of [string]

bcc

Set of [string]

NotificationRecipientType

Field Name Required Type Description Format

NotificationSearchRequestDto

It includes all the properties that can be searched with

Field Name Required Type Description Format

simpleSearchTerm

String

recipientType

NotificationRecipientType

targetType

SubscriptionTargetType

notificationStatus

NotificationStatus

NotificationStatus

Field Name Required Type Description Format

NotificationsConfigurationDto

Field Name Required Type Description Format

eventTypes

X

Set of EventType

variables

X

NotificationsVariables

NotificationsVariables

Field Name Required Type Description Format

daysBeforeCertificateExpiration

Set of [integer]

int32

OcspCertStatus

Field Name Required Type Description Format

OcspStatusCheckDto

Field Name Required Type Description Format

ocspCertStatus

X

OcspCertStatus

OrderCertificateResponseDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

certificateId

UUID

uuid

errorOccurred

Boolean

OrderMultipleCertificatesResponseDto

Field Name Required Type Description Format

base64EncodedZippedArtifacts

String

artifactsPassword

String

successfulCertificateOrders

List of SuccessfulCertificateOrderResultDto

failedCertificateOrders

List of FailedCertificateOrderResultDto

PageDetailsDto

Field Name Required Type Description Format

totalElements

X

Long

int64

pageNumber

X

Integer

int32

pageSize

X

Integer

int32

numberOfElementsInPage

X

Integer

int32

ParsePkcs10ResponseDto

Field Name Required Type Description Format

keyPairMode

X

KeyPairMode

keyGenParamsDto

X

KeyGenParamsDto

pkcs10ReqBase64

String

Pkcs10Dto

It includes all the properties necessary for parsing

Field Name Required Type Description Format

base64EncodedPkcs10

X

String

PolicyPermission

Field Name Required Type Description Format

PolicySearchRequestDto

It includes all the properties that can be used for the search

Field Name Required Type Description Format

realmId

X

UUID

uuid

simpleSearchTerm

String

policyIds

Set of [UUID]

uuid

archived

Boolean

PolicyWithAllowedImportSearchRequestDto

It includes all the properties that can be used for the search

Field Name Required Type Description Format

realmId

X

UUID

uuid

simpleSearchTerm

String

PublicCAsProductType

Field Name Required Type Description Format

PublicCAsProductValidationType

Field Name Required Type Description Format

PublicCAsProductsResponseDto

Field Name Required Type Description Format

products

List of PublicCasProductResponseDto

PublicCasProductResponseDto

Field Name Required Type Description Format

number

String

monthValidity

Integer

int32

name

String

type

PublicCAsProductType

validationType

PublicCAsProductValidationType

signatureAlgorithms

List of [string]

RaCertificatePemDto

Field Name Required Type Description Format

id

Long

int64

fileName

String

pemCertificate

String

RawPemCertificateDto

PEM Encoded Certificate

Field Name Required Type Description Format

pemCertificate

X

String

RealmPermission

Field Name Required Type Description Format

RealmSearchRequestDto

It includes all the properties that can be used for searching

Field Name Required Type Description Format

simpleSearchTerm

String

realmIds

Set of [UUID]

uuid

archived

Boolean

RecipientDetailsResponseDto

Field Name Required Type Description Format

emailRecipientData

EmailRecipientDataResponseDto

ResetApiClientSecretResponse

Field Name Required Type Description Format

secret

String

ResetEndEntityPasswordResponseDto

Field Name Required Type Description Format

password

String

metadata

AuditedAndVersionDtoUUID

RevocationReason

Field Name Required Type Description Format

RevokeCertificateDto

Field Name Required Type Description Format

id

X

UUID

uuid

revocationReason

RevocationReason

RevokeCertificateRequestDto

It includes all the properties needed to revoke the desired Certificates

Field Name Required Type Description Format

revokeCertificateDtos

X

List of RevokeCertificateDto

RevokeCertificateResponseDto

Field Name Required Type Description Format

certificateRevocationResult

X

CertificateRevocationResult

certificateRevocationReason

RevocationReason

RevokeMultipleCertificateResponseDto

Field Name Required Type Description Format

successfulRevocation

Boolean

RevokeRaCertificateResponseDto

Field Name Required Type Description Format

certificateRevocationResult

X

CertificateRevocationResult

RoleEntityPermissionsDtoCertRequestPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of CertRequestPermission

RoleEntityPermissionsDtoCertificatePermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of CertificatePermission

RoleEntityPermissionsDtoEndEntityPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of EndEntityPermission

RoleEntityPermissionsDtoPolicyPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of PolicyPermission

RoleEntityPermissionsDtoRealmPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of RealmPermission

RsaKeyGenParams

Field Name Required Type Description Format

keySize

X

RsaKeySize

exponent

Integer

cryptoAlgorithm

X

CryptoAlgorithm

RsaKeySize

Field Name Required Type Description Format

ScepDecryptDataRequestDto

Field Name Required Type Description Format

data

X

byte[]

byte

policyId

X

UUID

uuid

ScepDecryptDataResponseDto

Field Name Required Type Description Format

data

X

byte[]

byte

ScepSignDataResponseDto

Field Name Required Type Description Format

signature

X

byte[]

byte

ScepSignRequestDto

Field Name Required Type Description Format

data

X

byte[]

byte

policyId

X

UUID

uuid

encodedIssuer

byte[]

byte

algorithmID

X

byte[]

byte

SearchAllRequestDto

It includes all the properties that can be used for the search

Field Name Required Type Description Format

simpleSearchTerm

String

archived

Boolean

SearchCaResponseDto

Field Name Required Type Description Format

id

UUID

uuid

validNotBefore

Date

date-time

validNotAfter

Date

date-time

fingerprint

String

issuerCaId

UUID

uuid

rootCa

Boolean

issuerDn

String

subjectDn

String

verifyServers

Boolean

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

SearchCaResponseDtoPage

Field Name Required Type Description Format

content

List of SearchCaResponseDto

pageDetails

PageDetailsDto

SearchConfigurationRequestDto

It includes filters that will be used to search for the desired resources

Field Name Required Type Description Format

keys

List of SettingsKey

SearchRoleRequestDto

It includes filters that will be used to search for the desired resources

Field Name Required Type Description Format

simpleSearchTerm

String

SearchTemplateLanguage

Field Name Required Type Description Format

SecurityIdentityType

Field Name Required Type Description Format

SettingsKey

Field Name Required Type Description Format

SignDataRequestDto

Field Name Required Type Description Format

data

X

byte[]

byte

algorithmAID

X

byte[]

byte

policyId

X

UUID

uuid

encodedIssuer

byte[]

byte

SignDataResponseDto

Field Name Required Type Description Format

signature

X

byte[]

byte

SignerConfigurationDto

Field Name Required Type Description Format

signerConfiguration

X

String

cmpSignatureAlgorithm

X

CmpSignatureAlgorithm

SubscriberType

Field Name Required Type Description Format

SubscriptionTargetType

Field Name Required Type Description Format

SuccessfulCertificateOrderResultDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

certificateId

UUID

uuid

SuccessfulImportCertRequestResponseDto

Field Name Required Type Description Format

certificateFingerprint

String

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

TemplateSearchRequestDto

It includes all the properties that can be searched with

Field Name Required Type Description Format

realmId

X

UUID

uuid

eventType

EventType

language

SearchTemplateLanguage

channelType

ChannelType

UpdateApiClientRequest

It includes all the properties needed to update an Api Client

Field Name Required Type Description Format

name

X

String

The name that the resource will be updated with. The property isn't required but you must define at least one of the name and defaultPolicyId properties

defaultPolicyId

UUID

The defaultPolicyId that the resource will be updated with. It must be of Type UUID. The property isn't required but you must define at least one of the name and defaultPolicyId properties

uuid

UpdateApiClientResponse

Field Name Required Type Description Format

id

X

UUID

uuid

secret

X

String

UpdateCaRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

verifyServers

Boolean

version

Integer

int32

UpdateCaResponseDto

Field Name Required Type Description Format

id

UUID

uuid

validNotBefore

Date

date-time

validNotAfter

Date

date-time

fingerprint

String

issuerCaId

UUID

uuid

rootCa

Boolean

issuerDn

String

subjectDn

String

verifyServers

Boolean

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

UpdateCertificateProviderRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

X

String

configuration

X

oas_any_type_not_mapped

version

Integer

int32

UpdateCertificateProviderResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

configuration

X

oas_any_type_not_mapped

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

UpdateConfigurationBatchRequestDto

It includes all the necessary values to update a batch of existing Configurations

Field Name Required Type Description Format

updateConfigurationRequestDtoList

List of UpdateConfigurationRequestDto

UpdateConfigurationBatchResponseDto

Field Name Required Type Description Format

updateConfigurationResponseDtoList

List of UpdateConfigurationResponseDto

UpdateConfigurationRequestDto

It includes all the necessary values to update an existing Configuration

Field Name Required Type Description Format

settingsKey

X

SettingsKey

configuration

X

String

version

Integer

int32

UpdateConfigurationResponseDto

Field Name Required Type Description Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

UpdateContactRequestDto

It includes all the properties needed to update a Contact

Field Name Required Type Description Format

name

X

String

preferredLanguage

X

Language

recipientDetails

ContactRecipientDetailsRequestDto

description

String

version

Integer

int32

UpdatePolicyRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

X

String

certificateProviderId

X

UUID

uuid

certificateProviderConfiguration

X

String

allowedKeyPairModes

X

Set of KeyPairMode

allowedValidForValues

X

Set of ValidFor

cryptoRestrictions

X

CryptoRestrictionsDto

version

Integer

int32

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

endEntityRules

Set of EndEntityRule

cmpEnabled

Boolean

cmpConfigurationRequestDto

CmpConfigurationRequestDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

UpdatePolicyResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

certificateProviderDto

CertificateProviderDto

certificateProviderConfiguration

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of KeyPairMode

allowedValidForValues

Set of ValidFor

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

endEntityStrategy

X

EndEntityStrategy

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationResponseDto

CmpConfigurationResponseDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

UpdateRealmRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

X

String

version

Integer

int32

UpdateRealmResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

archival

X

ArchivedDtoUUID

metadata

X

AuditedAndVersionDtoUUID

UpdateRoleRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

X

String

globalPermissions

Set of GlobalPermission

realmPermissions

X

Set of RoleEntityPermissionsDtoRealmPermission

policyPermissions

X

Set of RoleEntityPermissionsDtoPolicyPermission

endEntityPermissions

X

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

X

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

X

Set of RoleEntityPermissionsDtoCertificatePermission

UpdateRoleResponseDto

Field Name Required Type Description Format

name

String

globalPermissions

Set of GlobalPermission

realmPermissions

Set of RoleEntityPermissionsDtoRealmPermission

policyPermissions

Set of RoleEntityPermissionsDtoPolicyPermission

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

UpdateSecurityIdentityRolesBatchRequestDto

It includes all the roles to be assigned to API clients

Field Name Required Type Description Format

ids

X

Set of [UUID]

uuid

roles

X

Set of [string]

UpdateSecurityIdentityRolesBatchResponseDto

Field Name Required Type Description Format

successful

Set of [UUID]

uuid

failed

Map of ApiError

UpdateSecurityIdentityRolesRequestDto

It includes all the roles to be associated with API client

Field Name Required Type Description Format

roles

X

Set of [string]

UpdateSubscriptionRequestDto

It includes all the properties needed to update a subscription

Field Name Required Type Description Format

notificationsConfiguration

NotificationsConfigurationDto

version

Integer

int32

UpdateUserCertificateDetailsRequestDto

It includes the new user details

Field Name Required Type Description Format

organization

String

organizationalUnit

String

country

String

commonName

X

String

UpdateUserContactRequestDto

It includes all the properties needed to update the Contact of a User

Field Name Required Type Description Format

preferredLanguage

X

Language

userContactRecipientDetails

UserContactRecipientDetailsRequestDto

implicitNotificationsConfiguration

X

ImplicitNotificationsConfigurationDto

version

Integer

int32

UpdateUserRaCertificateDto

Field Name Required Type Description Format

id

UUID

uuid

certFromProviderReference

String

certificateId

UUID

uuid

base64EncodedPkcs12

String

base64EncodedJceKs

String

fileName

String

filePassword

String

accessiblePrivateKey

Boolean

UserContactRecipientDetailsRequestDto

Field Name Required Type Description Format

emailRecipientData

EmailUserRecipientDataRequestDto

UserContactRecipientDetailsResponseDto

Field Name Required Type Description Format

emailRecipientData

X

EmailRecipientDataResponseDto

UserListDto

It includes the list of provider id's associated with the users that a password update email will be sent.

Field Name Required Type Description Format

userProviderIdList

List of [UUID]

uuid

UserResponseDto

Field Name Required Type Description Format

id

UUID

uuid

securityIdentityType

SecurityIdentityType

certRequestAction

CertRequestAction

UserSearchRequestDto

It includes all the properties that can be used for searching

Field Name Required Type Description Format

simpleSearchTerm

String

ValidFor

Field Name Required Type Description Format

VerifyImportCaDto

Field Name Required Type Description Format

isRootCa

Boolean

rootFingerprint

String

VerifyImportCaResponseDto

Field Name Required Type Description Format

verifiedImportCaDtoList

List of VerifyImportCaDto

VerifyImportCertificatesRequestDto

It includes encoded certificates and the necessary metadata for it

Field Name Required Type Description Format

policyId

X

UUID

uuid

discoveredCertsInPem

List of ImportPemCertificatesDto

VerifyImportCertificatesResponseDto

Field Name Required Type Description Format

totalCertificatesToImport

Long

int64

VerifyTokenRequestDto

It includes the Token

Field Name Required Type Description Format

token

String

ZippedCertsBatchDto

Field Name Required Type Description Format

zipFileInBase64

String

filePassword

String

batchCertificateCreationErrorResponseDtoList

List of BatchCertificateCreationErrorResponseDto

ZippedFileDto

Field Name Required Type Description Format

zipFileInBase64

String