For the latest version, please use Certificate Lifecycle Manager 5.0.2!

API Documentation

1. Endpoints

1.1. Admin

1.1.1. archiveEntitiesBatch

POST /api/v1/admin/batch-archive

Batch Archive resources from an Entity

1.1.1.1. Parameters
1.1.1.1.1. Body Parameter
Name Description Required Default Pattern

ArchiveAllEntitiesRequestDto

Section 2.5

X
1.1.1.1.2. 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
1.1.1.2. Return Type

-

1.1.1.3. Content Type

  • application/json

1.1.1.4. Responses
Table 1. http response codes
Code Message Datatype

204

Archived the requested resources of an Entity

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.1.2. archiveSingleEntity

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

Archive a resource from an Entity

1.1.2.1. Parameters
1.1.2.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.1.2.1.2. 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
1.1.2.2. Return Type

-

1.1.2.3. Content Type

  • application/json

1.1.2.4. Responses
Table 2. http response codes
Code Message Datatype

204

Archived the requested resource of an Entity

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.1.3. deleteArchived

DELETE /api/v1/admin/archived

Delete archived resources from an Entity

1.1.3.1. Parameters
1.1.3.1.1. 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
1.1.3.2. Return Type

-

1.1.3.3. Content Type

  • application/json

1.1.3.4. Responses
Table 3. http response codes
Code Message Datatype

204

Deleted the archived resource of an Entity

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.1.4. deleteArchivedEntities

POST /api/v1/admin/batch-delete

Batch Delete archived resources from an Entity

1.1.4.1. Parameters
1.1.4.1.1. Body Parameter
Name Description Required Default Pattern

DeleteArchivedEntitiesRequestDto

Section 2.89

X
1.1.4.1.2. Query Parameters
Name Description Required Default Pattern

entity

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

X

null
1.1.4.2. Return Type

-

1.1.4.3. Content Type

  • application/json

1.1.4.4. Responses
Table 4. http response codes
Code Message Datatype

204

Deleted the requested resources

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.2. ApiClient

1.2.1. createNewApiClient

POST /api/v1/api-clients/

Create an Api Client

1.2.1.1. Parameters
1.2.1.1.1. Body Parameter
Name Description Required Default Pattern

CreateNewApiClientRequest

Section 2.66

X
1.2.1.2. Return Type

Section 2.67

1.2.1.3. Content Type

  • application/json

1.2.1.4. Responses
Table 5. http response codes
Code Message Datatype

201

Api Client created

CreateNewApiClientResponse[Section 2.67]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.2.2. deleteApiClient

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

Delete Api Client

1.2.2.1. Parameters
1.2.2.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired resource

X

null
1.2.2.2. Return Type

-

1.2.2.3. Content Type

  • application/json

1.2.2.4. Responses
Table 6. http response codes
Code Message Datatype

204

Api Client Deleted

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.2.3. getApiClientDetails

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

Get Api Client

1.2.3.1. Parameters
1.2.3.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired resource

X

null
1.2.3.2. Return Type

Section 2.120

1.2.3.3. Content Type

  • application/json

1.2.3.4. Responses
Table 7. http response codes
Code Message Datatype

200

Found Api Client

GetApiClientDetailsResponse[Section 2.120]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.2.4. resetApiClientSecret

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

Reset Api Client’s secret

1.2.4.1. Parameters
1.2.4.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired resource

X

null
1.2.4.2. Return Type

Section 2.229

1.2.4.3. Content Type

  • application/json

1.2.4.4. Responses
Table 8. http response codes
Code Message Datatype

200

Api Client's secret was reset

ResetApiClientSecretResponse[Section 2.229]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.2.5. searchApiClients

POST /api/v1/api-clients/search

Search Api Clients

1.2.5.1. Parameters
1.2.5.1.1. Body Parameter
Name Description Required Default Pattern

ApiClientSearchRequestDto

Section 2.1

X
1.2.5.1.2. 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
1.2.5.2. Return Type

Section 2.122

1.2.5.3. Content Type

  • application/json

1.2.5.4. Responses
Table 9. http response codes
Code Message Datatype

200

Found Api Clients

GetApiClientResponseDtoPage[Section 2.122]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.2.6. updateApiClient

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

Update an Api Client

1.2.6.1. Parameters
1.2.6.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Api Client

X

null
1.2.6.1.2. Body Parameter
Name Description Required Default Pattern

UpdateApiClientRequest

Section 2.260

X
1.2.6.2. Return Type

Section 2.261

1.2.6.3. Content Type

  • application/json

1.2.6.4. Responses
Table 10. http response codes
Code Message Datatype

200

Api Client updated

UpdateApiClientResponse[Section 2.261]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.3. AsyncCertificate

1.3.1. orderCertificate

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

Order a Certificate by Certificate Request

1.3.1.1. Parameters
1.3.1.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.3.1.2. Return Type

Section 2.214

1.3.1.3. Content Type

  • application/json

1.3.1.4. Responses
Table 11. http response codes
Code Message Datatype

201

Certificate Ordered

OrderCertificateResponseDto[Section 2.214]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.3.2. orderMultipleCertificates

POST /api/v2/certificates/cert-requests

Order Multiple Certificates by Certificate Requests

1.3.2.1. Parameters
1.3.2.1.1. Body Parameter
Name Description Required Default Pattern

UUID

[UUID]

X
1.3.2.1.2. Query Parameters
Name Description Required Default Pattern

omitArtifacts

Decides whether to omit artifacts of the created certificates or not

-

false
1.3.2.2. Return Type

Section 2.215

1.3.2.3. Content Type

  • application/json

1.3.2.4. Responses
Table 12. http response codes
Code Message Datatype

201

Certificates ordered

OrderMultipleCertificatesResponseDto[Section 2.215]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.4. AuthenticatedPrincipal

1.4.1. getAuthenticatedPrincipal

GET /api/v1/authenticated-principal/

Get Authenticated Principal

1.4.1.1. Parameters
1.4.1.2. Return Type

Section 2.9

1.4.1.3. Content Type

  • application/json

1.4.1.4. Responses
Table 13. http response codes
Code Message Datatype

200

Authenticated Principal Found

AuthenticatedPrincipalResponseDto[Section 2.9]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.4.2. getAuthenticatedPrincipalPermissions

GET /api/v1/authenticated-principal/permissions

Get Authenticated Principal concatenated permissions

1.4.2.1. Parameters
1.4.2.2. Return Type

Section 2.125

1.4.2.3. Content Type

  • application/json

1.4.2.4. Responses
Table 14. http response codes
Code Message Datatype

200

Authenticated Principal Permissions Found

GetAuthenticatedPrincipalPermissionsResponseDto[Section 2.125]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.5. Ca

1.5.1. downloadCaCertificate

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

Download CA Certificate

1.5.1.1. Parameters
1.5.1.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the requested CA Certificate

X

null
1.5.1.2. Return Type

Section 2.13

1.5.1.3. Content Type

  • application/json

1.5.1.4. Responses
Table 15. http response codes
Code Message Datatype

200

CA Certificate Downloaded

CaCertificateDataPemDto[Section 2.13]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.5.2. getCa

GET /api/v1/cas/{id}

Get CA by Id

1.5.2.1. Parameters
1.5.2.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the requested Ca

X

null
1.5.2.2. Return Type

Section 2.126

1.5.2.3. Content Type

  • application/json

1.5.2.4. Responses
Table 16. http response codes
Code Message Datatype

200

Found CA

GetCaResponseDto[Section 2.126]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.5.3. getTrustedCas

POST /api/v1/cas/get-trusted

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

1.5.3.1. Parameters
1.5.3.1.1. Body Parameter
Name Description Required Default Pattern

GetTrustedCasRequestDto

Section 2.190

X
1.5.3.2. Return Type

Section 2.191

1.5.3.3. Content Type

  • application/json

1.5.3.4. Responses
Table 17. http response codes
Code Message Datatype

200

Trusted CAs acquired

GetTrustedCasResponseDto[Section 2.191]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.5.4. importCaCertificates

POST /api/v1/cas/import

Import CA Certificate(s) from pem file content

1.5.4.1. Parameters
1.5.4.1.1. Body Parameter
Name Description Required Default Pattern

ImportCaRequestDto

Section 2.198

X
1.5.4.2. Return Type

Section 2.199

1.5.4.3. Content Type

  • application/json

1.5.4.4. Responses
Table 18. http response codes
Code Message Datatype

201

CA Certificate(s) Imported

ImportCaResponseDto[Section 2.199]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.5.5. searchCas

POST /api/v1/cas/search

Search CA

1.5.5.1. Parameters
1.5.5.1.1. Body Parameter
Name Description Required Default Pattern

CaSearchRequestDto

Section 2.15

X
1.5.5.1.2. 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
1.5.5.2. Return Type

Section 2.250

1.5.5.3. Content Type

  • application/json

1.5.5.4. Responses
Table 19. http response codes
Code Message Datatype

200

Found CA

SearchCaResponseDtoPage[Section 2.250]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.5.6. updateCa

PATCH /api/v1/cas/{id}

Update a CA

1.5.6.1. Parameters
1.5.6.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the CA that will be updated

X

null
1.5.6.1.2. Body Parameter
Name Description Required Default Pattern

UpdateCaRequestDto

Section 2.262

X
1.5.6.2. Return Type

Section 2.263

1.5.6.3. Content Type

  • application/json

1.5.6.4. Responses
Table 20. http response codes
Code Message Datatype

200

CA Updated

UpdateCaResponseDto[Section 2.263]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.5.7. verifyCaCertificates

POST /api/v1/cas/import/verify

Verify CA Certificate(s) from PEM file content

1.5.7.1. Parameters
1.5.7.1.1. Body Parameter
Name Description Required Default Pattern

ImportCaRequestDto

Section 2.198

X
1.5.7.2. Return Type

Section 2.288

1.5.7.3. Content Type

  • application/json

1.5.7.4. Responses
Table 21. http response codes
Code Message Datatype

200

CA Certificate(s) Verified

VerifyImportCaResponseDto[Section 2.288]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6. CertRequest

1.6.1. approveCertRequest

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

Approve a Certificate Request

1.6.1.1. Parameters
1.6.1.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
1.6.1.2. Return Type

Section 2.4

1.6.1.3. Content Type

  • application/json

1.6.1.4. Responses
Table 22. http response codes
Code Message Datatype

200

Certificate Request Approved

ApproveCertReqResponseDto[Section 2.4]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.2. createCertRequest

POST /api/v1/cert-requests/

Create a Certificate Request

1.6.2.1. Parameters
1.6.2.1.1. Body Parameter
Name Description Required Default Pattern

CreateCertReqRequestDto

Section 2.50

X
1.6.2.2. Return Type

Section 2.51

1.6.2.3. Content Type

  • application/json

1.6.2.4. Responses
Table 23. http response codes
Code Message Datatype

201

Certificate Request Created

CreateCertReqResponseDto[Section 2.51]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.3. createMultipleCertRequest

POST /api/v1/cert-requests/multiple

Create a Certificate Request for multiple End Entities

1.6.3.1. Parameters
1.6.3.1.1. Body Parameter
Name Description Required Default Pattern

CreateMultipleCertReqRequestDto

Section 2.63

X
1.6.3.2. Return Type

Section 2.64

1.6.3.3. Content Type

  • application/json

1.6.3.4. Responses
Table 24. http response codes
Code Message Datatype

201

Certificate Request Created

CreateMultipleCertReqResponseDto[Section 2.64]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.4. declineCertRequest

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

Decline a Certificate Request

1.6.4.1. Parameters
1.6.4.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
1.6.4.2. Return Type

Section 2.88

1.6.4.3. Content Type

  • application/json

1.6.4.4. Responses
Table 25. http response codes
Code Message Datatype

200

Certificate Request Declined

DeclineCertReqResponseDto[Section 2.88]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.5. examinePkcs10Request

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

Examine PKCS10 request against End Entity and Policy

1.6.5.1. Parameters
1.6.5.1.1. Body Parameter
Name Description Required Default Pattern

ExaminePkcs10RequestRequestDto

Section 2.110

X
1.6.5.2. Return Type

Section 2.111

1.6.5.3. Content Type

  • application/json

1.6.5.4. Responses
Table 26. http response codes
Code Message Datatype

200

Examination completed

ExaminePkcs10RequestResponseDto[Section 2.111]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.6. getCertRequest

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

Get a Certificate Request

1.6.6.1. Parameters
1.6.6.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
1.6.6.2. Return Type

Section 2.128

1.6.6.3. Content Type

  • application/json

1.6.6.4. Responses
Table 27. http response codes
Code Message Datatype

200

Certificate Request Found

GetCertReqResponseDto[Section 2.128]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.7. getCertRequestAdditionalData

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

Get Certificate Request additional data

1.6.7.1. Parameters
1.6.7.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the Certificate Request

X

null
1.6.7.2. Return Type

Section 2.130

1.6.7.3. Content Type

  • application/json

1.6.7.4. Responses
Table 28. http response codes
Code Message Datatype

200

Certificate Request Found

GetCertRequestAdditionalDataResponseDto[Section 2.130]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.8. getCertRequestByPkcs10AndEndEntity

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

Get Certificate Request by End Entity and PKCS10

1.6.8.1. Parameters
1.6.8.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.6.8.1.2. Body Parameter
Name Description Required Default Pattern

CertReqSearchByPkcs10

Section 2.18

X
1.6.8.2. Return Type

Section 2.128

1.6.8.3. Content Type

  • application/json

1.6.8.4. Responses
Table 29. http response codes
Code Message Datatype

200

Certificate Request found

GetCertReqResponseDto[Section 2.128]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.9. getMostRecentPendingCertificates

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

Get pending Certificate Requests of a specific Realm

1.6.9.1. Parameters
1.6.9.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.6.9.1.2. Query Parameters
Name Description Required Default Pattern

size

The limit of the requested pending Certificate Requests

X

null
1.6.9.2. Return Type

Section 2.174

1.6.9.3. Content Type

  • application/json

1.6.9.4. Responses
Table 30. http response codes
Code Message Datatype

200

Pending Certificate Requests of Realm Found

GetPendingCertReqResponseDtoPage[Section 2.174]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.10. getNameOfRolesWithCertRequestAccess

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

Get role names of respective certificate request

1.6.10.1. Parameters
1.6.10.1.1. 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
1.6.10.2. Return Type

Section 2.166

1.6.10.3. Content Type

  • application/json

1.6.10.4. Responses
Table 31. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[Section 2.166]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.11. importCertificates

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

Import certificates

1.6.11.1. Parameters
1.6.11.1.1. Body Parameter
Name Description Required Default Pattern

ImportCertificatesRequestDto

Section 2.200

X
1.6.11.2. Return Type

Section 2.201

1.6.11.3. Content Type

  • application/json

1.6.11.4. Responses
Table 32. http response codes
Code Message Datatype

201

Certificates imported

ImportCertificatesResponseDto[Section 2.201]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.12. resendEmailVerificationForCertRequest

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

Resend E-Mail verification for a Certificate Request

1.6.12.1. Parameters
1.6.12.1.1. 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
1.6.12.1.2. Body Parameter
Name Description Required Default Pattern

EmailDto

Section 2.94

X
1.6.12.2. Return Type

-

1.6.12.3. Content Type

  • application/json

1.6.12.4. Responses
Table 33. http response codes
Code Message Datatype

204

E-Mail verification sent

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.13. searchAllCertRequests

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

Search all Certificate Requests

1.6.13.1. Parameters
1.6.13.1.1. Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

Section 2.248

X
1.6.13.1.2. 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
1.6.13.2. Return Type

Section 2.129

1.6.13.3. Content Type

  • application/json

1.6.13.4. Responses
Table 34. http response codes
Code Message Datatype

200

Certificate Requests Found

GetCertReqResponseDtoPage[Section 2.129]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.14. searchCertRequests

POST /api/v1/cert-requests/search

Search Certificate Requests

1.6.14.1. Parameters
1.6.14.1.1. Body Parameter
Name Description Required Default Pattern

CertReqSearchRequestDto

Section 2.19

X
1.6.14.1.2. 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
1.6.14.2. Return Type

Section 2.129

1.6.14.3. Content Type

  • application/json

1.6.14.4. Responses
Table 35. http response codes
Code Message Datatype

200

Certificate Requests Found

GetCertReqResponseDtoPage[Section 2.129]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.6.15. verifyImportCertificates

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

Verify import certificates request

1.6.15.1. Parameters
1.6.15.1.1. Body Parameter
Name Description Required Default Pattern

VerifyImportCertificatesRequestDto

Section 2.289

X
1.6.15.2. Return Type

Section 2.290

1.6.15.3. Content Type

  • application/json

1.6.15.4. Responses
Table 36. http response codes
Code Message Datatype

200

Import certificates request verified

VerifyImportCertificatesResponseDto[Section 2.290]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7. Certificate

1.7.1. createCertificate

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

Create Certificate by Certificate Request

1.7.1.1. Parameters
1.7.1.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.7.1.2. Return Type

Section 2.54

1.7.1.3. Content Type

  • application/json

1.7.1.4. Responses
Table 37. http response codes
Code Message Datatype

201

Certificate Created

CreateCertificateResponseDto[Section 2.54]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.2. createMultipleCertificates

POST /api/v1/certificates/cert-requests

Create Multiple Certificates by Certificate Requests

1.7.2.1. Parameters
1.7.2.1.1. Body Parameter
Name Description Required Default Pattern

UUID

[UUID]

X
1.7.2.1.2. Query Parameters
Name Description Required Default Pattern

omitArtifacts

Decides whether to omit artifacts of the created certificates or not

-

false
1.7.2.2. Return Type

Section 2.65

1.7.2.3. Content Type

  • application/json

1.7.2.4. Responses
Table 38. http response codes
Code Message Datatype

201

Certificates Created

CreateMultipleCertificateFromCertRequestsResponseDto[Section 2.65]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.3. downloadCaChainForPolicy

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

Download the CA chain for a specified Policy

1.7.3.1. Parameters
1.7.3.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the Policy for which the CA chain is requested

X

null
1.7.3.2. Return Type

Section 2.14

1.7.3.3. Content Type

  • application/json

1.7.3.4. Responses
Table 39. http response codes
Code Message Datatype

200

Policy CA chain downloaded successfully

CaCertificatePemDto[Section 2.14]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.4. downloadCertificate

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

Download Certificate

1.7.4.1. Parameters
1.7.4.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.4.2. Return Type

Section 2.25

1.7.4.3. Content Type

  • application/json

1.7.4.4. Responses
Table 40. http response codes
Code Message Datatype

200

Certificate Downloaded

CertificatePemDto[Section 2.25]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.5. downloadCertificateChain

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

Download Chain of Certificate

1.7.5.1. Parameters
1.7.5.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.5.1.2. Query Parameters
Name Description Required Default Pattern

casFirst

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

X

null
1.7.5.2. Return Type

Section 2.25

1.7.5.3. Content Type

  • application/json

1.7.5.4. Responses
Table 41. http response codes
Code Message Datatype

200

Certificate Chain Downloaded

CertificatePemDto[Section 2.25]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.6. downloadCertificatePrivateKey

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

Download private key of the Certificate

1.7.6.1. Parameters
1.7.6.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.6.2. Return Type

Section 2.28

1.7.6.3. Content Type

  • application/json

1.7.6.4. Responses
Table 42. http response codes
Code Message Datatype

200

Certificate private key downloaded

CertificatePrivateKeyPemDto[Section 2.28]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.7. downloadCertificatesAsZip

GET /api/v1/certificates/batch-download

Batch Download Certificates

1.7.7.1. Parameters
1.7.7.1.1. Query Parameters
Name Description Required Default Pattern

ids

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

X

null
1.7.7.2. Return Type

Section 2.293

1.7.7.3. Content Type

  • application/json

1.7.7.4. Responses
Table 43. http response codes
Code Message Datatype

200

Certificates Downloaded

ZippedFileDto[Section 2.293]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.8. downloadCrl

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

Download crl for a Certificate

1.7.8.1. Parameters
1.7.8.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.8.2. Return Type

Section 2.82

1.7.8.3. Content Type

  • application/json

1.7.8.4. Responses
Table 44. http response codes
Code Message Datatype

200

Certificate's crl downloaded

CrlDto[Section 2.82]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.9. emailCertificate

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

Send Certificate E-Mail

1.7.9.1. Parameters
1.7.9.1.1. 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
1.7.9.2. Return Type

-

1.7.9.3. Content Type

  • application/json

1.7.9.4. Responses
Table 45. http response codes
Code Message Datatype

204

Certificate E-Mail sent

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.10. getAuditEventsForCertificate

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

Get Audit Events for a Certificate

1.7.10.1. Parameters
1.7.10.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.10.2. Return Type

Section 2.124

1.7.10.3. Content Type

  • application/json

1.7.10.4. Responses
Table 46. http response codes
Code Message Datatype

200

Certificate's Audit Events Found

GetAuditEventResponseDtoList[Section 2.124]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.11. getCertificateByFingerprint

GET /api/v1/certificates/by-fingerprint

Get Certificate by fingerprint

1.7.11.1. Parameters
1.7.11.1.1. Query Parameters
Name Description Required Default Pattern

fingerprint

The fingerprint used to get the desired Certificate

X

null
1.7.11.2. Return Type

Section 2.143

1.7.11.3. Content Type

  • application/json

1.7.11.4. Responses
Table 47. http response codes
Code Message Datatype

200

Found Certificate

GetCertificateResponseDto[Section 2.143]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.12. getCertificateByIssuerDnBinAndSerialNumber

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

Get Certificate by issuer dn bin and serial number

1.7.12.1. Parameters
1.7.12.1.1. Body Parameter
Name Description Required Default Pattern

GetCertByIssuerDnBinAndSnDto

Section 2.127

X
1.7.12.2. Return Type

Section 2.143

1.7.12.3. Content Type

  • application/json

1.7.12.4. Responses
Table 48. http response codes
Code Message Datatype

200

Found Certificate

GetCertificateResponseDto[Section 2.143]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.13. getCertificateDetails

GET /api/v1/certificates/{id}

Get Certificate

1.7.13.1. Parameters
1.7.13.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.13.2. Return Type

Section 2.143

1.7.13.3. Content Type

  • application/json

1.7.13.4. Responses
Table 49. http response codes
Code Message Datatype

200

Found Certificate

GetCertificateResponseDto[Section 2.143]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.14. getCertificatesByRealmId

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

Get available Certificates in Realm

1.7.14.1. Parameters
1.7.14.1.1. 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
1.7.14.1.2. 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
1.7.14.2. Return Type

Section 2.144

1.7.14.3. Content Type

  • application/json

1.7.14.4. Responses
Table 50. http response codes
Code Message Datatype

200

Found Certificates

GetCertificateResponseDtoPage[Section 2.144]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.15. getNameOfRolesWithCertificateAccess

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

Get role names of respective certificate

1.7.15.1. Parameters
1.7.15.1.1. 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
1.7.15.2. Return Type

Section 2.166

1.7.15.3. Content Type

  • application/json

1.7.15.4. Responses
Table 51. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[Section 2.166]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.16. getOcspStatus

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

Get the OCSP status of a Certificate

1.7.16.1. Parameters
1.7.16.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.16.2. Return Type

Section 2.213

1.7.16.3. Content Type

  • application/json

1.7.16.4. Responses
Table 52. http response codes
Code Message Datatype

200

OCSP status of Certificate Found

OcspStatusCheckDto[Section 2.213]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.17. getSoonExpiringCertificates

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

Get the Certificates that are expiring soon of the requested Realm

1.7.17.1. Parameters
1.7.17.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.7.17.1.2. Query Parameters
Name Description Required Default Pattern

size

The limit of the requested expiring Certificates

X

null
1.7.17.2. Return Type

Section 2.144

1.7.17.3. Content Type

  • application/json

1.7.17.4. Responses
Table 53. http response codes
Code Message Datatype

200

Expiring soon Certificates for the Realm Found

GetCertificateResponseDtoPage[Section 2.144]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.18. markCertificatesAsRevoked

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

Mark Certificates as revoked

1.7.18.1. Parameters
1.7.18.1.1. Body Parameter
Name Description Required Default Pattern

MarkCertificatesAsRevokedRequestDto

Section 2.209

X
1.7.18.2. Return Type

-

1.7.18.3. Content Type

  • application/json

1.7.18.4. Responses
Table 54. http response codes
Code Message Datatype

204

Certificates Marked As Revoked

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.19. retrieveCertificateP12

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

Retrieve P12 Certificate

1.7.19.1. Parameters
1.7.19.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null
1.7.19.2. Return Type

Section 2.205

1.7.19.3. Content Type

  • application/json

1.7.19.4. Responses
Table 55. http response codes
Code Message Datatype

200

P12 Certificate Retrieved

KeystoreFileDto[Section 2.205]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.20. revokeCertificate

POST /api/v1/certificates/revoke

Revoke Certificate

1.7.20.1. Parameters
1.7.20.1.1. Query Parameters
Name Description Required Default Pattern

id

The id of the desired Certificate

X

null

revocationReason

The reason of the revoke

-

UNSPECIFIED
1.7.20.2. Return Type

Section 2.234

1.7.20.3. Content Type

  • application/json

1.7.20.4. Responses
Table 56. http response codes
Code Message Datatype

200

Certificate Revoked

RevokeCertificateResponseDto[Section 2.234]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.21. revokeMultipleCertificates

POST /api/v1/certificates/batch-revoke

Batch Revoke Certificates

1.7.21.1. Parameters
1.7.21.1.1. Body Parameter
Name Description Required Default Pattern

RevokeCertificateRequestDto

Section 2.233

X
1.7.21.2. Return Type

Section 2.235

1.7.21.3. Content Type

  • application/json

1.7.21.4. Responses
Table 57. http response codes
Code Message Datatype

200

Certificates Revoked

RevokeMultipleCertificateResponseDto[Section 2.235]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.22. searchAllCertificates

POST /api/v1/certificates/search-all

Search all Certificates

1.7.22.1. Parameters
1.7.22.1.1. Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

Section 2.248

X
1.7.22.1.2. 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
1.7.22.2. Return Type

Section 2.144

1.7.22.3. Content Type

  • application/json

1.7.22.4. Responses
Table 58. http response codes
Code Message Datatype

200

Found Certificates

GetCertificateResponseDtoPage[Section 2.144]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.23. searchCertificates

POST /api/v1/certificates/search

Search Certificates

1.7.23.1. Parameters
1.7.23.1.1. Body Parameter
Name Description Required Default Pattern

CertificateSearchRequestDto

Section 2.34

X
1.7.23.1.2. 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
1.7.23.2. Return Type

Section 2.144

1.7.23.3. Content Type

  • application/json

1.7.23.4. Responses
Table 59. http response codes
Code Message Datatype

200

Found Certificates

GetCertificateResponseDtoPage[Section 2.144]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.24. 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

1.7.24.1. Parameters
1.7.24.1.1. Body Parameter
Name Description Required Default Pattern

RawPemCertificateDto

Section 2.226

X
1.7.24.2. Return Type

Section 2.35

1.7.24.3. Content Type

  • application/json

1.7.24.4. Responses
Table 60. http response codes
Code Message Datatype

200

Certificate is validated

CertificateValidationResponseDto[Section 2.35]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.7.25. 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

1.7.25.1. Parameters
1.7.25.1.1. Body Parameter
Name Description Required Default Pattern

RawPemCertificateDto

Section 2.226

X
1.7.25.2. Return Type

Section 2.27

1.7.25.3. Content Type

  • application/json

1.7.25.4. Responses
Table 61. http response codes
Code Message Datatype

200

Certificate is validated

CertificatePlainValidationResponseDto[Section 2.27]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.8. CertificateProvider

1.8.1. checkCertificateProviderConnection

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

Check connected of the Certificate Provider

1.8.1.1. Parameters
1.8.1.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of Certificate Provider that will be checked for connection

X

null
1.8.1.2. Return Type

Section 2.36

1.8.1.3. Content Type

  • application/json

1.8.1.4. Responses
Table 62. http response codes
Code Message Datatype

200

Certificate Provider connected Checked

CheckCertificateProviderConnectionDto[Section 2.36]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.8.2. createCertificateProvider

POST /api/v1/certificate-providers/

Create a Certificate Provider

1.8.2.1. Parameters
1.8.2.1.1. Body Parameter
Name Description Required Default Pattern

CreateCertificateProviderRequestDto

Section 2.52

X
1.8.2.2. Return Type

Section 2.53

1.8.2.3. Content Type

  • application/json

1.8.2.4. Responses
Table 63. http response codes
Code Message Datatype

201

Created Certificate Provider

CreateCertificateProviderResponseDto[Section 2.53]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.8.3. getCertificateProvider

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

Get Certificate Provider by Id

1.8.3.1. Parameters
1.8.3.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the requested Certificate Provider

X

null
1.8.3.2. Return Type

Section 2.138

1.8.3.3. Content Type

  • application/json

1.8.3.4. Responses
Table 64. http response codes
Code Message Datatype

200

Found Certificate Provider

GetCertificateProviderResponseDto[Section 2.138]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.8.4. searchCertificateProviders

POST /api/v1/certificate-providers/search

Find the Certificate Providers

1.8.4.1. Parameters
1.8.4.1.1. Body Parameter
Name Description Required Default Pattern

CertificateProviderSearchRequestDto

Section 2.30

X
1.8.4.1.2. 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
1.8.4.2. Return Type

Section 2.139

1.8.4.3. Content Type

  • application/json

1.8.4.4. Responses
Table 65. http response codes
Code Message Datatype

200

Certificate Providers Found

GetCertificateProviderResponseDtoPage[Section 2.139]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.8.5. searchCertificateProvidersForPolicyCreateUpdate

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

Find the Certificate Providers (non admin)

1.8.5.1. Parameters
1.8.5.1.1. Body Parameter
Name Description Required Default Pattern

CertificateProviderSearchRequestDto

Section 2.30

X
1.8.5.1.2. 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
1.8.5.2. Return Type

Section 2.137

1.8.5.3. Content Type

  • application/json

1.8.5.4. Responses
Table 66. http response codes
Code Message Datatype

200

Certificate Providers Found

GetCertificateProviderMinimalResponseDtoPage[Section 2.137]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.8.6. updateCertificateProvider

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

Update a Certificate Provider

1.8.6.1. Parameters
1.8.6.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of Certificate Provider that will be updated

X

null
1.8.6.1.2. Body Parameter
Name Description Required Default Pattern

UpdateCertificateProviderRequestDto

Section 2.264

X
1.8.6.2. Return Type

Section 2.265

1.8.6.3. Content Type

  • application/json

1.8.6.4. Responses
Table 67. http response codes
Code Message Datatype

200

Certificate Provider Updated

UpdateCertificateProviderResponseDto[Section 2.265]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.9. CertificateProviderOptions

1.9.1. 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

1.9.1.1. Parameters
1.9.1.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.9.1.2. Return Type

Section 2.17

1.9.1.3. Content Type

  • application/json

1.9.1.4. Responses
Table 68. http response codes
Code Message Datatype

200

Template Signers Found

CaraTemplateSignerDtoList[Section 2.17]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.9.2. getMscaTemplatesByCertificateProviderId

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

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

1.9.2.1. Parameters
1.9.2.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.9.2.2. Return Type

Section 2.211

1.9.2.3. Content Type

  • application/json

1.9.2.4. Responses
Table 69. http response codes
Code Message Datatype

200

MS CA Templates Found

MscaTemplatesResponseDto[Section 2.211]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.9.3. getPublicCasProducts

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

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

1.9.3.1. Parameters
1.9.3.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the Certificate Provider for which the products are requested

X

null
1.9.3.2. Return Type

Section 2.223

1.9.3.3. Content Type

  • application/json

1.9.3.4. Responses
Table 70. http response codes
Code Message Datatype

200

Public CAs Products Found

PublicCAsProductsResponseDto[Section 2.223]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.9.4. getTemplateSignersByCertificateProviderId

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

Returns the Template Signers of the Certificate Provider with this ID

1.9.4.1. Parameters
1.9.4.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.9.4.2. Return Type

Section 2.17

1.9.4.3. Content Type

  • application/json

1.9.4.4. Responses
Table 71. http response codes
Code Message Datatype

200

Template Signers Found

CaraTemplateSignerDtoList[Section 2.17]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.10. Cmp

1.10.1. calculateMac

POST /api/v1/cmp/calculate-mac

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

1.10.1.1. Parameters
1.10.1.1.1. Body Parameter
Name Description Required Default Pattern

CmpCalculateMacRequestDto

Section 2.39

X
1.10.1.2. Return Type

Section 2.40

1.10.1.3. Content Type

  • application/json

1.10.1.4. Responses
Table 72. http response codes
Code Message Datatype

200

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

CmpCalculateMacResponseDto[Section 2.40]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.10.2. getCmpConfigurationByPolicyId

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

Find a CMP configuration by a policy ID

1.10.2.1. Parameters
1.10.2.1.1. Path Parameters
Name Description Required Default Pattern

policyId

Id of Policy associated with CMP configuration

X

null
1.10.2.2. Return Type

Section 2.147

1.10.2.3. Content Type

  • application/json

1.10.2.4. Responses
Table 73. http response codes
Code Message Datatype

200

CMP configuration Found

GetCmpConfigurationResponseDto[Section 2.147]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.10.3. signData

POST /api/v1/cmp/sign

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

1.10.3.1. Parameters
1.10.3.1.1. Body Parameter
Name Description Required Default Pattern

CmpSignRequestDto

Section 2.45

X
1.10.3.2. Return Type

Section 2.256

1.10.3.3. Content Type

  • application/json

1.10.3.4. Responses
Table 74. http response codes
Code Message Datatype

200

Data signed

SignDataResponseDto[Section 2.256]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.10.4. 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.

1.10.4.1. Parameters
1.10.4.1.1. Body Parameter
Name Description Required Default Pattern

CmpVerifyMacEndEntityCommonNameRequestDto

Section 2.47

X
1.10.4.2. Return Type

Section 2.49

1.10.4.3. Content Type

  • application/json

1.10.4.4. Responses
Table 75. http response codes
Code Message Datatype

200

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

CmpVerifyMacResponseDto[Section 2.49]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.10.5. 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.

1.10.5.1. Parameters
1.10.5.1.1. Body Parameter
Name Description Required Default Pattern

CmpVerifyMacEndEntityIdRequestDto

Section 2.48

X
1.10.5.2. Return Type

Section 2.49

1.10.5.3. Content Type

  • application/json

1.10.5.4. Responses
Table 76. http response codes
Code Message Datatype

200

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

CmpVerifyMacResponseDto[Section 2.49]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.11. Configuration

1.11.1. checkEmailConnection

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

Check the connection of the configuration E-Mail

1.11.1.1. Parameters
1.11.1.2. Return Type

-

1.11.1.3. Content Type

  • application/json

1.11.1.4. Responses
Table 77. http response codes
Code Message Datatype

204

The Configuration E-Mail connection was checked successfully

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.11.2. createConfiguration

POST /api/v1/configuration/

Create new Configuration

1.11.2.1. Parameters
1.11.2.1.1. Body Parameter
Name Description Required Default Pattern

CreateConfigurationRequestDto

Section 2.55

X
1.11.2.2. Return Type

Section 2.56

1.11.2.3. Content Type

  • application/json

1.11.2.4. Responses
Table 78. http response codes
Code Message Datatype

201

Configuration Created

CreateConfigurationResponseDto[Section 2.56]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.11.3. deleteConfiguration

DELETE /api/v1/configuration/{settingsKey}

Delete Configuration

1.11.3.1. Parameters
1.11.3.1.1. Path Parameters
Name Description Required Default Pattern

settingsKey

The setting key for which the Configuration object should be deleted

X

null
1.11.3.1.2. Query Parameters
Name Description Required Default Pattern

version

The version of the resource that will be deleted

X

null
1.11.3.2. Return Type

-

1.11.3.3. Content Type

  • application/json

1.11.3.4. Responses
Table 79. http response codes
Code Message Datatype

204

Configuration Deleted

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.11.4. getConfiguration

GET /api/v1/configuration/{settingsKey}

Retrieve Configuration by Setting key

1.11.4.1. Parameters
1.11.4.1.1. Path Parameters
Name Description Required Default Pattern

settingsKey

The setting key for which the Configuration object should be retrieved

X

null
1.11.4.2. Return Type

Section 2.149

1.11.4.3. Content Type

  • application/json

1.11.4.4. Responses
Table 80. http response codes
Code Message Datatype

200

Configuration Found

GetConfigurationResponseDto[Section 2.149]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.11.5. searchConfiguration

POST /api/v1/configuration/search

Search Configuration

1.11.5.1. Parameters
1.11.5.1.1. Body Parameter
Name Description Required Default Pattern

SearchConfigurationRequestDto

Section 2.251

X
1.11.5.1.2. 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
1.11.5.2. Return Type

Section 2.150

1.11.5.3. Content Type

  • application/json

1.11.5.4. Responses
Table 81. http response codes
Code Message Datatype

200

Found Configuration

GetConfigurationResponseDtoPage[Section 2.150]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.11.6. updateConfiguration

PATCH /api/v1/configuration/

Update Configuration

1.11.6.1. Parameters
1.11.6.1.1. Body Parameter
Name Description Required Default Pattern

UpdateConfigurationRequestDto

Section 2.268

X
1.11.6.2. Return Type

Section 2.269

1.11.6.3. Content Type

  • application/json

1.11.6.4. Responses
Table 82. http response codes
Code Message Datatype

200

Configuration Updated

UpdateConfigurationResponseDto[Section 2.269]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.11.7. updateConfigurationBatch

PATCH /api/v1/configuration/batch

Update Configuration values in batch mode

1.11.7.1. Parameters
1.11.7.1.1. Body Parameter
Name Description Required Default Pattern

UpdateConfigurationBatchRequestDto

Section 2.266

X
1.11.7.2. Return Type

Section 2.267

1.11.7.3. Content Type

  • application/json

1.11.7.4. Responses
Table 83. http response codes
Code Message Datatype

200

Configuration values Updated

UpdateConfigurationBatchResponseDto[Section 2.267]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.12. CryptoModules

1.12.1. createCryptoModule

POST /api/v1/crypto-modules/

Create a Crypto Module

1.12.1.1. Parameters
1.12.1.1.1. Body Parameter
Name Description Required Default Pattern

CreateCryptoModuleRequestDto

Section 2.57

X
1.12.1.2. Return Type

Section 2.58

1.12.1.3. Content Type

  • application/json

1.12.1.4. Responses
Table 84. http response codes
Code Message Datatype

201

Created Crypto Module

CreateCryptoModuleResponseDto[Section 2.58]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.12.2. getCryptoModule

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

Get Crypto Module by ID

1.12.2.1. Parameters
1.12.2.1.1. Path Parameters
Name Description Required Default Pattern

id

The ID of the requested Crypto Module

X

null
1.12.2.2. Return Type

Section 2.153

1.12.2.3. Content Type

  • application/json

1.12.2.4. Responses
Table 85. http response codes
Code Message Datatype

200

Crypto Module found

GetCryptoModuleResponseDto[Section 2.153]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.12.3. performHealthCheck

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

Perform health check for Crypto Module

1.12.3.1. Parameters
1.12.3.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.12.3.2. Return Type

Section 2.152

1.12.3.3. Content Type

  • application/json

1.12.3.4. Responses
Table 86. http response codes
Code Message Datatype

200

Health check for crypto module performed

GetCryptoModuleHealthCheckResponseDto[Section 2.152]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.12.4. searchCryptoModules

POST /api/v1/crypto-modules/search

Search the Crypto Modules

1.12.4.1. Parameters
1.12.4.1.1. Body Parameter
Name Description Required Default Pattern

CryptoModuleSearchRequestDto

Section 2.84

X
1.12.4.1.2. 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
1.12.4.2. Return Type

Section 2.154

1.12.4.3. Content Type

  • application/json

1.12.4.4. Responses
Table 87. http response codes
Code Message Datatype

200

Crypto Modules found

GetCryptoModuleResponseDtoPage[Section 2.154]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13. EndEntity

1.13.1. createNewEndEntity

POST /api/v1/end-entities/

Create an End Entity

1.13.1.1. Parameters
1.13.1.1.1. Body Parameter
Name Description Required Default Pattern

CreateEndEntityRequestDto

Section 2.61

X
1.13.1.2. Return Type

Section 2.62

1.13.1.3. Content Type

  • application/json

1.13.1.4. Responses
Table 88. http response codes
Code Message Datatype

201

Created End Entity

CreateEndEntityResponseDto[Section 2.62]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.2. findEeByCertBytes

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

Get End Entity by certificate bytes

1.13.2.1. Parameters
1.13.2.1.1. Body Parameter
Name Description Required Default Pattern

FindEeByCertBytesRequestDto

Section 2.116

X
1.13.2.2. Return Type

Section 2.162

1.13.2.3. Content Type

  • application/json

1.13.2.4. Responses
Table 89. http response codes
Code Message Datatype

200

Found End Entity

GetEndEntityResponseDto[Section 2.162]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.3. findEndEntityByPolicyIdAndEndEntityDataset

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

Find End Entity by Policy and End Entity dataset

1.13.3.1. Parameters
1.13.3.1.1. 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
1.13.3.1.2. Body Parameter
Name Description Required Default Pattern

EndEntityDatasetRequestDto

Section 2.99

X
1.13.3.2. Return Type

Section 2.162

1.13.3.3. Content Type

  • application/json

1.13.3.4. Responses
Table 90. http response codes
Code Message Datatype

200

End Entity found by Policy and dataset

GetEndEntityResponseDto[Section 2.162]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.4. getEndEntity

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

Get End Entity by Id

1.13.4.1. Parameters
1.13.4.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of End Entity to be searched

X

null
1.13.4.2. Return Type

Section 2.162

1.13.4.3. Content Type

  • application/json

1.13.4.4. Responses
Table 91. http response codes
Code Message Datatype

200

Found End Entity

GetEndEntityResponseDto[Section 2.162]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.5. getEndEntityByRealmIdAndExternalId

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

Get End Entity by Realm and External Id

1.13.5.1. Parameters
1.13.5.1.1. 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
1.13.5.2. Return Type

Section 2.162

1.13.5.3. Content Type

  • application/json

1.13.5.4. Responses
Table 92. http response codes
Code Message Datatype

200

Found End Entity

GetEndEntityResponseDto[Section 2.162]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.6. getNameOfRolesWithEndEntityAccess

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

Get role names of respective end entity

1.13.6.1. Parameters
1.13.6.1.1. 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
1.13.6.2. Return Type

Section 2.166

1.13.6.3. Content Type

  • application/json

1.13.6.4. Responses
Table 93. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[Section 2.166]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.7. searchAllEndEntities

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

Search all End Entities

1.13.7.1. Parameters
1.13.7.1.1. Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

Section 2.248

X
1.13.7.1.2. 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
1.13.7.2. Return Type

Section 2.163

1.13.7.3. Content Type

  • application/json

1.13.7.4. Responses
Table 94. http response codes
Code Message Datatype

200

Found End Entities

GetEndEntityResponseDtoPage[Section 2.163]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.8. searchEndEntities

POST /api/v1/end-entities/search

Search End Entities

1.13.8.1. Parameters
1.13.8.1.1. Body Parameter
Name Description Required Default Pattern

EndEntitySearchRequestDto

Section 2.107

X
1.13.8.1.2. 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
1.13.8.2. Return Type

Section 2.163

1.13.8.3. Content Type

  • application/json

1.13.8.4. Responses
Table 95. http response codes
Code Message Datatype

200

Found End Entities

GetEndEntityResponseDtoPage[Section 2.163]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.13.9. uploadEndEntitiesCsv

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

Add multiple End Entities from csv file

1.13.9.1. Parameters
1.13.9.1.1. Body Parameter
Name Description Required Default Pattern

EndEntitiesCsvDto

Section 2.96

X
1.13.9.2. Return Type

Section 2.102

1.13.9.3. Content Type

  • application/json

1.13.9.4. Responses
Table 96. http response codes
Code Message Datatype

201

The End Entities were saved successfully

EndEntityMassImportResponseDto[Section 2.102]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.14. EndEntityPassword

1.14.1. authorizeWithEEidAndPassword

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

Authenticate with End Entity and Password

1.14.1.1. Parameters
1.14.1.1.1. Body Parameter
Name Description Required Default Pattern

EndEntityAuthenticationRequestDto

Section 2.97

X
1.14.1.2. Return Type

Section 2.98

1.14.1.3. Content Type

  • application/json

1.14.1.4. Responses
Table 97. http response codes
Code Message Datatype

200

Authenticated successfully

EndEntityAuthenticationResponseDto[Section 2.98]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.14.2. createNewEndEntityPassword

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

Create Password for End Entity

1.14.2.1. Parameters
1.14.2.1.1. Body Parameter
Name Description Required Default Pattern

CreateEndEntityPasswordRequestDto

Section 2.59

X
1.14.2.2. Return Type

Section 2.60

1.14.2.3. Content Type

  • application/json

1.14.2.4. Responses
Table 98. http response codes
Code Message Datatype

201

Password for End Entity created

CreateEndEntityPasswordResponseDto[Section 2.60]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.14.3. deleteEndEntityPassword

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

Delete Password of End Entity

1.14.3.1. Parameters
1.14.3.1.1. Body Parameter
Name Description Required Default Pattern

EndEntityPasswordRequestDto

Section 2.103

X
1.14.3.2. Return Type

-

1.14.3.3. Content Type

  • application/json

1.14.3.4. Responses
Table 99. http response codes
Code Message Datatype

204

Password for End Entity Deleted

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.14.4. getEndEntityPasswordByEndEntityIdAndPolicyId

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

Get End Entity Password by End Entity Id and Policy Id

1.14.4.1. Parameters
1.14.4.1.1. 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
1.14.4.2. Return Type

Section 2.158

1.14.4.3. Content Type

  • application/json

1.14.4.4. Responses
Table 100. http response codes
Code Message Datatype

200

Found End Entity Password

GetEndEntityPasswordResponseDto[Section 2.158]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.14.5. getEndEntityPasswordsByEndEntityId

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

Find the End Entity Passwords connected with the specific End Entity

1.14.5.1. Parameters
1.14.5.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the End Entity for which the search is requested

X

null
1.14.5.1.2. 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
1.14.5.2. Return Type

Section 2.159

1.14.5.3. Content Type

  • application/json

1.14.5.4. Responses
Table 101. http response codes
Code Message Datatype

200

End Entity Passwords Found

GetEndEntityPasswordResponseDtoPage[Section 2.159]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.14.6. resetEndEntityPassword

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

Reset Password of End Entity

1.14.6.1. Parameters
1.14.6.1.1. Body Parameter
Name Description Required Default Pattern

EndEntityPasswordRequestDto

Section 2.103

X
1.14.6.2. Return Type

Section 2.230

1.14.6.3. Content Type

  • application/json

1.14.6.4. Responses
Table 102. http response codes
Code Message Datatype

200

Password for End Entity was reset

ResetEndEntityPasswordResponseDto[Section 2.230]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15. Enum

1.15.1. getApiErrorValues

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

Get Api Error values

1.15.1.1. Parameters
1.15.1.2. Return Type

Section 2.123

1.15.1.3. Content Type

  • application/json

1.15.1.4. Responses
Table 103. http response codes
Code Message Datatype

200

Api Error values found

GetApiErrorValuesResponseDtoList[Section 2.123]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.2. getCertRequestPermissionsValues

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

Get Certificate Request Permissions values

1.15.2.1. Parameters
1.15.2.2. Return Type

Section 2.131

1.15.2.3. Content Type

  • application/json

1.15.2.4. Responses
Table 104. http response codes
Code Message Datatype

200

Certificate Request Permissions values found

GetCertRequestPermissionResponseDtoList[Section 2.131]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.3. getCertStatusValues

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

Get Certificate Status values

1.15.3.1. Parameters
1.15.3.2. Return Type

Section 2.133

1.15.3.3. Content Type

  • application/json

1.15.3.4. Responses
Table 105. http response codes
Code Message Datatype

200

Certificate Status values found

GetCertStatusResponseDtoList[Section 2.133]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.4. getCertificatePermissionsValues

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

Get Certificate Permissions values

1.15.4.1. Parameters
1.15.4.2. Return Type

Section 2.135

1.15.4.3. Content Type

  • application/json

1.15.4.4. Responses
Table 106. http response codes
Code Message Datatype

200

Certificate Permissions values found

GetCertificatePermissionResponseDtoList[Section 2.135]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.5. getCertificateProviderTypeResponseDtoList

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

Get Certificate Provider type values

1.15.5.1. Parameters
1.15.5.2. Return Type

Section 2.140

1.15.5.3. Content Type

  • application/json

1.15.5.4. Responses
Table 107. http response codes
Code Message Datatype

200

Certificate Provider type values found

GetCertificateProviderTypeResponseDtoList[Section 2.140]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.6. getCertificateSearchKeyValues

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

Get Certificate Search Key values

1.15.6.1. Parameters
1.15.6.2. Return Type

Section 2.145

1.15.6.3. Content Type

  • application/json

1.15.6.4. Responses
Table 108. http response codes
Code Message Datatype

200

Certificate Search Key values found

GetCertificateSearchKeyResponseDtoList[Section 2.145]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.7. getCmpSignatureAlgorithmValues

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

Get CMP Signature Algorithm values

1.15.7.1. Parameters
1.15.7.2. Return Type

Section 2.148

1.15.7.3. Content Type

  • application/json

1.15.7.4. Responses
Table 109. http response codes
Code Message Datatype

200

CMP Signature Algorithm values found

GetCmpSignatureAlgorithmResponseDtoList[Section 2.148]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.8. getCryptoAlgorithmValues

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

Get Crypto Algorithm values

1.15.8.1. Parameters
1.15.8.2. Return Type

Section 2.151

1.15.8.3. Content Type

  • application/json

1.15.8.4. Responses
Table 110. http response codes
Code Message Datatype

200

Crypto Algorithm values found

GetCryptoAlgorithmResponseDtoList[Section 2.151]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.9. getCryptoModuleTypes

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

Get Crypto Module type values

1.15.9.1. Parameters
1.15.9.2. Return Type

Section 2.155

1.15.9.3. Content Type

  • application/json

1.15.9.4. Responses
Table 111. http response codes
Code Message Datatype

200

Crypto Module type values found

GetCryptoModuleTypeListResponseDto[Section 2.155]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.10. getEcNamedCurvesValues

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

Get EC Named Curves values

1.15.10.1. Parameters
1.15.10.2. Return Type

Section 2.156

1.15.10.3. Content Type

  • application/json

1.15.10.4. Responses
Table 112. http response codes
Code Message Datatype

200

EC Named Curves values found

GetECNamedCurveResponseDtoList[Section 2.156]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.11. getEdDSANamedCurvesValues

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

Get EdDSA Named Curves values

1.15.11.1. Parameters
1.15.11.2. Return Type

Section 2.157

1.15.11.3. Content Type

  • application/json

1.15.11.4. Responses
Table 113. http response codes
Code Message Datatype

200

EdDSA Named Curves values found

GetEdDSANamedCurveResponseDtoList[Section 2.157]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.12. getEndEntityPermissionsValues

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

Get End Entity Permissions values

1.15.12.1. Parameters
1.15.12.2. Return Type

Section 2.160

1.15.12.3. Content Type

  • application/json

1.15.12.4. Responses
Table 114. http response codes
Code Message Datatype

200

End Entity Permissions values found

GetEndEntityPermissionResponseDtoList[Section 2.160]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.13. getEndEntityPropertiesValues

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

Get End Entity Properties values

1.15.13.1. Parameters
1.15.13.2. Return Type

Section 2.161

1.15.13.3. Content Type

  • application/json

1.15.13.4. Responses
Table 115. http response codes
Code Message Datatype

200

End Entity Properties values found

GetEndEntityPropertyResponseDtoList[Section 2.161]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.14. getEntitiesEnumValues

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

Get End Entity Enum values

1.15.14.1. Parameters
1.15.14.2. Return Type

Section 2.165

1.15.14.3. Content Type

  • application/json

1.15.14.4. Responses
Table 116. http response codes
Code Message Datatype

200

End Entity Enum values found

GetEntitiesEnumResponseDtoList[Section 2.165]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.15. getEntityStrategyEnumValues

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

Get Entity Strategy Enum values

1.15.15.1. Parameters
1.15.15.2. Return Type

Section 2.164

1.15.15.3. Content Type

  • application/json

1.15.15.4. Responses
Table 117. http response codes
Code Message Datatype

200

Entity Strategy Enum values found

GetEndEntityStrategyResponseDtoList[Section 2.164]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.16. getGlobalPermissionsValues

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

Get Global Permissions values

1.15.16.1. Parameters
1.15.16.2. Return Type

Section 2.167

1.15.16.3. Content Type

  • application/json

1.15.16.4. Responses
Table 118. http response codes
Code Message Datatype

200

Global Permissions values found

GetGlobalPermissionResponseDtoList[Section 2.167]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.17. getKeyPairModeValues

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

Get Key Pair Mode values

1.15.17.1. Parameters
1.15.17.2. Return Type

Section 2.169

1.15.17.3. Content Type

  • application/json

1.15.17.4. Responses
Table 119. http response codes
Code Message Datatype

200

Key Pair Mode values found

GetKeyPairModeResponseDtoList[Section 2.169]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.18. getPolicyPermissionsValues

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

Get Policy Permissions values

1.15.18.1. Parameters
1.15.18.2. Return Type

Section 2.176

1.15.18.3. Content Type

  • application/json

1.15.18.4. Responses
Table 120. http response codes
Code Message Datatype

200

Policy Permissions values found

GetPolicyPermissionResponseDtoList[Section 2.176]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.19. getRealmPermissionsValues

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

Get Realm Permissions values

1.15.19.1. Parameters
1.15.19.2. Return Type

Section 2.181

1.15.19.3. Content Type

  • application/json

1.15.19.4. Responses
Table 121. http response codes
Code Message Datatype

200

Realm Permissions values found

GetRealmPermissionResponseDtoList[Section 2.181]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.20. getRevocationReasonValues

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

Get Revocation Reason values

1.15.20.1. Parameters
1.15.20.2. Return Type

Section 2.184

1.15.20.3. Content Type

  • application/json

1.15.20.4. Responses
Table 122. http response codes
Code Message Datatype

200

Revocation Reason values found

GetRevocationReasonResponseDtoList[Section 2.184]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.21. getRsaKeySizeValues

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

Get RSA Key Size values

1.15.21.1. Parameters
1.15.21.2. Return Type

Section 2.179

1.15.21.3. Content Type

  • application/json

1.15.21.4. Responses
Table 123. http response codes
Code Message Datatype

200

RSA Key Size values found

GetRSAKeySizeResponseDtoList[Section 2.179]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.15.22. getValidForValues

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

Get Valid For values

1.15.22.1. Parameters
1.15.22.2. Return Type

Section 2.195

1.15.22.3. Content Type

  • application/json

1.15.22.4. Responses
Table 124. http response codes
Code Message Datatype

200

Valid For values found

GetValidForResponseDtoList[Section 2.195]

400

Bad Request

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.16. MailingList

1.16.1. createNewMailingList

POST /api/v1/mailing-lists/

Create Mailing List

1.16.1.1. Parameters
1.16.1.1.1. Body Parameter
Name Description Required Default Pattern

CreateNewMailingListRequestDto

Section 2.69

X
1.16.1.2. Return Type

Section 2.70

1.16.1.3. Content Type

  • application/json

1.16.1.4. Responses
Table 125. http response codes
Code Message Datatype

201

Mailing List Created

CreateNewMailingListResponseDto[Section 2.70]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.16.2. getMailingList

GET /api/v1/mailing-lists/{id}

Get Mailing List by Id

1.16.2.1. Parameters
1.16.2.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the requested Mailing List

X

null
1.16.2.2. Return Type

Section 2.170

1.16.2.3. Content Type

  • application/json

1.16.2.4. Responses
Table 126. http response codes
Code Message Datatype

200

Found Mailing List

GetMailingListResponseDto[Section 2.170]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.16.3. searchMailingLists

POST /api/v1/mailing-lists/search

Search Mailing Lists

1.16.3.1. Parameters
1.16.3.1.1. Body Parameter
Name Description Required Default Pattern

MailingListSearchRequestDto

Section 2.207

X
1.16.3.1.2. 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
1.16.3.2. Return Type

Section 2.171

1.16.3.3. Content Type

  • application/json

1.16.3.4. Responses
Table 127. http response codes
Code Message Datatype

200

Mailing Lists Found

GetMailingListResponseDtoPage[Section 2.171]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.16.4. updateMailingList

POST /api/v1/mailing-lists/{id}

Update a Mailing List

1.16.4.1. Parameters
1.16.4.1.1. Path Parameters
Name Description Required Default Pattern

id

The id of the Mailing List that will be updated

X

null
1.16.4.1.2. Body Parameter
Name Description Required Default Pattern

UpdateMailingListRequestDto

Section 2.270

X
1.16.4.2. Return Type

Section 2.271

1.16.4.3. Content Type

  • application/json

1.16.4.4. Responses
Table 128. http response codes
Code Message Datatype

200

Mailing List Updated

UpdateMailingListResponseDto[Section 2.271]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.17. Pkcs10

1.17.1. createPkcs10Request

POST /api/v1/pkcs10/

Create a PKCS10 Request

1.17.1.1. Parameters
1.17.1.1.1. Body Parameter
Name Description Required Default Pattern

CreatePkcs10RequestDto

Section 2.72

X
1.17.1.2. Return Type

Section 2.73

1.17.1.3. Content Type

  • application/json

1.17.1.4. Responses
Table 129. http response codes
Code Message Datatype

200

PKCS10 Request Created

CreatePkcs10ResponseDto[Section 2.73]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.17.2. parsePkcs10

POST /api/v1/pkcs10/parse

Parse a PKCS10 Request

1.17.2.1. Parameters
1.17.2.1.1. Body Parameter
Name Description Required Default Pattern

Pkcs10Dto

Section 2.218

X
1.17.2.2. Return Type

Section 2.217

1.17.2.3. Content Type

  • application/json

1.17.2.4. Responses
Table 130. http response codes
Code Message Datatype

200

PKCS10 Request Parsed

ParsePkcs10ResponseDto[Section 2.217]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18. Policy

1.18.1. availablePoliciesWithoutPasswordByEndEntityId

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

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

1.18.1.1. Parameters
1.18.1.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the End Entity for which the search is requested

X

null
1.18.1.1.2. 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
1.18.1.2. Return Type

Section 2.178

1.18.1.3. Content Type

  • application/json

1.18.1.4. Responses
Table 131. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[Section 2.178]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.2. checkEndEntityWithRules

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

Check End Entity Rules

1.18.2.1. Parameters
1.18.2.1.1. Path Parameters
Name Description Required Default Pattern

id

X

null
1.18.2.1.2. Body Parameter
Name Description Required Default Pattern

CheckEndEntityRequestDto

Section 2.37

X
1.18.2.2. Return Type

Section 2.38

1.18.2.3. Content Type

  • application/json

1.18.2.4. Responses
Table 132. http response codes
Code Message Datatype

200

End Entity Rules Checked

CheckEndEntityResponseDto[Section 2.38]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.3. createNewPolicy

POST /api/v1/policies/

Create a Policy

1.18.3.1. Parameters
1.18.3.1.1. Body Parameter
Name Description Required Default Pattern

CreatePolicyRequestDto

Section 2.74

X
1.18.3.2. Return Type

Section 2.75

1.18.3.3. Content Type

  • application/json

1.18.3.4. Responses
Table 133. http response codes
Code Message Datatype

201

Policy Created

CreatePolicyResponseDto[Section 2.75]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.4. getAllowedCryptoParameters

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

Get policy allowed crypto parameters for provider provider and provider configuration

1.18.4.1. Parameters
1.18.4.1.1. Body Parameter
Name Description Required Default Pattern

GetAllowedCryptoParametersRequestDto

Section 2.119

X
1.18.4.2. Return Type

Section 2.86

1.18.4.3. Content Type

  • application/json

1.18.4.4. Responses
Table 134. http response codes
Code Message Datatype

200

End Entity Rules Checked

CryptoParametersDto[Section 2.86]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.5. getNameOfRolesWithPolicyAccess

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

Get role names of respective policy

1.18.5.1. Parameters
1.18.5.1.1. 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
1.18.5.2. Return Type

Section 2.166

1.18.5.3. Content Type

  • application/json

1.18.5.4. Responses
Table 135. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[Section 2.166]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.6. getPoliciesByCertificateProviderId

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

Search Policies that use a specific Certificate Provider

1.18.6.1. Parameters
1.18.6.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.18.6.1.2. 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
1.18.6.2. Return Type

Section 2.178

1.18.6.3. Content Type

  • application/json

1.18.6.4. Responses
Table 136. http response codes
Code Message Datatype

200

Policies Found connected to the specific Certificate Provider

GetPolicyResponseDtoPage[Section 2.178]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.7. getPoliciesInRealms

POST /api/v1/policies/realms

Find the Policies of multiple Realms

1.18.7.1. Parameters
1.18.7.1.1. Body Parameter
Name Description Required Default Pattern

GetPoliciesInRealmsDto

Section 2.175

X
1.18.7.1.2. 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
1.18.7.2. Return Type

Section 2.178

1.18.7.3. Content Type

  • application/json

1.18.7.4. Responses
Table 137. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[Section 2.178]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.8. getPolicy

GET /api/v1/policies/{id}

Find a specific Policy

1.18.8.1. Parameters
1.18.8.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of Policy to be searched

X

null
1.18.8.2. Return Type

Section 2.177

1.18.8.3. Content Type

  • application/json

1.18.8.4. Responses
Table 138. http response codes
Code Message Datatype

200

Policy Found

GetPolicyResponseDto[Section 2.177]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.9. getPolicyByRealmId

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

Find the Policies of a Realm

1.18.9.1. Parameters
1.18.9.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of Realm for which Policies will be searched

X

null
1.18.9.1.2. 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
1.18.9.2. Return Type

Section 2.178

1.18.9.3. Content Type

  • application/json

1.18.9.4. Responses
Table 139. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[Section 2.178]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.10. searchAllPolicies

POST /api/v1/policies/search-all

Search all Policies

1.18.10.1. Parameters
1.18.10.1.1. Body Parameter
Name Description Required Default Pattern

SearchAllRequestDto

Section 2.248

X
1.18.10.1.2. 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
1.18.10.2. Return Type

Section 2.178

1.18.10.3. Content Type

  • application/json

1.18.10.4. Responses
Table 140. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[Section 2.178]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.11. searchPolicies

POST /api/v1/policies/search

Search Policies

1.18.11.1. Parameters
1.18.11.1.1. Body Parameter
Name Description Required Default Pattern

PolicySearchRequestDto

Section 2.220

X
1.18.11.1.2. 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
1.18.11.2. Return Type

Section 2.178

1.18.11.3. Content Type

  • application/json

1.18.11.4. Responses
Table 141. http response codes
Code Message Datatype

200

Policies Found

GetPolicyResponseDtoPage[Section 2.178]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.18.12. updatePolicy

PATCH /api/v1/policies/{id}

Update a Policy

1.18.12.1. Parameters
1.18.12.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of Policy that will be updated

X

null
1.18.12.1.2. Body Parameter
Name Description Required Default Pattern

UpdatePolicyRequestDto

Section 2.272

X
1.18.12.2. Return Type

Section 2.273

1.18.12.3. Content Type

  • application/json

1.18.12.4. Responses
Table 142. http response codes
Code Message Datatype

200

Policy Updated

UpdatePolicyResponseDto[Section 2.273]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.19. PublicUser

1.19.1. extractEndEntityInfoFromPemEncodedPkcs10

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

Extract End Entity info from PEM encoded PKCS10 Request

1.19.1.1. Parameters
1.19.1.1.1. Body Parameter
Name Description Required Default Pattern

ExtractEndEntityInfoFromPkcs10RequestDto

Section 2.112

X
1.19.1.2. Return Type

Section 2.113

1.19.1.3. Content Type

  • application/json

1.19.1.4. Responses
Table 143. http response codes
Code Message Datatype

200

Extracted End Entity info from PEM encoded PKCS10 Request

ExtractEndEntityInfoFromPkcs10ResponseDto[Section 2.113]

400

Bad Request

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.19.2. verifyCertificateRequestByEmail

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

Verify Certificate Request by E-Mail

1.19.2.1. Parameters
1.19.2.1.1. Body Parameter
Name Description Required Default Pattern

VerifyTokenRequestDto

Section 2.291

X
1.19.2.2. Return Type

Section 2.95

1.19.2.3. Content Type

  • application/json

1.19.2.4. Responses
Table 144. http response codes
Code Message Datatype

200

Verified Certificate Request and sent an E-Mail

EmailVerifiedCertReqResponseDto[Section 2.95]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20. RaCertificate

1.20.1. createBatchRaCertificateForUsers

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

Create Batch Ra Certificates for a User

1.20.1.1. Parameters
1.20.1.1.1. Body Parameter
Name Description Required Default Pattern

CreateRaCertBatchRequestDto

Section 2.76

X
1.20.1.2. Return Type

Section 2.292

1.20.1.3. Content Type

  • application/json

1.20.1.4. Responses
Table 145. http response codes
Code Message Datatype

200

User's Ra Certificates Created

ZippedCertsBatchDto[Section 2.292]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.2. createRaCertificateForSingleUser

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

Create/renew Ra Certificate for a single User

1.20.2.1. Parameters
1.20.2.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are creating

X

null
1.20.2.1.2. Body Parameter
Name Description Required Default Pattern

CreateSingleRaCertRequestDto

Section 2.81

X
1.20.2.2. Return Type

Section 2.282

1.20.2.3. Content Type

  • application/json

1.20.2.4. Responses
Table 146. http response codes
Code Message Datatype

200

User's Ra Certificate Created

UpdateUserRaCertificateDto[Section 2.282]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.3. downloadRaCertCrl

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

Download the Ra Certificate of a User

1.20.3.1. Parameters
1.20.3.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate CRL we are downloading

X

null
1.20.3.2. Return Type

Section 2.82

1.20.3.3. Content Type

  • application/json

1.20.3.4. Responses
Table 147. http response codes
Code Message Datatype

200

Ra Certificate of the User Downloaded

CrlDto[Section 2.82]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.4. downloadUserRaCertificate

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

Download the Ra Certificate of a User

1.20.4.1. Parameters
1.20.4.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are downloading

X

null
1.20.4.2. Return Type

Section 2.225

1.20.4.3. Content Type

  • application/json

1.20.4.4. Responses
Table 148. http response codes
Code Message Datatype

200

User's Ra Certificate Downloaded

RaCertificatePemDto[Section 2.225]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.5. downloadUserRaCertificateChain

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

Download the Certificate Chain of a User

1.20.5.1. Parameters
1.20.5.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Certificate Chain we are downloading

X

null
1.20.5.1.2. Query Parameters
Name Description Required Default Pattern

casFirst

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

X

null
1.20.5.2. Return Type

Section 2.225

1.20.5.3. Content Type

  • application/json

1.20.5.4. Responses
Table 149. http response codes
Code Message Datatype

200

User's Certificate Chain Downloaded

RaCertificatePemDto[Section 2.225]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.6. getRaOcspStatus

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

Get the Ra OCSP Status of a User

1.20.6.1. Parameters
1.20.6.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose OCSP Status we are getting

X

null
1.20.6.2. Return Type

Section 2.213

1.20.6.3. Content Type

  • application/json

1.20.6.4. Responses
Table 150. http response codes
Code Message Datatype

200

Got the Ra OCSP Status of the User

OcspStatusCheckDto[Section 2.213]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.7. getUserRaCertificate

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

Find a specific User’s Ra Certificate

1.20.7.1. Parameters
1.20.7.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are searching for

X

null
1.20.7.2. Return Type

Section 2.180

1.20.7.3. Content Type

  • application/json

1.20.7.4. Responses
Table 151. http response codes
Code Message Datatype

200

Ra Certificate Found

GetRaCertificateResponseDto[Section 2.180]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.8. retrieveRaCertificateP12

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

Retrieve the Ra PKCS12 Certificate of a User

1.20.8.1. Parameters
1.20.8.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra PKCS12 Certificate we are retrieving

X

null
1.20.8.2. Return Type

Section 2.205

1.20.8.3. Content Type

  • application/json

1.20.8.4. Responses
Table 152. http response codes
Code Message Datatype

200

User's Ra PKCS12 Certificate Retrieved

KeystoreFileDto[Section 2.205]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.20.9. revokeRaCertificate

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

Revoke the Ra Certificate of a User

1.20.9.1. Parameters
1.20.9.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User whose Ra Certificate we are revoking

X

null
1.20.9.1.2. Query Parameters
Name Description Required Default Pattern

revReason

The reason of the Revocation request

-

null
1.20.9.2. Return Type

Section 2.236

1.20.9.3. Content Type

  • application/json

1.20.9.4. Responses
Table 153. http response codes
Code Message Datatype

200

User's Ra Certificate Revoked

RevokeRaCertificateResponseDto[Section 2.236]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.21. Realm

1.21.1. createNewRealm

POST /api/v1/realms/

Create a Realm

1.21.1.1. Parameters
1.21.1.1.1. Body Parameter
Name Description Required Default Pattern

CreateRealmRequestDto

Section 2.77

X
1.21.1.2. Return Type

Section 2.78

1.21.1.3. Content Type

  • application/json

1.21.1.4. Responses
Table 154. http response codes
Code Message Datatype

201

Realm Created

CreateRealmResponseDto[Section 2.78]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.21.2. getNameOfRolesWithRealmAccess

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

Get role names of respective realm

1.21.2.1. Parameters
1.21.2.1.1. 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
1.21.2.2. Return Type

Section 2.166

1.21.2.3. Content Type

  • application/json

1.21.2.4. Responses
Table 155. http response codes
Code Message Datatype

200

Role names Found

GetEntityRoleNamesResponseDto[Section 2.166]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.21.3. getRealm

GET /api/v1/realms/{id}

Find Realm

1.21.3.1. Parameters
1.21.3.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the Realm that requesting to be found

X

null
1.21.3.2. Return Type

Section 2.182

1.21.3.3. Content Type

  • application/json

1.21.3.4. Responses
Table 156. http response codes
Code Message Datatype

200

Realm Found

GetRealmResponseDto[Section 2.182]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.21.4. getRealms

GET /api/v1/realms/

Find Realms

1.21.4.1. Parameters
1.21.4.1.1. 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
1.21.4.2. Return Type

Section 2.183

1.21.4.3. Content Type

  • application/json

1.21.4.4. Responses
Table 157. http response codes
Code Message Datatype

200

Realms Found

GetRealmResponseDtoPage[Section 2.183]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

POST /api/v1/realms/search

Search Realms

1.21.5.1. Parameters
1.21.5.1.1. Body Parameter
Name Description Required Default Pattern

RealmSearchRequestDto

Section 2.228

X
1.21.5.1.2. 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
1.21.5.2. Return Type

Section 2.183

1.21.5.3. Content Type

  • application/json

1.21.5.4. Responses
Table 158. http response codes
Code Message Datatype

200

Realms Found

GetRealmResponseDtoPage[Section 2.183]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.21.6. updateRealm

PATCH /api/v1/realms/{id}

Update a Realm

1.21.6.1. Parameters
1.21.6.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the Realm that will be updated

X

null
1.21.6.1.2. Body Parameter
Name Description Required Default Pattern

UpdateRealmRequestDto

Section 2.274

X
1.21.6.2. Return Type

Section 2.275

1.21.6.3. Content Type

  • application/json

1.21.6.4. Responses
Table 159. http response codes
Code Message Datatype

200

Realm Updated

UpdateRealmResponseDto[Section 2.275]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22. RealmStatistics

1.22.1. getCertRequestStatusStatisticsForRealm

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

Get the Certificate Request Status Statistics of the requested Realm

1.22.1.1. Parameters
1.22.1.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.22.1.2. Return Type

Section 2.132

1.22.1.3. Content Type

  • application/json

1.22.1.4. Responses
Table 160. http response codes
Code Message Datatype

200

Certificate Request Status Statistics for the Realm Found

GetCertRequestStatusStatisticsResponseDto[Section 2.132]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22.2. getCertificateIssuerStatisticsForRealm

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

Get the Certificate Issuer Statistics of the requested Realm

1.22.2.1. Parameters
1.22.2.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.22.2.2. Return Type

Section 2.134

1.22.2.3. Content Type

  • application/json

1.22.2.4. Responses
Table 161. http response codes
Code Message Datatype

200

Certificate Issuer Statistics for the Realm Found

GetCertificateIssuerStatisticsResponseDto[Section 2.134]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22.3. getCertificateProviderTypeStatisticsForRealm

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

Get the Certificate Provider Type Statistics of the requested Realm

1.22.3.1. Parameters
1.22.3.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.22.3.2. Return Type

Section 2.141

1.22.3.3. Content Type

  • application/json

1.22.3.4. Responses
Table 162. http response codes
Code Message Datatype

200

Certificate Provider Type Statistics for the Realm Found

GetCertificateProviderTypeStatisticsResponseDto[Section 2.141]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22.4. getCertificatePublicKeyAlgorithmStatisticsForRealm

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

Get the Certificate Public Key Algorithm Statistics of the requested Realm

1.22.4.1. Parameters
1.22.4.1.1. 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
1.22.4.2. Return Type

Section 2.142

1.22.4.3. Content Type

  • application/json

1.22.4.4. Responses
Table 163. http response codes
Code Message Datatype

200

Certificate Public Key Algorithm Statistics for the Realm Found

GetCertificatePublicKeyAlgorithmStatisticsResponseDto[Section 2.142]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22.5. getCertificateStatusStatisticsForRealm

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

Get the Certificate Status Statistics of the requested Realm

1.22.5.1. Parameters
1.22.5.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.22.5.2. Return Type

Section 2.146

1.22.5.3. Content Type

  • application/json

1.22.5.4. Responses
Table 164. http response codes
Code Message Datatype

200

Certificate Status Statistics for the Realm Found

GetCertificateStatusStatisticsResponseDto[Section 2.146]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22.6. getImportedCertificatesStatisticsForRealm

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

Get the Imported Certificates Statistics of the requested Realm

1.22.6.1. Parameters
1.22.6.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.22.6.2. Return Type

Section 2.168

1.22.6.3. Content Type

  • application/json

1.22.6.4. Responses
Table 165. http response codes
Code Message Datatype

200

Imported Certificates Statistics for the Realm Found

GetImportedCertificatesStatisticsResponseDto[Section 2.168]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22.7. getLatestAuditEvents

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

Get the latest Certificate Audit Events of the requested Realm

1.22.7.1. Parameters
1.22.7.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.22.7.2. Return Type

Section 2.124

1.22.7.3. Content Type

  • application/json

1.22.7.4. Responses
Table 166. http response codes
Code Message Datatype

200

Latest Certificate Audit Events

GetAuditEventResponseDtoList[Section 2.124]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.22.8. getSelfSignedCertificatesStatisticsForRealm

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

Get the Self-signed Certificates Statistics of the requested Realm

1.22.8.1. Parameters
1.22.8.1.1. Path Parameters
Name Description Required Default Pattern

id

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

X

null
1.22.8.2. Return Type

Section 2.189

1.22.8.3. Content Type

  • application/json

1.22.8.4. Responses
Table 167. http response codes
Code Message Datatype

200

Self-signed Certificates Statistics for the Realm Found

GetSelfSignedCertificatesStatisticsResponseDto[Section 2.189]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23. Roles

1.23.1. batchAssignApiClientRoles

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

Assign Roles for multiple API Clients

1.23.1.1. Parameters
1.23.1.1.1. Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

Section 2.278

X
1.23.1.2. Return Type

Section 2.279

1.23.1.3. Content Type

  • application/json

1.23.1.4. Responses
Table 168. http response codes
Code Message Datatype

200

API Client Roles assigned

UpdateSecurityIdentityRolesBatchResponseDto[Section 2.279]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.2. batchAssignUserRoles

PUT /api/v1/roles/users/assign

Assign Roles for multiple Users

1.23.2.1. Parameters
1.23.2.1.1. Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

Section 2.278

X
1.23.2.2. Return Type

Section 2.279

1.23.2.3. Content Type

  • application/json

1.23.2.4. Responses
Table 169. http response codes
Code Message Datatype

200

User Roles assigned

UpdateSecurityIdentityRolesBatchResponseDto[Section 2.279]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.3. batchUnassignApiClientRoles

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

Unassign Roles from multiple API Clients

1.23.3.1. Parameters
1.23.3.1.1. Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

Section 2.278

X
1.23.3.2. Return Type

Section 2.279

1.23.3.3. Content Type

  • application/json

1.23.3.4. Responses
Table 170. http response codes
Code Message Datatype

200

API Client Roles unassigned

UpdateSecurityIdentityRolesBatchResponseDto[Section 2.279]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.4. batchUnassignUserRoles

PUT /api/v1/roles/users/unassign

Unassign Roles from multiple Users

1.23.4.1. Parameters
1.23.4.1.1. Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesBatchRequestDto

Section 2.278

X
1.23.4.2. Return Type

Section 2.279

1.23.4.3. Content Type

  • application/json

1.23.4.4. Responses
Table 171. http response codes
Code Message Datatype

200

User Roles unassigned

UpdateSecurityIdentityRolesBatchResponseDto[Section 2.279]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.5. createRole

POST /api/v1/roles/

Create Role

1.23.5.1. Parameters
1.23.5.1.1. Body Parameter
Name Description Required Default Pattern

CreateRoleRequestDto

Section 2.79

X
1.23.5.2. Return Type

Section 2.80

1.23.5.3. Content Type

  • application/json

1.23.5.4. Responses
Table 172. http response codes
Code Message Datatype

201

Role created

CreateRoleResponseDto[Section 2.80]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.6. deleteRole

DELETE /api/v1/roles/{name}

Delete Role

1.23.6.1. Parameters
1.23.6.1.1. Path Parameters
Name Description Required Default Pattern

name

The name of the Role

X

null
1.23.6.2. Return Type

-

1.23.6.3. Content Type

  • application/json

1.23.6.4. Responses
Table 173. http response codes
Code Message Datatype

204

Role deleted

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.7. deleteRoles

POST /api/v1/roles/batch-delete

Batch Delete Roles

1.23.7.1. Parameters
1.23.7.1.1. Body Parameter
Name Description Required Default Pattern

BatchDeleteRolesRequestDto

Section 2.11

X
1.23.7.2. Return Type

Section 2.12

1.23.7.3. Content Type

  • application/json

1.23.7.4. Responses
Table 174. http response codes
Code Message Datatype

200

Role(s) deleted

BatchDeleteRolesResponseDto[Section 2.12]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.8. getApiClientRoles

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

Get API Client Roles

1.23.8.1. Parameters
1.23.8.1.1. Path Parameters
Name Description Required Default Pattern

apiClientId

The id of the API Client

X

null
1.23.8.2. Return Type

Section 2.188

1.23.8.3. Content Type

  • application/json

1.23.8.4. Responses
Table 175. http response codes
Code Message Datatype

200

API Client Roles Found

GetSecurityIdentityRolesResponseDto[Section 2.188]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.9. getRoleDetails

GET /api/v1/roles/{name}

Get Role

1.23.9.1. Parameters
1.23.9.1.1. Path Parameters
Name Description Required Default Pattern

name

The name of the Role

X

null
1.23.9.2. Return Type

Section 2.185

1.23.9.3. Content Type

  • application/json

1.23.9.4. Responses
Table 176. http response codes
Code Message Datatype

200

Role Found

GetRoleDetailsResponseDto[Section 2.185]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.10. getSecurityIdentitiesOfRole

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

Get security identities of a role

1.23.10.1. Parameters
1.23.10.1.1. Path Parameters
Name Description Required Default Pattern

role

The id of the API Client

X

null
1.23.10.2. Return Type

Section 2.172

1.23.10.3. Content Type

  • application/json

1.23.10.4. Responses
Table 177. http response codes
Code Message Datatype

200

Security identities Found

GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto[Section 2.172]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.11. getUserRoles

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

Get User Roles

1.23.11.1. Parameters
1.23.11.1.1. Path Parameters
Name Description Required Default Pattern

userId

The id of the User

X

null
1.23.11.2. Return Type

Section 2.188

1.23.11.3. Content Type

  • application/json

1.23.11.4. Responses
Table 178. http response codes
Code Message Datatype

200

User Roles Found

GetSecurityIdentityRolesResponseDto[Section 2.188]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.12. searchRoles

POST /api/v1/roles/search

Search Roles

1.23.12.1. Parameters
1.23.12.1.1. Body Parameter
Name Description Required Default Pattern

SearchRoleRequestDto

Section 2.252

X
1.23.12.1.2. 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
1.23.12.2. Return Type

Section 2.187

1.23.12.3. Content Type

  • application/json

1.23.12.4. Responses
Table 179. http response codes
Code Message Datatype

200

Roles Found

GetRoleResponseDtoPage[Section 2.187]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.13. updateApiClientRoles

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

Update API Client Roles

1.23.13.1. Parameters
1.23.13.1.1. Path Parameters
Name Description Required Default Pattern

apiClientId

The id of the API Client

X

null
1.23.13.1.2. Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesRequestDto

Section 2.280

X
1.23.13.2. Return Type

-

1.23.13.3. Content Type

  • application/json

1.23.13.4. Responses
Table 180. http response codes
Code Message Datatype

204

API Client Roles Updated

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.14. updateRole

PUT /api/v1/roles/{name}

Update Role

1.23.14.1. Parameters
1.23.14.1.1. Path Parameters
Name Description Required Default Pattern

name

The name of the Role

X

null
1.23.14.1.2. Body Parameter
Name Description Required Default Pattern

UpdateRoleRequestDto

Section 2.276

X
1.23.14.2. Return Type

Section 2.277

1.23.14.3. Content Type

  • application/json

1.23.14.4. Responses
Table 181. http response codes
Code Message Datatype

200

Role updated

UpdateRoleResponseDto[Section 2.277]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.23.15. updateUserRoles

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

Update User Roles

1.23.15.1. Parameters
1.23.15.1.1. Path Parameters
Name Description Required Default Pattern

userId

The id of the User

X

null
1.23.15.1.2. Body Parameter
Name Description Required Default Pattern

UpdateSecurityIdentityRolesRequestDto

Section 2.280

X
1.23.15.2. Return Type

-

1.23.15.3. Content Type

  • application/json

1.23.15.4. Responses
Table 182. http response codes
Code Message Datatype

204

User Roles Updated

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.24. Scep

1.24.1. decryptData

POST /api/v1/scep/decrypt

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

1.24.1.1. Parameters
1.24.1.1.1. Body Parameter
Name Description Required Default Pattern

ScepDecryptDataRequestDto

Section 2.244

X
1.24.1.2. Return Type

Section 2.245

1.24.1.3. Content Type

  • application/json

1.24.1.4. Responses
Table 183. http response codes
Code Message Datatype

200

Data decrypted

ScepDecryptDataResponseDto[Section 2.245]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.24.2. raDecryptData

POST /api/v1/scep/ra-decrypt

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

1.24.2.1. Parameters
1.24.2.1.1. Body Parameter
Name Description Required Default Pattern

ScepDecryptDataRequestDto

Section 2.244

X
1.24.2.2. Return Type

Section 2.245

1.24.2.3. Content Type

  • application/json

1.24.2.4. Responses
Table 184. http response codes
Code Message Datatype

200

Data decrypted

ScepDecryptDataResponseDto[Section 2.245]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.24.3. raSignDataScep

POST /api/v1/scep/ra-sign

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

1.24.3.1. Parameters
1.24.3.1.1. Body Parameter
Name Description Required Default Pattern

ScepSignRequestDto

Section 2.247

X
1.24.3.2. Return Type

Section 2.246

1.24.3.3. Content Type

  • application/json

1.24.3.4. Responses
Table 185. http response codes
Code Message Datatype

200

Data signed

ScepSignDataResponseDto[Section 2.246]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.24.4. signDataScep

POST /api/v1/scep/sign

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

1.24.4.1. Parameters
1.24.4.1.1. Body Parameter
Name Description Required Default Pattern

ScepSignRequestDto

Section 2.247

X
1.24.4.2. Return Type

Section 2.246

1.24.4.3. Content Type

  • application/json

1.24.4.4. Responses
Table 186. http response codes
Code Message Datatype

200

Data signed

ScepSignDataResponseDto[Section 2.246]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.25. Sign

1.25.1. signDataWithCA

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

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

1.25.1.1. Parameters
1.25.1.1.1. Body Parameter
Name Description Required Default Pattern

SignDataRequestDto

Section 2.255

X
1.25.1.2. Return Type

Section 2.256

1.25.1.3. Content Type

  • application/json

1.25.1.4. Responses
Table 187. http response codes
Code Message Datatype

200

Data signed

SignDataResponseDto[Section 2.256]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

1.26. User

1.26.1. editPasswordLoginRoleToUser

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

Set or unset disable_password_login Role to User

1.26.1.1. Parameters
1.26.1.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User

X

null
1.26.1.1.2. Query Parameters
Name Description Required Default Pattern

enablePasswordLogin

X

null
1.26.1.2. Return Type

-

1.26.1.3. Content Type

  • application/json

1.26.1.4. Responses
Table 188. http response codes
Code Message Datatype

204

Set disable_password_login role

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.26.2. findUserByRaCertificate

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

Find User by the RA Certificate

1.26.2.1. Parameters
1.26.2.1.1. Body Parameter
Name Description Required Default Pattern

FindUserByRaCertificateRequestDto

Section 2.117

X
1.26.2.2. Return Type

Section 2.192

1.26.2.3. Content Type

  • application/json

1.26.2.4. Responses
Table 189. http response codes
Code Message Datatype

200

User Found

GetUserDetailsResponseDto[Section 2.192]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

422

Unprocessable Entity, check the result for more information

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.26.3. getUser

GET /api/v1/users/{id}

Find User

1.26.3.1. Parameters
1.26.3.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of the User to be searched

X

null
1.26.3.2. Return Type

Section 2.192

1.26.3.3. Content Type

  • application/json

1.26.3.4. Responses
Table 190. http response codes
Code Message Datatype

200

User Found

GetUserDetailsResponseDto[Section 2.192]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.26.4. registerUser

POST /api/v1/users/

Register a User

1.26.4.1. Parameters
1.26.4.1.1. Body Parameter
Name Description Required Default Pattern

CreateNewUserDetailsDto

Section 2.71

X
1.26.4.2. Return Type

Section 2.193

1.26.4.3. Content Type

  • application/json

1.26.4.4. Responses
Table 191. http response codes
Code Message Datatype

201

User Registered

GetUserResponseDto[Section 2.193]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

409

Conflict, check the result for more information

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.26.5. searchUsers

POST /api/v1/users/search

Search Users

1.26.5.1. Parameters
1.26.5.1.1. Body Parameter
Name Description Required Default Pattern

UserSearchRequestDto

Section 2.285

X
1.26.5.1.2. 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
1.26.5.2. Return Type

Section 2.194

1.26.5.3. Content Type

  • application/json

1.26.5.4. Responses
Table 192. http response codes
Code Message Datatype

200

Users Found

GetUserResponseDtoPage[Section 2.194]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.26.6. sendUpdatePasswordEmailBatch

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

Send Batch update password E-Mails

1.26.6.1. Parameters
1.26.6.1.1. Body Parameter
Name Description Required Default Pattern

UserListDto

Section 2.283

X
1.26.6.2. Return Type

-

1.26.6.3. Content Type

  • application/json

1.26.6.4. Responses
Table 193. http response codes
Code Message Datatype

204

Batch update password E-Mails sent

<<>>

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

1.26.7. setUserCertificateDetails

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

Set a user’s Certificate Details

1.26.7.1. Parameters
1.26.7.1.1. Path Parameters
Name Description Required Default Pattern

id

Id of User whose details will be set

X

null
1.26.7.1.2. Body Parameter
Name Description Required Default Pattern

UpdateUserCertificateDetailsRequestDto

Section 2.281

X
1.26.7.2. Return Type

Section 2.193

1.26.7.3. Content Type

  • application/json

1.26.7.4. Responses
Table 194. http response codes
Code Message Datatype

200

User's Certificate Details Set

GetUserResponseDto[Section 2.193]

400

Bad Request

ApiExceptionResponse[Section 2.3]

401

Authentication Failed

ApiExceptionResponse[Section 2.3]

403

Access Denied

ApiExceptionResponse[Section 2.3]

404

Not Found, check the result for more information

ApiExceptionResponse[Section 2.3]

405

Http method not allowed

ApiExceptionResponse[Section 2.3]

415

Specified media not supported for this endpoint

ApiExceptionResponse[Section 2.3]

500

Internal Error, check the result for more information

ApiExceptionResponse[Section 2.3]

502

Bad Gateway, check the result for more information

ApiExceptionResponse[Section 2.3]

2. Models

2.1. ApiClientSearchRequestDto

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

Field Name Required Type Description Format

simpleSearchTerm

String

2.2. ApiError

Field Name Required Type Description Format

2.3. ApiExceptionResponse

Field Name Required Type Description Format

apiError

X

ApiError

errorMessage

String

2.4. ApproveCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

certificateId

UUID

uuid

certRequestStatus

CertRequestStatus

userResponses

List of Section 2.284

metadata

AuditedAndVersionDtoUUID

2.5. 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

2.6. ArchivedDtoUUID

Field Name Required Type Description Format

archived

Boolean

archivedDate

Date

date-time

archivedBy

UUID

uuid

archivedByType

SecurityIdentityType

2.7. AuditEventDto

Field Name Required Type Description Format

objectId

UUID

uuid

eventDescription

String

occurredDate

Date

date-time

2.8. 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

2.9. AuthenticatedPrincipalResponseDto

Field Name Required Type Description Format

id

UUID

uuid

authenticatedPrincipalType

SecurityIdentityType

2.10. BatchCertificateCreationErrorResponseDto

Field Name Required Type Description Format

failedUserId

UUID

uuid

apiError

ApiError

2.11. BatchDeleteRolesRequestDto

It includes all the names of the roles to be deleted

Field Name Required Type Description Format

roleNames

X

Set of [string]

2.12. BatchDeleteRolesResponseDto

Field Name Required Type Description Format

successful

Set of [string]

failed

Map of Section 2.2

2.13. CaCertificateDataPemDto

Field Name Required Type Description Format

id

UUID

uuid

filename

String

pemCertificate

String

2.14. CaCertificatePemDto

Field Name Required Type Description Format

pemCertificate

String

2.15. 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

2.16. CaraTemplateSignerDto

Field Name Required Type Description Format

id

Long

int64

name

String

caSubjectDn

String

2.17. CaraTemplateSignerDtoList

Field Name Required Type Description Format

caraTemplateSignerList

List of Section 2.16

2.18. CertReqSearchByPkcs10

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

Field Name Required Type Description Format

pkcs10ReqBase64

X

String

2.19. 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

2.20. CertRequestAction

Field Name Required Type Description Format

2.21. CertRequestPermission

Field Name Required Type Description Format

2.22. CertRequestStatus

Field Name Required Type Description Format

2.23. CertStatus

Field Name Required Type Description Format

2.24. 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

2.25. CertificatePemDto

Field Name Required Type Description Format

id

UUID

uuid

fileName

String

pemCertificate

String

2.26. CertificatePermission

Field Name Required Type Description Format

2.27. CertificatePlainValidationResponseDto

Field Name Required Type Description Format

result

Boolean

2.28. CertificatePrivateKeyPemDto

Field Name Required Type Description Format

id

UUID

uuid

fileName

String

pemPrivateKey

String

2.29. CertificateProviderDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

2.30. 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

2.31. CertificateProviderType

Field Name Required Type Description Format

2.32. CertificateRevocationResult

Field Name Required Type Description Format

2.33. CertificateSearchKey

Field Name Required Type Description Format

2.34. 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 Section 2.23

certPublicKeyAlgorithms

Set of Section 2.83

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

2.35. CertificateValidationResponseDto

Field Name Required Type Description Format

result

Boolean

errorDescription

String

certificateChain

String

2.36. CheckCertificateProviderConnectionDto

Field Name Required Type Description Format

connected

Boolean

2.37. 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 Section 2.118

2.38. CheckEndEntityResponseDto

Field Name Required Type Description Format

endEntityPropertyApiErrorMap

Map of Section 2.2

2.39. CmpCalculateMacRequestDto

Field Name Required Type Description Format

data

byte[]

byte

encodedPBMParameter

byte[]

byte

policyId

X

UUID

uuid

endEntityId

X

UUID

uuid

2.40. CmpCalculateMacResponseDto

Field Name Required Type Description Format

macValue

byte[]

byte

2.41. CmpConfigurationDto

Field Name Required Type Description Format

certificateProviderDto

X

CertificateProviderDto

signerConfigurationDto

X

SignerConfigurationDto

2.42. CmpConfigurationRequestDto

Field Name Required Type Description Format

certificateProviderId

X

UUID

uuid

signerConfigurationDto

X

SignerConfigurationDto

2.43. CmpConfigurationResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

policyId

X

UUID

uuid

cmpConfigurationDto

CmpConfigurationDto

2.44. CmpMacVerificationResult

Field Name Required Type Description Format

2.45. CmpSignRequestDto

Field Name Required Type Description Format

data

byte[]

byte

policyId

X

UUID

uuid

2.46. CmpSignatureAlgorithm

Field Name Required Type Description Format

2.47. CmpVerifyMacEndEntityCommonNameRequestDto

Field Name Required Type Description Format

macValue

byte[]

byte

data

byte[]

byte

encodedPBMParameter

byte[]

byte

policyId

X

UUID

uuid

endEntityCommonName

X

String

2.48. CmpVerifyMacEndEntityIdRequestDto

Field Name Required Type Description Format

macValue

byte[]

byte

data

byte[]

byte

encodedPBMParameter

byte[]

byte

policyId

X

UUID

uuid

endEntityId

X

UUID

uuid

2.49. CmpVerifyMacResponseDto

Field Name Required Type Description Format

cmpMacVerificationResult

X

CmpMacVerificationResult

endEntityId

UUID

uuid

2.50. 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

2.51. CreateCertReqResponseDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

metadata

AuditedAndVersionDtoUUID

2.52. CreateCertificateProviderRequestDto

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

Field Name Required Type Description Format

name

String

certificateProviderType

X

CertificateProviderType

configuration

X

Object

2.53. CreateCertificateProviderResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

configuration

X

Object

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

2.54. CreateCertificateResponseDto

Field Name Required Type Description Format

certificate

CertificateDto

base64EncodedPkcs12

String

base64EncodedJceKs

String

fileName

String

filePassword

String

version

Integer

int32

accessiblePrivateKey

Boolean

errorOccurred

Boolean

commonName

String

certificateId

String

2.55. CreateConfigurationRequestDto

It includes all the necessary values to create a new Configuration

Field Name Required Type Description Format

setting

X

SettingsKey

configurationValue

String

2.56. CreateConfigurationResponseDto

Field Name Required Type Description Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

settingName

String

2.57. CreateCryptoModuleRequestDto

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

Field Name Required Type Description Format

cryptoModuleType

X

CryptoModuleType

name

String

configuration

X

Object

2.58. CreateCryptoModuleResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

cryptoModuleType

X

CryptoModuleType

configuration

X

Object

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.59. CreateEndEntityPasswordRequestDto

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

Field Name Required Type Description Format

endEntityIds

List of [UUID]

uuid

policyId

X

UUID

uuid

2.60. CreateEndEntityPasswordResponseDto

Field Name Required Type Description Format

endEntityIds

List of [UUID]

uuid

policyId

UUID

uuid

password

String

metadata

AuditedAndVersionDtoUUID

2.61. CreateEndEntityRequestDto

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

Field Name Required Type Description Format

realmId

X

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 Section 2.118

2.62. 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 Section 2.118

metadata

AuditedAndVersionDtoUUID

2.63. 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

2.64. CreateMultipleCertReqResponseDto

Field Name Required Type Description Format

certRequestsCreated

Map of Section 2.51

certRequestsFailed

Map of Section 2.2

certificateRequests

List of [UUID]

uuid

2.65. CreateMultipleCertificateFromCertRequestsResponseDto

Field Name Required Type Description Format

zipFileInBase64

String

filePassword

String

certificatesFailed

Map of Section 2.2

certificatesSuccessful

Map of [UUID]

uuid

certificateIds

List of [UUID]

uuid

2.66. CreateNewApiClientRequest

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

Field Name Required Type Description Format

realmIds

List of [UUID]

uuid

name

String

defaultPolicyId

UUID

uuid

2.67. CreateNewApiClientResponse

Field Name Required Type Description Format

id

X

UUID

uuid

secret

String

clientId

String

name

String

2.68. CreateNewEmailRequestDto

Field Name Required Type Description Format

emailName

String

2.69. CreateNewMailingListRequestDto

It includes all the properties needed for the creation of a Mailing List

Field Name Required Type Description Format

name

String

emails

List of Section 2.68

2.70. CreateNewMailingListResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

emails

List of Section 2.208

archived

Boolean

metadata

AuditedAndVersionDtoUUID

2.71. CreateNewUserDetailsDto

It includes the basic properties needed for the creation

Field Name Required Type Description Format

firstName

X

String

lastName

X

String

email

String

passwordLoginEnabled

Boolean

2.72. CreatePkcs10RequestDto

It includes all the properties necessary for the creation

Field Name Required Type Description Format

keyGenParamsDto

KeyGenParamsDto

endEntityInfoDto

EndEntityInfoDto

2.73. CreatePkcs10ResponseDto

Field Name Required Type Description Format

pkcs10RequestPemEncoded

String

pkcs10RequestFileName

String

encryptedPrivateKeyInPemFormat

String

privateKeyName

String

privateKeyPassword

String

2.74. CreatePolicyRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

realmId

X

UUID

uuid

name

String

certificateProviderId

X

UUID

uuid

certificateProviderConfiguration

X

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of Section 2.204

allowedValidForValues

Set of Section 2.286

cryptoRestrictions

X

CryptoRestrictionsDto

endEntityRules

Set of Section 2.106

dualControl

Boolean

requiresEmailVerification

Boolean

endEntityStrategy

X

EndEntityStrategy

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationRequestDto

CmpConfigurationRequestDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.75. CreatePolicyResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

certificateProviderDto

CertificateProviderDto

certificateProviderConfiguration

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of Section 2.204

allowedValidForValues

Set of Section 2.286

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of Section 2.106

dualControl

Boolean

requiresEmailVerification

Boolean

metadata

AuditedAndVersionDtoUUID

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationResponseDto

CmpConfigurationResponseDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.76. 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

2.77. CreateRealmRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

name

X

String

mailingListId

UUID

uuid

2.78. CreateRealmResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

mailingListId

UUID

uuid

archived

Boolean

metadata

AuditedAndVersionDtoUUID

2.79. CreateRoleRequestDto

It includes all the properties needed for the creation

Field Name Required Type Description Format

name

String

globalPermissions

Set of Section 2.196

realmPermissions

X

Set of Section 2.241

policyPermissions

X

Set of Section 2.240

endEntityPermissions

X

Set of Section 2.239

certRequestPermissions

X

Set of Section 2.237

certificatePermissions

X

Set of Section 2.238

2.80. CreateRoleResponseDto

Field Name Required Type Description Format

name

String

globalPermissions

Set of Section 2.196

realmPermissions

Set of Section 2.241

policyPermissions

Set of Section 2.240

endEntityPermissions

Set of Section 2.239

certRequestPermissions

Set of Section 2.237

certificatePermissions

Set of Section 2.238

2.81. 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

2.82. CrlDto

Field Name Required Type Description Format

fileName

String

crl

String

2.83. CryptoAlgorithm

Field Name Required Type Description Format

2.84. CryptoModuleSearchRequestDto

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

Field Name Required Type Description Format

simpleSearchTerm

String

archived

Boolean

2.85. CryptoModuleType

Field Name Required Type Description Format

2.86. CryptoParametersDto

Field Name Required Type Description Format

keyPairModes

Set of Section 2.204

cryptoRestrictions

CryptoRestrictionsDto

2.87. CryptoRestrictionsDto

Field Name Required Type Description Format

allowedCryptoAlgorithms

List of Section 2.83

rsaKeyGenParams

X

List of Section 2.242

ecKeyGenParams

X

List of Section 2.90

edDsaKeyGenParams

X

List of Section 2.93

2.88. DeclineCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

certRequestStatus

CertRequestStatus

userResponses

List of Section 2.284

metadata

AuditedAndVersionDtoUUID

2.89. 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

2.90. EcKeyGenParams

Field Name Required Type Description Format

namedCurve

String

cryptoAlgorithm

X

CryptoAlgorithm

2.91. EcNamedCurve

Field Name Required Type Description Format

2.92. EdDsaCurve

Field Name Required Type Description Format

2.93. EdDsaKeyGenParams

Field Name Required Type Description Format

edDsaCurve

X

EdDsaCurve

cryptoAlgorithm

X

CryptoAlgorithm

2.94. EmailDto

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

Field Name Required Type Description Format

email

X

String

2.95. EmailVerifiedCertReqResponseDto

Field Name Required Type Description Format

id

UUID

uuid

certRequestStatus

CertRequestStatus

metadata

AuditedAndVersionDtoUUID

2.96. 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

2.97. 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

2.98. EndEntityAuthenticationResponseDto

Field Name Required Type Description Format

endEntity

X

GetEndEntityResponseDto

policy

X

GetPolicyResponseDto

endEntityId

UUID

uuid

policyId

UUID

uuid

2.99. EndEntityDatasetRequestDto

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

Field Name Required Type Description Format

commonName

String

organization

String

organizationalUnit

String

country

String

email

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of Section 2.118

2.100. 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 Section 2.118

2.101. EndEntityInfoDto

Field Name Required Type Description Format

commonName

String

organization

String

organizationalUnit

String

country

String

email

String

domains

List of [string]

ips

List of [string]

2.102. EndEntityMassImportResponseDto

Field Name Required Type Description Format

endEntityIds

List of [UUID]

uuid

2.103. 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

2.104. EndEntityPermission

Field Name Required Type Description Format

2.105. EndEntityProperty

Field Name Required Type Description Format

2.106. EndEntityRule

Field Name Required Type Description Format

required

Boolean

endEntityProperty

X

EndEntityProperty

allowedValues

X

Set of [string]

2.107. 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

2.108. EndEntityStrategy

Field Name Required Type Description Format

2.109. EntitiesEnum

Field Name Required Type Description Format

2.110. 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

2.111. ExaminePkcs10RequestResponseDto

Field Name Required Type Description Format

isValid

Boolean

2.112. ExtractEndEntityInfoFromPkcs10RequestDto

It contains the PEM encoded PKCS10 Request

Field Name Required Type Description Format

pemEncodedPkcs10

String

2.113. 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]

2.114. FailedCertificateOrderResultDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

apiError

ApiError

2.115. FailedImportCertRequestResponseDto

Field Name Required Type Description Format

certificateFingerprint

String

apiError

ApiError

2.116. FindEeByCertBytesRequestDto

It includes the properties needed to find the End Entity

Field Name Required Type Description Format

realmId

X

UUID

uuid

base64EncodedBytes

String

2.117. FindUserByRaCertificateRequestDto

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

Field Name Required Type Description Format

base64EncodedBytes

String

2.118. GenericDto

Field Name Required Type Description Format

key

String

value

String

2.119. GetAllowedCryptoParametersRequestDto

Field Name Required Type Description Format

certificateProviderId

X

UUID

uuid

certificateProviderConfiguration

String

2.120. GetApiClientDetailsResponse

Field Name Required Type Description Format

id

X

UUID

uuid

realmIds

X

List of [UUID]

uuid

name

String

clientId

String

defaultPolicyId

UUID

uuid

2.121. GetApiClientResponse

Field Name Required Type Description Format

id

X

UUID

uuid

name

String

clientId

String

2.122. GetApiClientResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.121

pageDetails

PageDetailsDto

2.123. GetApiErrorValuesResponseDtoList

Field Name Required Type Description Format

apiErrorList

List of Section 2.2

2.124. GetAuditEventResponseDtoList

Field Name Required Type Description Format

auditEventDtoList

List of Section 2.7

2.125. GetAuthenticatedPrincipalPermissionsResponseDto

Field Name Required Type Description Format

globalPermissions

Set of Section 2.196

realmPermissions

Map of [set]

policyPermissions

Map of [set]

endEntityPermissions

Map of [set]

certRequestPermissions

Map of [set]

certificatePermissions

Map of [set]

2.126. 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

2.127. GetCertByIssuerDnBinAndSnDto

It includes all the needed properties to get the desired Certificate

Field Name Required Type Description Format

issuerDnBin

String

serialNumber

String

2.128. 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 Section 2.284

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

2.129. GetCertReqResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.128

pageDetails

PageDetailsDto

2.130. GetCertRequestAdditionalDataResponseDto

Field Name Required Type Description Format

additionalData

Object

isCertRequestUpdated

Boolean

2.131. GetCertRequestPermissionResponseDtoList

Field Name Required Type Description Format

certRequestPermissionList

List of Section 2.21

2.132. 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

2.133. GetCertStatusResponseDtoList

Field Name Required Type Description Format

certStatusList

List of Section 2.23

2.134. GetCertificateIssuerStatisticsResponseDto

Field Name Required Type Description Format

empty

Boolean

2.135. GetCertificatePermissionResponseDtoList

Field Name Required Type Description Format

certificatePermissionList

List of Section 2.26

2.136. GetCertificateProviderMinimalResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

2.137. GetCertificateProviderMinimalResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.136

pageDetails

PageDetailsDto

2.138. GetCertificateProviderResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

configuration

X

Object

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

2.139. GetCertificateProviderResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.138

pageDetails

PageDetailsDto

2.140. GetCertificateProviderTypeResponseDtoList

Field Name Required Type Description Format

certificateProviderTypeList

List of Section 2.31

2.141. GetCertificateProviderTypeStatisticsResponseDto

Field Name Required Type Description Format

mtgCara

Long

int64

msNdes

Long

int64

msca

Long

int64

globalSign

Long

int64

pswPublicCas

Long

int64

2.142. GetCertificatePublicKeyAlgorithmStatisticsResponseDto

Field Name Required Type Description Format

rsa

Long

int64

ec

Long

int64

edDsa

Long

int64

2.143. 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

2.144. GetCertificateResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.143

pageDetails

PageDetailsDto

2.145. GetCertificateSearchKeyResponseDtoList

Field Name Required Type Description Format

certificateSearchKeyList

List of Section 2.33

2.146. GetCertificateStatusStatisticsResponseDto

Field Name Required Type Description Format

active

Long

int64

expired

Long

int64

revoked

Long

int64

2.147. GetCmpConfigurationResponseDto

Field Name Required Type Description Format

id

UUID

uuid

cmpConfigurationDto

CmpConfigurationDto

policyId

UUID

uuid

signerCertChain

String

signerCertificateId

UUID

uuid

2.148. GetCmpSignatureAlgorithmResponseDtoList

Field Name Required Type Description Format

cmpSignatureAlgorithmList

List of Section 2.46

2.149. GetConfigurationResponseDto

Field Name Required Type Description Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

2.150. GetConfigurationResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.149

pageDetails

PageDetailsDto

2.151. GetCryptoAlgorithmResponseDtoList

Field Name Required Type Description Format

cryptoAlgorithmList

List of Section 2.83

2.152. GetCryptoModuleHealthCheckResponseDto

Field Name Required Type Description Format

isHealthy

Boolean

2.153. GetCryptoModuleResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

cryptoModuleType

X

CryptoModuleType

configuration

X

Object

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.154. GetCryptoModuleResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.153

pageDetails

PageDetailsDto

2.155. GetCryptoModuleTypeListResponseDto

Field Name Required Type Description Format

cryptoModuleTypes

List of Section 2.85

2.156. GetECNamedCurveResponseDtoList

Field Name Required Type Description Format

ecNamedCurveList

List of Section 2.91

2.157. GetEdDSANamedCurveResponseDtoList

Field Name Required Type Description Format

edDsaCurveList

List of Section 2.92

2.158. GetEndEntityPasswordResponseDto

Field Name Required Type Description Format

endEntityId

UUID

uuid

endEntityName

String

policyId

UUID

uuid

policyName

String

metadata

AuditedAndVersionDtoUUID

2.159. GetEndEntityPasswordResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.158

pageDetails

PageDetailsDto

2.160. GetEndEntityPermissionResponseDtoList

Field Name Required Type Description Format

endEntityPermissionList

List of Section 2.104

2.161. GetEndEntityPropertyResponseDtoList

Field Name Required Type Description Format

endEntityPropertyList

List of Section 2.105

2.162. GetEndEntityResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

realmId

X

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 Section 2.118

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

endEntityStrategy

EndEntityStrategy

alias

String

matchesPolicyEndEntityRules

Boolean

2.163. GetEndEntityResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.162

pageDetails

PageDetailsDto

2.164. GetEndEntityStrategyResponseDtoList

Field Name Required Type Description Format

endEntityStrategyList

List of Section 2.108

2.165. GetEntitiesEnumResponseDtoList

Field Name Required Type Description Format

entitiesEnumList

List of Section 2.109

2.166. GetEntityRoleNamesResponseDto

Field Name Required Type Description Format

entityId

UUID

uuid

entityRoleNames

Set of [string]

2.167. GetGlobalPermissionResponseDtoList

Field Name Required Type Description Format

globalPermissionList

List of Section 2.196

2.168. GetImportedCertificatesStatisticsResponseDto

Field Name Required Type Description Format

imported

Long

int64

issued

Long

int64

2.169. GetKeyPairModeResponseDtoList

Field Name Required Type Description Format

keyPairModeList

List of Section 2.204

2.170. GetMailingListResponseDto

Field Name Required Type Description Format

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

id

UUID

uuid

name

String

emails

List of Section 2.208

2.171. GetMailingListResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.170

pageDetails

PageDetailsDto

2.172. GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto

Field Name Required Type Description Format

users

Set of Section 2.210

apiClients

Set of Section 2.210

2.173. 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

2.174. GetPendingCertReqResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.173

pageDetails

PageDetailsDto

2.175. GetPoliciesInRealmsDto

It includes the Realm Ids, needed for the search

Field Name Required Type Description Format

realmIds

List of [UUID]

uuid

2.176. GetPolicyPermissionResponseDtoList

Field Name Required Type Description Format

policyPermissionList

List of Section 2.219

2.177. GetPolicyResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

String

certificateProviderDto

X

CertificateProviderDto

certificateProviderConfiguration

X

String

realmId

X

UUID

uuid

requiresManualApproval

Boolean

allowedKeyPairModes

Set of Section 2.204

allowedValidForValues

Set of Section 2.286

cryptoRestrictions

X

CryptoRestrictionsDto

endEntityRules

Set of Section 2.106

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

2.178. GetPolicyResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.177

pageDetails

PageDetailsDto

2.179. GetRSAKeySizeResponseDtoList

Field Name Required Type Description Format

rsaKeySizeList

List of Section 2.243

2.180. 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

2.181. GetRealmPermissionResponseDtoList

Field Name Required Type Description Format

realmPermissionList

List of Section 2.227

2.182. GetRealmResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

mailingListDto

MailingListDto

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.183. GetRealmResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.182

pageDetails

PageDetailsDto

2.184. GetRevocationReasonResponseDtoList

Field Name Required Type Description Format

revocationReasonList

List of [string]

2.185. GetRoleDetailsResponseDto

Field Name Required Type Description Format

name

String

providerId

UUID

uuid

globalPermissions

Set of Section 2.196

realmPermissions

Set of Section 2.241

policyPermissions

Set of Section 2.240

endEntityPermissions

Set of Section 2.239

certRequestPermissions

Set of Section 2.237

certificatePermissions

Set of Section 2.238

2.186. GetRoleResponseDto

Field Name Required Type Description Format

name

String

globalPermissions

Set of Section 2.196

realmPermissions

Set of Section 2.241

policyPermissions

Set of Section 2.240

endEntityPermissions

Set of Section 2.239

certRequestPermissions

Set of Section 2.237

certificatePermissions

Set of Section 2.238

2.187. GetRoleResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.186

pageDetails

PageDetailsDto

2.188. GetSecurityIdentityRolesResponseDto

Field Name Required Type Description Format

roles

X

Set of Section 2.186

2.189. GetSelfSignedCertificatesStatisticsResponseDto

Field Name Required Type Description Format

selfSigned

Long

int64

nonSelfSigned

Long

int64

2.190. GetTrustedCasRequestDto

The options regarding which CAs will be returned

Field Name Required Type Description Format

includeRootOnly

Boolean

includeVerifyServersOnly

Boolean

2.191. GetTrustedCasResponseDto

Field Name Required Type Description Format

trustedCas

List of [string]

2.192. GetUserDetailsResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

username

String

firstName

String

lastName

String

email

String

commonName

String

organization

String

organizationalUnit

String

country

String

enabled

Boolean

passwordLoginEnabled

Boolean

2.193. GetUserResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

username

String

firstName

String

lastName

String

email

String

commonName

String

organization

String

organizationalUnit

String

country

String

enabled

Boolean

2.194. GetUserResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.193

pageDetails

PageDetailsDto

2.195. GetValidForResponseDtoList

Field Name Required Type Description Format

validForList

List of Section 2.286

2.196. GlobalPermission

Field Name Required Type Description Format

2.197. ImportCaDto

Field Name Required Type Description Format

id

UUID

uuid

fingerprint

String

isRootCa

Boolean

2.198. ImportCaRequestDto

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

Field Name Required Type Description Format

pemFileContents

String

2.199. ImportCaResponseDto

Field Name Required Type Description Format

importedCaDtoList

List of Section 2.197

cas

List of [UUID]

uuid

2.200. ImportCertificatesRequestDto

It includes encoded certificates and the necessary metadata for it

Field Name Required Type Description Format

policyId

X

UUID

uuid

discoveredCertsInPem

List of Section 2.202

2.201. ImportCertificatesResponseDto

Field Name Required Type Description Format

hashAlgorithmId

String

successful

List of Section 2.259

failed

List of Section 2.115

certificates

List of [UUID]

uuid

2.202. ImportPemCertificatesDto

Field Name Required Type Description Format

server

String

port

Integer

int32

pemCertificates

String

2.203. KeyGenParamsDto

Field Name Required Type Description Format

cryptoAlgorithm

X

CryptoAlgorithm

keySize

RsaKeySize

exponent

Integer

namedCurve

String

edDsaCurve

EdDsaCurve

2.204. KeyPairMode

Field Name Required Type Description Format

2.205. KeystoreFileDto

Field Name Required Type Description Format

base64EncodedPkcs12

String

base64EncodedJceKs

String

fileName

String

filePassword

String

2.206. MailingListDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

archived

Boolean

version

Integer

int32

2.207. MailingListSearchRequestDto

It includes all the properties that can be used to filter the search request

Field Name Required Type Description Format

simpleSearchTerm

String

mailingListIds

Set of [UUID]

uuid

archived

Boolean

2.208. MailingListToEmailDto

Field Name Required Type Description Format

emailId

UUID

uuid

mailingListId

UUID

uuid

emailName

String

optOut

Boolean

2.209. MarkCertificatesAsRevokedRequestDto

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

Field Name Required Type Description Format

certificatesIds

List of [UUID]

uuid

2.210. MinimalSecurityIdentityRepresentationDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

2.211. MscaTemplatesResponseDto

Field Name Required Type Description Format

templateNames

List of [string]

2.212. OcspCertStatus

Field Name Required Type Description Format

2.213. OcspStatusCheckDto

Field Name Required Type Description Format

ocspCertStatus

X

OcspCertStatus

2.214. OrderCertificateResponseDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

certificateId

UUID

uuid

errorOccurred

Boolean

2.215. OrderMultipleCertificatesResponseDto

Field Name Required Type Description Format

base64EncodedZippedArtifacts

String

artifactsPassword

String

successfulCertificateOrders

List of Section 2.258

failedCertificateOrders

List of Section 2.114

issuedCertificateIds

List of [UUID]

uuid

successfulCertificateRequests

List of [UUID]

uuid

2.216. PageDetailsDto

Field Name Required Type Description Format

totalElements

X

Long

int64

pageNumber

X

Integer

int32

pageSize

X

Integer

int32

numberOfElementsInPage

X

Integer

int32

2.217. ParsePkcs10ResponseDto

Field Name Required Type Description Format

keyPairMode

X

KeyPairMode

keyGenParamsDto

X

KeyGenParamsDto

pkcs10ReqBase64

String

2.218. Pkcs10Dto

It includes all the properties necessary for parsing

Field Name Required Type Description Format

base64EncodedPkcs10

X

String

2.219. PolicyPermission

Field Name Required Type Description Format

2.220. 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

2.221. PublicCAsProductType

Field Name Required Type Description Format

2.222. PublicCAsProductValidationType

Field Name Required Type Description Format

2.223. PublicCAsProductsResponseDto

Field Name Required Type Description Format

products

List of Section 2.224

2.224. PublicCasProductResponseDto

Field Name Required Type Description Format

number

String

monthValidity

Integer

int32

name

String

type

PublicCAsProductType

validationType

PublicCAsProductValidationType

signatureAlgorithms

List of [string]

2.225. RaCertificatePemDto

Field Name Required Type Description Format

id

Long

int64

fileName

String

pemCertificate

String

2.226. RawPemCertificateDto

PEM Encoded Certificate

Field Name Required Type Description Format

pemCertificate

String

2.227. RealmPermission

Field Name Required Type Description Format

2.228. 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

2.229. ResetApiClientSecretResponse

Field Name Required Type Description Format

secret

String

2.230. ResetEndEntityPasswordResponseDto

Field Name Required Type Description Format

password

String

metadata

AuditedAndVersionDtoUUID

2.231. RevocationReason

Field Name Required Type Description Format

2.232. RevokeCertificateDto

Field Name Required Type Description Format

id

X

UUID

uuid

revocationReason

RevocationReason

2.233. RevokeCertificateRequestDto

It includes all the properties needed to revoke the desired Certificates

Field Name Required Type Description Format

revokeCertificateDtos

List of Section 2.232

2.234. RevokeCertificateResponseDto

Field Name Required Type Description Format

certificateRevocationResult

X

CertificateRevocationResult

certificateRevocationReason

RevocationReason

revocationResult

String

2.235. RevokeMultipleCertificateResponseDto

Field Name Required Type Description Format

successfulRevocation

Boolean

2.236. RevokeRaCertificateResponseDto

Field Name Required Type Description Format

certificateRevocationResult

X

CertificateRevocationResult

revocationResult

String

2.237. RoleEntityPermissionsDtoCertRequestPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of Section 2.21

2.238. RoleEntityPermissionsDtoCertificatePermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of Section 2.26

2.239. RoleEntityPermissionsDtoEndEntityPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of Section 2.104

2.240. RoleEntityPermissionsDtoPolicyPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of Section 2.219

2.241. RoleEntityPermissionsDtoRealmPermission

Field Name Required Type Description Format

entityId

X

UUID

uuid

permissions

X

Set of Section 2.227

2.242. RsaKeyGenParams

Field Name Required Type Description Format

keySize

X

RsaKeySize

exponent

Integer

cryptoAlgorithm

X

CryptoAlgorithm

2.243. RsaKeySize

Field Name Required Type Description Format

2.244. ScepDecryptDataRequestDto

Field Name Required Type Description Format

data

byte[]

byte

policyId

X

UUID

uuid

2.245. ScepDecryptDataResponseDto

Field Name Required Type Description Format

data

byte[]

byte

2.246. ScepSignDataResponseDto

Field Name Required Type Description Format

signature

byte[]

byte

2.247. ScepSignRequestDto

Field Name Required Type Description Format

data

byte[]

byte

policyId

X

UUID

uuid

encodedIssuer

byte[]

byte

algorithmID

byte[]

byte

2.248. SearchAllRequestDto

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

Field Name Required Type Description Format

simpleSearchTerm

String

archived

Boolean

2.249. 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

2.250. SearchCaResponseDtoPage

Field Name Required Type Description Format

content

List of Section 2.249

pageDetails

PageDetailsDto

2.251. SearchConfigurationRequestDto

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

Field Name Required Type Description Format

keys

List of Section 2.254

2.252. SearchRoleRequestDto

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

Field Name Required Type Description Format

simpleSearchTerm

String

2.253. SecurityIdentityType

Field Name Required Type Description Format

2.254. SettingsKey

Field Name Required Type Description Format

2.255. SignDataRequestDto

Field Name Required Type Description Format

data

byte[]

byte

algorithmAID

byte[]

byte

policyId

X

UUID

uuid

encodedIssuer

byte[]

byte

2.256. SignDataResponseDto

Field Name Required Type Description Format

signature

byte[]

byte

2.257. SignerConfigurationDto

Field Name Required Type Description Format

signerConfiguration

X

String

cmpSignatureAlgorithm

X

CmpSignatureAlgorithm

2.258. SuccessfulCertificateOrderResultDto

Field Name Required Type Description Format

certRequestId

UUID

uuid

certificateId

UUID

uuid

2.259. SuccessfulImportCertRequestResponseDto

Field Name Required Type Description Format

certificateFingerprint

String

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

2.260. UpdateApiClientRequest

It includes all the properties needed to update an Api Client

Field Name Required Type Description Format

name

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

2.261. UpdateApiClientResponse

Field Name Required Type Description Format

id

X

UUID

uuid

secret

String

2.262. UpdateCaRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

verifyServers

Boolean

version

Integer

int32

2.263. 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

2.264. UpdateCertificateProviderRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

String

configuration

X

Object

version

Integer

int32

2.265. UpdateCertificateProviderResponseDto

Field Name Required Type Description Format

id

X

UUID

uuid

name

X

String

certificateProviderType

X

CertificateProviderType

configuration

X

Object

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

2.266. UpdateConfigurationBatchRequestDto

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

Field Name Required Type Description Format

updateConfigurationRequestDtoList

List of Section 2.268

2.267. UpdateConfigurationBatchResponseDto

Field Name Required Type Description Format

updateConfigurationResponseDtoList

List of Section 2.269

configurations

List of [string]

2.268. UpdateConfigurationRequestDto

It includes all the necessary values to update an existing Configuration

Field Name Required Type Description Format

settingsKey

X

SettingsKey

configuration

String

version

Integer

int32

2.269. UpdateConfigurationResponseDto

Field Name Required Type Description Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

configuration

String

2.270. UpdateMailingListRequestDto

It includes all the properties needed to complete the update

Field Name Required Type Description Format

name

String

emails

List of Section 2.68

version

X

Integer

int32

2.271. UpdateMailingListResponseDto

Field Name Required Type Description Format

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

id

UUID

uuid

name

String

emails

List of Section 2.208

2.272. UpdatePolicyRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

String

certificateProviderId

X

UUID

uuid

certificateProviderConfiguration

X

String

allowedKeyPairModes

Set of Section 2.204

allowedValidForValues

Set of Section 2.286

cryptoRestrictions

X

CryptoRestrictionsDto

version

Integer

int32

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

endEntityRules

Set of Section 2.106

cmpEnabled

Boolean

cmpConfigurationRequestDto

CmpConfigurationRequestDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.273. UpdatePolicyResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

certificateProviderDto

CertificateProviderDto

certificateProviderConfiguration

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of Section 2.204

allowedValidForValues

Set of Section 2.286

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of Section 2.106

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

2.274. UpdateRealmRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

X

String

mailingListId

UUID

uuid

version

Integer

int32

2.275. UpdateRealmResponseDto

Field Name Required Type Description Format

id

UUID

uuid

name

String

mailingListDto

MailingListDto

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.276. UpdateRoleRequestDto

It includes all the properties needed for the update

Field Name Required Type Description Format

name

String

globalPermissions

Set of Section 2.196

realmPermissions

X

Set of Section 2.241

policyPermissions

X

Set of Section 2.240

endEntityPermissions

X

Set of Section 2.239

certRequestPermissions

X

Set of Section 2.237

certificatePermissions

X

Set of Section 2.238

2.277. UpdateRoleResponseDto

Field Name Required Type Description Format

name

String

globalPermissions

Set of Section 2.196

realmPermissions

Set of Section 2.241

policyPermissions

Set of Section 2.240

endEntityPermissions

Set of Section 2.239

certRequestPermissions

Set of Section 2.237

certificatePermissions

Set of Section 2.238

2.278. 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]

2.279. UpdateSecurityIdentityRolesBatchResponseDto

Field Name Required Type Description Format

successful

Set of [UUID]

uuid

failed

Map of Section 2.2

2.280. UpdateSecurityIdentityRolesRequestDto

It includes all the roles to be associated with API client

Field Name Required Type Description Format

roles

X

Set of [string]

2.281. UpdateUserCertificateDetailsRequestDto

It includes the new user details

Field Name Required Type Description Format

organization

String

organizationalUnit

String

country

String

commonName

X

String

2.282. 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

2.283. 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

2.284. UserResponseDto

Field Name Required Type Description Format

id

UUID

uuid

securityIdentityType

SecurityIdentityType

certRequestAction

CertRequestAction

2.285. UserSearchRequestDto

It includes all the properties that can be used for searching

Field Name Required Type Description Format

simpleSearchTerm

String

2.286. ValidFor

Field Name Required Type Description Format

2.287. VerifyImportCaDto

Field Name Required Type Description Format

isRootCa

Boolean

rootFingerprint

String

2.288. VerifyImportCaResponseDto

Field Name Required Type Description Format

verifiedImportCaDtoList

List of Section 2.287

2.289. VerifyImportCertificatesRequestDto

It includes encoded certificates and the necessary metadata for it

Field Name Required Type Description Format

policyId

X

UUID

uuid

discoveredCertsInPem

List of Section 2.202

2.290. VerifyImportCertificatesResponseDto

Field Name Required Type Description Format

totalCertificatesToImport

Long

int64

2.291. VerifyTokenRequestDto

It includes the Token

Field Name Required Type Description Format

token

String

2.292. ZippedCertsBatchDto

Field Name Required Type Description Format

zipFileInBase64

String

filePassword

String

batchCertificateCreationErrorResponseDtoList

List of Section 2.10

batchCertCreationErrorsCount

Integer

int32

2.293. ZippedFileDto

Field Name Required Type Description Format

zipFileInBase64

String

3. API Permissions

This section contains an overview of all the available permissions a principal (user or api client) can possess in the application and their description. The global permissions exist globally in contrast to the other types of permissions that exist and are valid only conditionally on specific resources. For example, a user can have a Realm Permission for Realm A, but not for Ream B. In the endpoint description of each endpoint, a section is dedicated to the required permissions for that specific endpoint. These permissions are to be understood such that they apply to the involved resources during the call, inputs and outputs for example.

3.1. Global Permissions

Global permissions are not linked to a specific resource

Permission Description

ADMIN

Full permissions for all Realms and belonging resources (Policies, End Entities, Certificate Requests, Certificates), as well as full User/API Client permissions and maintenance operation(deletion of archived entities)

REALMS_FULL_READ

Permission to read all Realms and belonging resources (Policies, End Entities, Certificate Requests, Certificates)

REALMS_CREATE

Permission to create Realms

APICLIENTS_READ

Permission to read all API Clients

APICLIENTS_CREATE

Permission to create API Clients

APICLIENTS_UPDATE

Permission to update API Clients (name, default policy, …​)

APICLIENTS_DELETE

Permission to delete API Clients

USERS_READ

Permission to read all Users

USERS_CREATE

Permission to create Users

USERS_UPDATE

Permission to update Users (name, email, …​)

3.2. Realm Permissions

Realm permissions are always assigned to a specific Realm, specified by the Realm ID

Permission Description

FULL_READ

Permission to read the Realm and belonging resources (Policies, End Entities, Certificate Requests, Certificates)

READ

Permission to read the Realm

UPDATE

Permission to update and archive the Realm

POLICIES_READ

Permission to read all Policies within the Realm

POLICIES_CREATE

Permission to create Policies within the Realm

POLICIES_UPDATE

Permission to update Policies within the Realm

POLICIES_CERTS_READ

Permission to read all Certificates and Certificate Requests within the Realm

POLICIES_CERTS_CREATE

Permission to create Certificates/Certificate Requests within the Realm

POLICIES_CERTS_REVOKE

Permission to revoke a Certificate within the Realm. If your intended use case is to revoke all certificates in a realm, please also additionally set the FULL_READ permission to the user/api client.

POLICIES_CERTREQS_APPROVE

Permission to approve/decline a Certificate Request within the Realm

ENDENTITIES_READ

Permission to read all End Entities within the Realm

ENDENTITIES_CREATE

Permission to create End Entities within the Realm

ENDENTITIES_UPDATE

Permission to update End Entities within the Realm

3.3. Policy Permissions

Policy permissions are always assigned to a specific Policy, specified by the Policy ID

Permission Description

READ

Permission to read the Policy

UPDATE

Permission to update and archive the Policy, required for End Entity Password operations

CERTS_READ

Permission to read all Certificates and Certificate Requests connected with the policy

CERTS_CREATE

Permission to create a Certificate Request connected with the Policy

CERTS_REVOKE

Permission to revoke a Certificate connected with the Policy

CERTREQS_APPROVE

Permission to approve/decline Certificate Requests connected with the Policy

3.4. End Entity Permissions

End Entity permissions are always assigned to a specific End Entity, specified by the End Entity ID

Permission Description

READ

Permission to read the End Entity and set End Entity alias

UPDATE

Permission to update and archive the End Entity, required for end entity password operations

3.5. Certificate Permissions

Certificate Request permissions are always assigned to a specific Certificate Request, specified by the Certificate Request ID

Permission Description

READ

Permission to read the Certificate

REVOKE

Permission to revoke/decline and archive the Certificate

3.6. Certificate Request Permissions

Certificate permissions are always assigned to a specific Certificate, specified by the Certificate ID

Permission Description

READ

Permission to read the Certificate Request

APPROVE

Permission to approve/decline and archive the Certificate Request

4. API Error Codes

This section contains an overview of all the different application errors that can occur during an API call, their API Error codes, the default message of each error and its HTTP status code. A detailed overview of which errors can occur during what API calls is provided in each endpoint description.

Api Error Message HTTP Status

REALM_WITH_NAME_EXISTS

A realm with the provided name already exist

409 CONFLICT

REALM_NOT_FOUND

Realm does not exist

404 NOT_FOUND

REALM_NOT_FOUND_UNPROCESSABLE_ENTITY

Realm does not exist

422 UNPROCESSABLE_ENTITY

REALM_IS_ARCHIVED

Realm is archived

409 CONFLICT

REALM_IS_ALREADY_UNARCHIVED

Realm is already unarchived

409 CONFLICT

POLICY_NOT_FOUND

Policy does not exist

404 NOT_FOUND

POLICY_NOT_FOUND_UNPROCESSABLE_ENTITY

Policy does not exist

422 UNPROCESSABLE_ENTITY

API_CLIENT_NOT_FOUND

Api Client does not exist

404 NOT_FOUND

CERTIFICATE_NOT_FOUND

Certificate does not exist

404 NOT_FOUND

CERTIFICATE_NOT_FOUND_UNPROCESSABLE_ENTITY

Certificate does not exist

422 UNPROCESSABLE_ENTITY

CERTIFICATE_IS_ACTIVE

Certificate is active

409 CONFLICT

CERTIFICATE_IS_ARCHIVED

The Certificate is archived

409 CONFLICT

CERTIFICATE_IS_ALREADY_UNARCHIVED

The Certificate is already unarchived

409 CONFLICT

CERTIFICATE_REQUEST_NOT_FOUND

The Certificate Request doesn’t exist

404 NOT_FOUND

CERTIFICATE_REQUEST_NOT_FOUND_UNPROCESSABLE_ENTITY

The Certificate Request doesn’t exist

422 UNPROCESSABLE_ENTITY

END_ENTITY_NOT_FOUND

End entity does not exist

404 NOT_FOUND

END_ENTITY_NOT_FOUND_UNPROCESSABLE_ENTITY

End entity does not exist

422 UNPROCESSABLE_ENTITY

USER_NOT_FOUND

User does not exist

404 NOT_FOUND

AUTHENTICATED_PRINCIPAL_NOT_FOUND

Authenticated principal does not exist

404 NOT_FOUND

USER_NOT_FOUND_UNPROCESSABLE_ENTITY

User does not exist

422 UNPROCESSABLE_ENTITY

APPLICATION_USER_NOT_FOUND_UNPROCESSABLE_ENTITY

Application user does not exist

404 NOT_FOUND

MAIL_SETTINGS_NOT_FOUND

Mail Settings do not exist

404 NOT_FOUND

MAIL_SETTINGS_NOT_FOUND_INTERNAL_SERVER_ERROR

Mail Settings do not exist

500 INTERNAL_SERVER_ERROR

SYSTEM_REALM_SETTINGS_NOT_FOUND

System Realm Settings do not exist

404 NOT_FOUND

SYSTEM_REALM_SETTINGS_NOT_FOUND_UNPROCESSABLE_ENTITY

System Realm Settings do not exist

422 UNPROCESSABLE_ENTITY

SYSTEM_POLICY_SETTINGS_NOT_FOUND

System Policy Settings do not exist

404 NOT_FOUND

SYSTEM_POLICY_SETTINGS_NOT_FOUND_UNPROCESSABLE_ENTITY

System Policy Settings do not exist

422 UNPROCESSABLE_ENTITY

SYSTEM_POLICY_INVALID_REALM

System Policy must be defined inside SYSTEM realm

409 CONFLICT

CONFIGURATION_UPDATE_NOT_ALLOWED

Configuration update not allowed

409 CONFLICT

CONNECTION_SETTINGS_NOT_FOUND

Connection Settings do not exist

404 NOT_FOUND

INVALID_CONFIGURATION_VALUE

Configuration value is not valid

400 BAD_REQUEST

CONFIGURATION_NOT_FOUND

Configuration does not exist

404 NOT_FOUND

CONFIGURATION_ALREADY_EXISTS_FOR_THIS_SETTING

Configuration Setting already exists for this setting key

409 CONFLICT

PRIVATE_KEY_PASSWORD_POLICY_NOT_FOUND_UNPROCESSABLE_ENTITY

Private key password policy do not exist

422 UNPROCESSABLE_ENTITY

API_CLIENT_PASSWORD_POLICY_NOT_FOUND_UNPROCESSABLE_ENTITY

API client password policy do not exist

422 UNPROCESSABLE_ENTITY

END_ENTITY_PASSWORD_POLICY_NOT_FOUND_UNPROCESSABLE_ENTITY

End entity password policy do not exist

422 UNPROCESSABLE_ENTITY

PASSWORD_NOT_FOUND

Password for this End Entity and Policy does not exists

404 NOT_FOUND

MAILING_LIST_NOT_FOUND

Mailing list does not exist

404 NOT_FOUND

MAILING_LIST_NOT_FOUND_UNPROCESSABLE_ENTITY

Mailing list does not exist

422 UNPROCESSABLE_ENTITY

RA_CERTIFICATE_NOT_FOUND

Ra Certificate does not exist

500 INTERNAL_SERVER_ERROR

VERIFICATION_TOKEN_NOT_FOUND

VerificationToken does not exist

404 NOT_FOUND

POLICY_REALM_AND_END_ENTITY_REALM_MUST_BE_EQUAL

Policy Realm and End Entity Realm must be the same

422 UNPROCESSABLE_ENTITY

MAILING_LIST_ALREADY_EXISTS

A Mailing List with this name already exists

409 CONFLICT

MAILING_LIST_IS_ARCHIVED

Mailing List is archived

409 CONFLICT

MAILING_LIST_IS_ALREADY_UNARCHIVED

Mailing List is already unarchived

409 CONFLICT

REALM_NOT_FOUND_OR_DISABLED

Realm does not exist or is disabled

422 UNPROCESSABLE_ENTITY

END_ENTITY_NOT_FOUND_OR_ARCHIVED

End Entity does not exist or End Entity is archived

404 NOT_FOUND

END_ENTITY_NOT_FOUND_OR_ARCHIVED_UNPROCESSABLE_ENTITY

End Entity does not exist or End Entity is archived

422 UNPROCESSABLE_ENTITY

APPLICATION_USER_ALREADY_VOTED

This application user has already voted for the result

409 CONFLICT

CERTIFICATE_ALREADY_EXISTS_FOR_USER

A certificate already exists for the current user

409 CONFLICT

CERTIFICATE_REQUEST_IS_ALREADY_DECLINED

This Certificate Request has already been declined

409 CONFLICT

PARENT_ENTITY_IS_ARCHIVED

Parent entity is archived

409 CONFLICT

CA_NOT_FOUND

CA does not exist

404 NOT_FOUND

CA_IS_ARCHIVED

CA is archived

409 CONFLICT

CA_IS_ALREADY_UNARCHIVED

CA is already unarchived

409 CONFLICT

DEFAULT_POLICY_NOT_FOUND_INTO_SELECTED_REALMS

Default Policy must belong to one of the selected realms

422 UNPROCESSABLE_ENTITY

API_CLIENT_INITIALIZE_RANDOM_NUMBER_ENGINE_FAILED

Cannot initialize Random Number Engine

500 INTERNAL_SERVER_ERROR

CERTIFICATE_PROVIDER_NOT_FOUND

Certificate Provider does not exist

404 NOT_FOUND

CERTIFICATE_PROVIDER_NAME_EXISTS

Certificate Provider with provided name already exists

409 CONFLICT

UNSUPPORTED_METHOD_BY_CERTIFICATE_PROVIDER

The specified Certificate provider does not support this method

409 CONFLICT

CERTIFICATE_PROVIDER_IS_ALREADY_UNARCHIVED

Certificate Provider is already unarchived

409 CONFLICT

CERTIFICATE_PROVIDER_IS_ARCHIVED

Certificate Provider is archived

409 CONFLICT

CANNOT_ARCHIVE_A_CERTIFICATE_PROVIDER_THAT_IS_USED_BY_A_POLICY

Cannot archive a Certificate Provider that is used by a Policy

409 CONFLICT

INVALID_CERTIFICATE_PROVIDER_CONFIGURATION

Invalid Certificate Provider Configuration

422 UNPROCESSABLE_ENTITY

CERTIFICATE_PROVIDER_CONNECTION_FAILED

Connection with the Certificate Provider failed

422 UNPROCESSABLE_ENTITY

UNSUPPORTED_CERTIFICATE_PROVIDER_TYPE

Unsupported Certificate Provider type

422 UNPROCESSABLE_ENTITY

CREATE_CERTIFICATES_ZIP_FAILED

There was an error while creating the certificates zip file

500 INTERNAL_SERVER_ERROR

IMPORT_CERTIFICATE_FILE_CONTAINS_NON_EE

Provided file contains non-EE certificate

422 UNPROCESSABLE_ENTITY

CERTIFICATE_PROVIDER_DOES_NOT_SUPPORT_INSTANT_CERTIFICATE_ISSUANCE

Certificate Provider does not support instant certificate issuance

422 UNPROCESSABLE_ENTITY

CREATE_CERT_FAILED_CERTIFICATE_REQUEST_NOT_APPROVED

Cannot create new Certificate, Certificate Request is not approved

409 CONFLICT

CREATE_CERT_FAILED_CERTIFICATE_ALREADY_REQUESTED

Cannot create new certificate, certificate has been already requested

409 CONFLICT

CREATE_CERT_FAILED_POLICY_PERMISSION_REQUIRED

Not allowed to create certificates for this Policy

403 FORBIDDEN

CREATE_CERT_FAILED_REALM_ARCHIVED

Cannot create new Certificate in a Realm that is archived

409 CONFLICT

CARA_TEMPLATE_SIGNER_NOT_AVAILABLE

CARA Template Signer is not available

500 INTERNAL_SERVER_ERROR

CARA_TEMPLATE_DETAILS_LOAD_FAILED

Failed to load certificate template details from CA

500 INTERNAL_SERVER_ERROR

COMMON_NAME_CANNOT_BE_EMPTY

Common Name cannot be empty

422 UNPROCESSABLE_ENTITY

BATCH_CERTIFICATE_CREATION_COMMON_NAME_CANNOT_BE_EMPTY

Common Name cannot be empty

422 UNPROCESSABLE_ENTITY

MULTIPLE_CERTIFICATES_NOT_ALLOWED

There are already active certificates for specified End Entity. Revoke them and try again

422 UNPROCESSABLE_ENTITY

ERROR_WHILE_ENCODING_CERTIFICATE

There was an error while encoding the certificate

500 INTERNAL_SERVER_ERROR

RETRIEVE_CRL_FAILED

Failed to retrieve crl

500 INTERNAL_SERVER_ERROR

RETRIEVE_CA_CERTIFICATE_FAILED

Failed to retrieve CA cert from CARA

500 INTERNAL_SERVER_ERROR

CRYPTO_ALGORITHM_UNKNOWN

Unknown Crypto Algorithm

422 UNPROCESSABLE_ENTITY

PKCS10_ATTACHED_TO_CERTIFICATE_REQUEST_NOT_FOUND

This Pkcs10 is not attached to any Certificate Request

404 NOT_FOUND

CANNOT_CREATE_CERT_REQUEST_WITH_REALM_ARCHIVED

Cannot create new Cert Request in a Realm that is archived

409 CONFLICT

KEY_PAIR_INPUT_PARAMS_INVALID_COMBINATION

Invalid combination of key pair mode and input parameters

422 UNPROCESSABLE_ENTITY

VALUE_OF_RULE_PROPERTY_IS_MISSING

The value of a rule property is missing

422 UNPROCESSABLE_ENTITY

END_ENTITY_ALIAS_WITH_SAME_ALIAS_ALREADY_EXISTS

An End Entity Alias with the same Alias already exists

409 CONFLICT

KEY_PAIR_MODE_NOT_INCLUDED_IN_POLICY_ALLOWED_VALUES

Certificate Request key pair mode must be included in Policy allowed key pair modes

422 UNPROCESSABLE_ENTITY

SELF_SIGNED_NOT_ALLOWED_BY_POLICY

Certificate Request for self-signed certificate must be allowed by Policy

422 UNPROCESSABLE_ENTITY

INVALID_KEY_PAIR_MODE_SELF_SIGNED_COMBINATION

Provided key pair mode is not allowed on Certificate Request for self-signed Certificate

422 UNPROCESSABLE_ENTITY

KEY_GEN_PARAMS_NOT_INCLUDED_IN_CERT_REQUEST_WITH_SERVER_GEN

Certificate request with server generated KeyPairMode does not include key generation parameters

422 UNPROCESSABLE_ENTITY

PKCS10_NOT_INCLUDED_IN_CERT_REQUEST_WITH_PKCS10

Certificate request with PKCS10 KeyPairMode does not include a PKCS10

422 UNPROCESSABLE_ENTITY

PUBLIC_KEY_NOT_INCLUDED_IN_CERT_REQUEST_WITH_PUBLIC_KEY

Certificate request with public key KeyPairMode does not include a public key

422 UNPROCESSABLE_ENTITY

BATCH_CERTIFICATE_INVALID_REQUEST_PARAMETERS

Batch certificate creation request failed. Please see user manual to ensure request validity.

422 UNPROCESSABLE_ENTITY

VALIDITY_PERIOD_NOT_INCLUDED_IN_POLICY_ALLOWED_VALUES

Certificate Request validity period must be included in Policy allowed validity periods

422 UNPROCESSABLE_ENTITY

CRYPTOGRAPHIC_ALGORITHM_NOT_INCLUDED_IN_POLICY_RESTRICTIONS

Certificate Request cryptographic algorithm must be included in Policy cryptographic restrictions

422 UNPROCESSABLE_ENTITY

KEY_GENERATION_PARAMS_NOT_INCLUDED_IN_POLICY_RESTRICTIONS

Certificate Request key generation parameters must be included in Policy cryptographic restrictions

422 UNPROCESSABLE_ENTITY

END_ENTITY_COMMON_NAME_VALUE_NOT_ALLOWED

End Entity common name value is not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_COUNTRY_VALUE_NOT_ALLOWED

End Entity country value is not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_EMAIL_VALUE_NOT_ALLOWED

End Entity e-mail value is not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_ORGANIZATION_VALUE_NOT_ALLOWED

End Entity organization value is not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_ORGANIZATION_UNIT_VALUE_NOT_ALLOWED

End Entity organizational unit value is not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_DOMAIN_VALUES_NOT_ALLOWED

End Entity domain values are not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_IP_ADDRESS_VALUES_NOT_ALLOWED

End Entity IP address values are not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_GENERIC_DTO_VALUES_NOT_ALLOWED

End Entity generic dto values are not allowed

422 UNPROCESSABLE_ENTITY

END_ENTITY_KEYCLOAK_ATTRIBUTES_MISMATCH

User data in ID provider do not match with provided end entity

422 UNPROCESSABLE_ENTITY

IMPORT_CERTIFICATE_POLICY_IMPORT_NOT_ALLOWED

Certificate request policy must allow certificate(s) import

422 UNPROCESSABLE_ENTITY

IMPORT_CERTIFICATE_POLICY_INVALID_KEY_PAIR_MODE

Certificate request policy key pair modes must contain public key mode

422 UNPROCESSABLE_ENTITY

IMPORT_CERTIFICATE_CERTIFICATE_WITH_FINGERPRINT_EXISTS

Provided certificate already exists in system

409 CONFLICT

PKCS10_REQUEST_DETAILS_DO_NOT_MATCH_END_ENTITY

PKCS10 request details do not match with End Entity details

422 UNPROCESSABLE_ENTITY

CANNOT_ARCHIVE_A_CERTIFICATE_REQUEST_THAT_IS_CONNECTED_WITH_AN_ACTIVE_CERTIFICATE

Cannot archive a Certificate Request that is connected with an active Certificate

409 CONFLICT

CERTIFICATE_REQUEST_IS_ALREADY_APPROVED

This Certificate Request has already been approved

409 CONFLICT

CERTIFICATE_REQUEST_IS_ARCHIVED

This Certificate Request is archived

409 CONFLICT

CERTIFICATE_REQUEST_IS_ALREADY_UNARCHIVED

This Certificate Request is already unarchived

409 CONFLICT

RESEND_EMAIL_VERIFICATION_FAILED_STATUS_CHANGED

The Certificate Request status has already been modified

409 CONFLICT

VERIFICATION_TOKENS_NOT_FOUND

Verification tokens for the requested user and context do not exist

404 NOT_FOUND

PARSE_PKCS10_REQUEST_SIGNATURE_FAILED

Failed to parse PKCS10 Request Signature

500 INTERNAL_SERVER_ERROR

VERIFICATION_OF_PKCS10_SIGNATURE_WITH_PUBLIC_KEY_FAILED

PKCS10 Signature could not be verified with the included Public Key

500 INTERNAL_SERVER_ERROR

PARSE_PKCS10_PUBLIC_KEY_FAILED

Failed to parse PKCS10 Public Key

500 INTERNAL_SERVER_ERROR

VALID_RSA_BC_PUBLIC_KEY_NOT_FOUND

No valid RSA BC Public Key object found

422 UNPROCESSABLE_ENTITY

VALID_EC_BC_PUBLIC_KEY_NOT_FOUND

No valid EC BC Public Key object found

422 UNPROCESSABLE_ENTITY

PUBLIC_KEY_ALGORITHM_IN_PKCS10_NOT_SUPPORTED

Unsupported Public Key Algorithm in PKCS10

422 UNPROCESSABLE_ENTITY

PARSE_PKCS10_REQUEST_FAILED

Failed to parse PKCS10 Request

500 INTERNAL_SERVER_ERROR

CURVE_NAME_NOT_FOUND

Could not find name for curve

422 UNPROCESSABLE_ENTITY

CANNOT_DELETE_NON_ARCHIVED_ENTITY

Non archived entities cannot be deleted

409 CONFLICT

CANNOT_ARCHIVE_A_CA_THAT_IS_THE_ISSUER_OF_ANOTHER_CA

Cannot archive a CA that is the issuer of another CA

409 CONFLICT

CANNOT_ARCHIVE_A_CA_THAT_IS_CONNECTED_WITH_A_CERTIFICATE

Cannot archive a CA that is connected with a Certificate

409 CONFLICT

SUB_CA_ISSUER_NOT_FOUND_UNPROCESSABLE_ENTITY

Issuer CA does not exist in the system

422 UNPROCESSABLE_ENTITY

IMPORT_X509_INVALID_PEM_FILE_CONTENT

Provided file content is not in valid PEM format

422 UNPROCESSABLE_ENTITY

IMPORT_CA_FILE_CONTAINS_NON_CA

Provided file contains non-CA certificate

422 UNPROCESSABLE_ENTITY

IMPORT_CA_CA_ALREADY_IN_SYSTEM

Provided CA already exists in the system

422 UNPROCESSABLE_ENTITY

CANNOT_ARCHIVE_A_REALM_THAT_IS_CONNECTED_WITH_AN_ACTIVE_CERTIFICATE

Cannot archive a Realm that is connected with an active Certificate

409 CONFLICT

WRONG_ALGORITHM

Wrong or incompatible Signature Algorithm

422 UNPROCESSABLE_ENTITY

CMP_CONFIGURATION_NOT_FOUND

Cmp configuration does not exist

404 NOT_FOUND

CMP_CONFIGURATION_NOT_FOUND_UNPROCESSABLE_ENTITY

Cmp configuration does not exist

422 UNPROCESSABLE_ENTITY

CERTIFICATE_STRUCTURE_UNKNOWN

Invalid certificate structure

422 UNPROCESSABLE_ENTITY

END_ENTITY_BY_CERT_BYTES_NOT_FOUND

Found no end entities that belong to the provided cert bytes

404 NOT_FOUND

END_ENTITY_FOR_ALIAS_NOT_FOUND

There is no end entity with this alias

422 UNPROCESSABLE_ENTITY

DUPLICATED_END_ENTITY_EXTERNAL_ID

Cannot create an End Entity with the same External ID

409 CONFLICT

PASSWORD_ALREADY_EXISTS

Password for End Entity and Policy already exists

409 CONFLICT

CANNOT_ARCHIVE_AN_END_ENTITY_THAT_IS_CONNECTED_WITH_AN_ACTIVE_CERTIFICATE

Cannot archive an End Entity that is connected with an active Certificate

409 CONFLICT

INCORRECT_CREDENTIALS

Your credentials are incorrect

401 UNAUTHORIZED

END_ENTITY_IS_ALREADY_UNARCHIVED

The requested End Entity is already unarchived

409 CONFLICT

END_ENTITY_IS_ARCHIVED

The requested End Entity is archived

409 CONFLICT

POLICY_IS_ARCHIVED

The requested policy is archived

409 CONFLICT

POLICY_IS_ALREADY_UNARCHIVED

The requested Policy is already unarchived

409 CONFLICT

END_ENTITY_VALIDATION_ERROR

One or more end entities has a validations error

422 UNPROCESSABLE_ENTITY

VALID_PKCS10_REQUEST_OR_EE_FOR_STRATEGY_IS_REQUIRED

A valid PKCS10 request or End Entity is required for this strategy

422 UNPROCESSABLE_ENTITY

VALID_X509_CERTIFICATE_WITH_CN_IS_REQUIRED

A valid X509 Certificate with common name is required for this strategy

422 UNPROCESSABLE_ENTITY

VALID_PKCS10_REQUEST_OR_EE_WITH_EMAIL_FOR_STRATEGY_IS_REQUIRED

A valid PKCS10 request or End Entity with email is required for this strategy

422 UNPROCESSABLE_ENTITY

VALID_X509_CERTIFICATE_WITH_EMAIL_IS_REQUIRED

A valid X509 Certificate with email is required for this strategy

422 UNPROCESSABLE_ENTITY

ASN1_ENCODE_PKCS10_FAILED

Failed to ASN1 encode the PKCS10 subject

500 INTERNAL_SERVER_ERROR

PKCS10_MULTI_VALUED_RDN_FAILED

Not supporting multi-valued RDNs.

500 INTERNAL_SERVER_ERROR

VALID_EE_FOR_STRATEGY_IS_REQUIRED

A valid end entity is required for this strategy

422 UNPROCESSABLE_ENTITY

INVALID_STRATEGY_FOR_X509_CERTIFICATE

A PKCS10 strategy cannot be used with a X509 Certificate

422 UNPROCESSABLE_ENTITY

CRYPTO_ALGORITHMS_NOT_SUPPORTED

Unsupported Crypto Algorithm

422 UNPROCESSABLE_ENTITY

FILE_INVALID_NOT_PEM_ENCODED_PKCS10

The provided file is not a valid pem-encoded PKCS10 Request

422 UNPROCESSABLE_ENTITY

PARSING_FAILURE

Parsing of PKCS10 failed

500 INTERNAL_SERVER_ERROR

END_ENTITY_RULES_INVALID_REGEX

Invalid Regular Expression in End Entity Rules

422 UNPROCESSABLE_ENTITY

WRONG_CMP_CONFIGURATION

CMP configuration properties are empty or contain errors

422 UNPROCESSABLE_ENTITY

ENFORCE_ACTIVE_CERT_UNIQUENESS_TOLERANCE_IS_REQUIRED

Enforce active certificate uniqueness tolerance is required

422 UNPROCESSABLE_ENTITY

CMP_SIGNER_IS_NOT_VALID

CMP signer is not valid

422 UNPROCESSABLE_ENTITY

CMP_SIGNER_CERTIFICATE_CREATION_FAILED

Unable to create Certificate for the CMP signer

500 INTERNAL_SERVER_ERROR

INVALID_ALLOWED_KEY_PAIR_MODE

Allowed key pair modes specified are not valid

422 UNPROCESSABLE_ENTITY

INVALID_ALLOWED_CRYPTO_ALGORITHM

Allowed cryptographic algorithms specified are not valid

422 UNPROCESSABLE_ENTITY

SIGN_WITH_CARA_FAILED

An error occurred while signing with CARA

500 INTERNAL_SERVER_ERROR

DECRYPT_WITH_CARA_FAILED

An error occurred while decrypting data with CARA

500 INTERNAL_SERVER_ERROR

TEMPLATE_SIGNER_CERTIFICATE_NOT_FOUND_UNPROCESSABLE_ENTITY

Template signer certificate does not exist

422 UNPROCESSABLE_ENTITY

NDES_CA_CERTIFICATE_LOAD_FAILED

Failed to load CA certificates from NDES server.

500 INTERNAL_SERVER_ERROR

NDES_CLIENT_INIT_FAILED

Failed initialize NDES client.

500 INTERNAL_SERVER_ERROR

GLOBAL_SIGN_LOGIN_FAILED

Failed to login to Global Sign server.

500 INTERNAL_SERVER_ERROR

GLOBAL_SIGN_CERTIFICATE_LOAD_FAILED

Failed to load EE certificate from Global Sign server.

500 INTERNAL_SERVER_ERROR

GLOBAL_SIGN_TRUSTCHAIN_LOAD_FAILED

Failed to load CA Certificates trust chain from Global Sign server.

500 INTERNAL_SERVER_ERROR

GLOBAL_SIGN_CERTIFICATE_REVOKE_FAILED

An error occurred while revoking certificate with Global Sign

500 INTERNAL_SERVER_ERROR

GLOBAL_SIGN_CLIENT_INIT_FAILED

Failed initialize Global Sign client.

500 INTERNAL_SERVER_ERROR

MSCA_CERTIFICATE_LOAD_FAILED

Failed to load EE certificate from MSCA.

500 INTERNAL_SERVER_ERROR

MSCA_TRUSTCHAIN_LOAD_FAILED

Failed to load CA Certificates trust chain from MSCA.

500 INTERNAL_SERVER_ERROR

MSCA_CERTIFICATE_REVOKE_FAILED

An error occurred while revoking certificate with MSCA

500 INTERNAL_SERVER_ERROR

PSW_PUBLIC_CAS_ORDER_CREATION_FAILED

Failed to request Public CAs certificate.

500 INTERNAL_SERVER_ERROR

PSW_PUBLIC_CAS_ORDER_LOAD_FAILED

Failed to load certificate order from Public CAs server.

500 INTERNAL_SERVER_ERROR

PSW_PUBLIC_CAS_CERTIFICATE_LOAD_FAILED

Failed to load EE certificate from Public CAs server.

500 INTERNAL_SERVER_ERROR

CANNOT_ARCHIVE_A_POLICY_THAT_IS_CONNECTED_WITH_AN_ACTIVE_CERTIFICATE

Cannot archive a policy that is connected with an active Certificate

409 CONFLICT

POLICY_CERTIFICATE_PROVIDER_CONFIGURATION_IS_INVALID

Invalid Policy Certificate Provider Configuration

422 UNPROCESSABLE_ENTITY

EMAIL_VERIFICATION_FAILED_TOKEN_NOT_FOUND_OR_EXPIRED

E-mail verification failed, verification token does not exist or has expired

422 UNPROCESSABLE_ENTITY

EMAIL_VERIFICATION_FAILED_CERTIFICATE_REQUEST_NOT_FOUND

E-mail verification failed, Certificate Request does not exist

404 NOT_FOUND

EMAIL_VERIFICATION_FAILED_CERTIFICATE_REQUEST_STATUS_CHANGED

E-mail verification failed, Certificate Request has been modified

409 CONFLICT

RA_CERTIFICATE_CHAIN_ERROR

Error with Ra Certificate chain

500 INTERNAL_SERVER_ERROR

COULD_NOT_RETRIEVE_CA_CHAIN

CA Chain could not be retrieved

500 INTERNAL_SERVER_ERROR

TEMPLATE_SIGNER_NOT_FOUND

Template signer does not exist

404 NOT_FOUND

EMAIL_ALREADY_EXISTS

This email already exists

409 CONFLICT

PASSWORD_VALIDATION_FAILED

Password validation failed

422 UNPROCESSABLE_ENTITY

KEYSTORE_INVALID_KEY_PAIR_MODE

Key pair mode does not allow keystore retrieval.

422 UNPROCESSABLE_ENTITY

RETRIEVE_CURRENT_CARA_VCA_ID

Failed to retrieve the current CARA VCA id

500 INTERNAL_SERVER_ERROR

REQUEST_CERTIFICATE_FAILED

Error requesting certificate

500 INTERNAL_SERVER_ERROR

SENDING_CARA_REQUEST_ERROR

Error sending request to CARA service

500 INTERNAL_SERVER_ERROR

APPROVING_REQUEST_FAILED

Error approving request

500 INTERNAL_SERVER_ERROR

CREATE_X509_CERTIFICATE_FAILED

Error creating X509Certificate

500 INTERNAL_SERVER_ERROR

REVOKE_CARA_CERTIFICATE_FAILED

An error occurred while revoking certificate with Cara

500 INTERNAL_SERVER_ERROR

RETRIEVE_RA_CERTIFICATE_FAILED

An error occurred while retrieving an RA Certificate

500 INTERNAL_SERVER_ERROR

ENCODE_CERTIFICATE_FAILED

Failed to encode x509Certificate object

500 INTERNAL_SERVER_ERROR

INVALID_COUNTRY_CODE

Country code is not valid

400 BAD_REQUEST

PASSWORD_GENERATION_NOT_ALLOWED_BECAUSE_PASSWORD_IS_INSECURE

Insecure password generation is not allowed

422 UNPROCESSABLE_ENTITY

OPTIMISTIC_LOCKING_EXCEPTION

A newer version of the resource was found in the database

409 CONFLICT

KEY_PAIR_MODE_DB_DATA_SHOULD_NOT_BE_EMPTY

KeyPairMode database data could not be empty

422 UNPROCESSABLE_ENTITY

VALID_FOR_DB_DATA_SHOULD_NOT_BE_EMPTY

ValidFor database data could not be empty

422 UNPROCESSABLE_ENTITY

VALID_PKCS10_REQUEST_FOR_STRATEGY_IS_REQUIRED

A valid PKCS10 request is required for this strategy

422 UNPROCESSABLE_ENTITY

CONSTANT_FOR_ENUM_NOT_FOUND

No such Enum Constant was found

404 NOT_FOUND

DOWNLOAD_CRL_FROM_CERTIFICATE_FAILED

Failed to download crl

500 INTERNAL_SERVER_ERROR

AVAILABLE_MAIL_SETTINGS_NOT_FOUND_UNPROCESSABLE_ENTITY

There are no mail settings available

422 UNPROCESSABLE_ENTITY

HTTP_URL_IN_CERTIFICATE_NOT_SPECIFIED

Did not specify an HTTP URL in certificate

500 INTERNAL_SERVER_ERROR

QUERY_OCSP_FAILED

Failed to query OCSP

500 INTERNAL_SERVER_ERROR

PARSE_OCSP_RESPONSE_FAILED

Failed to parse OCSP Response

500 INTERNAL_SERVER_ERROR

OCSP_QUERY_NOT_SUCCESSFUL

OCSP Query was unsuccessful

500 INTERNAL_SERVER_ERROR

NO_AVAILABLE_RESPONSE_BYTES

No responseBytes available

500 INTERNAL_SERVER_ERROR

UNSUPPORTED_RESPONSE_TYPE

Unsupported response type

500 INTERNAL_SERVER_ERROR

OCSP_RESPONSE_NOT_A_BASIC_OCSP_RESPONSE

Not a BasicOCSPResponse

500 INTERNAL_SERVER_ERROR

OCSP_RESPONSE_VERIFICATION_FAILED

OCSP Response Verification failed

500 INTERNAL_SERVER_ERROR

OCSP_RESPONSE_TOO_OLD

OCSP Response is too old

500 INTERNAL_SERVER_ERROR

NO_MATCHING_SINGLE_RESPONSE

No matching single response

500 INTERNAL_SERVER_ERROR

UNKNOWN_OCSP_CERT_STATUS

Unknown ocsp cert status

500 INTERNAL_SERVER_ERROR

RESPONSE_NONCE_MISSING

ResponseNonce is missing

500 INTERNAL_SERVER_ERROR

NONCE_VALUES_MISMATCH

Mismatch of nonce values

500 INTERNAL_SERVER_ERROR

VERIFY_RESPONSE_DATA_FAILED

The verification of the ResponseData failed

500 INTERNAL_SERVER_ERROR

RA_AUTHENTICATION_TOKEN_TYPE_NOT_SUPPORTED

Unsupported RaAuthenticationToken type

500 INTERNAL_SERVER_ERROR

AUTHENTICATION_FAILED

Failed to Authenticate

401 UNAUTHORIZED

MAC_CALCULATION_FAILED

Failed to calculate MAC

500 INTERNAL_SERVER_ERROR

COPY_END_ENTITY_FAILED

Copy process of the End Entity failed

500 INTERNAL_SERVER_ERROR

ENCODE_BASE_64_CERTIFICATE_FAILED

Encoding process of Base64 Certificate failed

500 INTERNAL_SERVER_ERROR

PAGINATION_UTILS_ERROR_UTILITY_CLASS

Utility class

500 INTERNAL_SERVER_ERROR

ACCESS_DENIED

Access denied

403 FORBIDDEN

BAD_CREDENTIALS

There was an error regarding the provided credentials

401 UNAUTHORIZED

INVALID_TYPE_OF_ARGUMENT

Provided argument is of invalid type

400 BAD_REQUEST

BAD_REQUEST

Bad Request

400 BAD_REQUEST

INPUT_VALIDATION_FAILED

Input is not valid

400 BAD_REQUEST

REQUESTED_ENTITY_IS_ARCHIVED

The requested entity is archived.

409 CONFLICT

UNMAPPED_REQUEST_URL

The request URL is not mapped to an endpoint

404 NOT_FOUND

UNKNOWN_ERROR

Unknown Error

500 INTERNAL_SERVER_ERROR

METHOD_NOT_ALLOWED

Method not allowed

405 METHOD_NOT_ALLOWED

MEDIA_NOT_SUPPORTED

Media not supported

415 UNSUPPORTED_MEDIA_TYPE

OIDC_PROVIDER_USER_REGISTER_CONFLICT

Username or E-Mail already exists in OpenID Connect Provider

409 CONFLICT

OIDC_PROVIDER_CLIENT_REGISTER_CONFLICT

A client with the same client id already exists

409 CONFLICT

CLIENT_NOT_FOUND

Could not find client

404 NOT_FOUND

CLIENT_SERVICE_ACCOUNT_NOT_ENABLED

Client not enabled to retrieve service account

409 CONFLICT

OIDC_PROVIDER_CONNECTION_ERROR

Unable to connect to open ID connect provider

502 BAD_GATEWAY

OIDC_PROPERTY_VALUE_MISSING

Open ID Connect Provider property value is missing

500 INTERNAL_SERVER_ERROR

OIDC_MIGRATION_FAILED

Please contact with the manufacturer.

500 INTERNAL_SERVER_ERROR

OIDC_PROVIDER_REGENERATE_CLIENT_SECRET_FAILED

Unable to regenerate OpenIDConnect client’s secret

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_USER_ROLES_FAILED

Unable to retrieve OpenIDConnect user roles

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_USER_COUNT_FAILED

Unable to retrieve OpenIDConnect user count

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_USER_FAILED

Unable to retrieve specified OpenIDConnect user

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_REALM_ROLE_FAILED

Unable to retrieve specified realm role

502 BAD_GATEWAY

OIDC_PROVIDER_REALM_ROLE_ASSIGNMENT_TO_USER_FAILED

Unable to add realm role to OpenIDConnect user

502 BAD_GATEWAY

OIDC_PROVIDER_REALM_ROLE_REMOVAL_FROM_USER_FAILED

Unable to remove realm role from OpenIDConnect user

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_CLIENT_FAILED

Unable to retrieve specified OpenIDConnect client

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_CLIENT_SERVICE_ACCOUNT_FAILED

Unable to retrieve specified OpenIDConnect client service account

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_ALL_USERS_FAILED

Unable to retrieve all OpenIDConnect users

502 BAD_GATEWAY

OIDC_PROVIDER_USER_CREATION_FAILED

Unable to create OpenIDConnect user

502 BAD_GATEWAY

OIDC_PROVIDER_USER_UPDATE_FAILED

Unable to update specified OpenIDConnect user

502 BAD_GATEWAY

OIDC_PROVIDER_USER_DELETION_FAILED

Unable to delete specified OpenIDConnect user

502 BAD_GATEWAY

OIDC_PROVIDER_SEND_EMAIL_TO_USER_FAILED

Unable to send email to specified OpenIDConnect user

502 BAD_GATEWAY

OIDC_PROVIDER_REALM_ROLE_NOT_FOUND

Unable to find specified realm role

404 NOT_FOUND

OIDC_PROVIDER_RETRIEVE_ALL_CLIENTS_FAILED

Unable to retrieve all OpenIDConnect clients

502 BAD_GATEWAY

OIDC_PROVIDER_CLIENT_CREATION_FAILED

Unable to create OpenIDConnect client

502 BAD_GATEWAY

OIDC_PROVIDER_CLIENT_UPDATE_FAILED

Unable to update specified OpenIDConnect client

502 BAD_GATEWAY

OIDC_PROVIDER_CLIENT_DELETION_FAILED

Unable to delete specified OpenIDConnect client

502 BAD_GATEWAY

OIDC_PROVIDER_LOGIN_FAILED

Unable to log in to OpenIDConnect

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_ROLE_USERS_FAILED

Unable to retrieve OpenIDConnect users with specified realm role

502 BAD_GATEWAY

OIDC_PROVIDER_RETRIEVE_USER_ROLE_MAPPINGS_FAILED

Unable to retrieve OpenIDConnect user role mappings

502 BAD_GATEWAY

MIGRATION_FAILED

Please contact with the manufacturer.

500 INTERNAL_SERVER_ERROR

API_CLIENT_NOT_FOUND_UNPROCESSABLE_ENTITY

Api Client does not exist

409 CONFLICT

ROLES_NOT_ENABLED

Roles not enabled to retrieve

409 CONFLICT

VERSION_OF_REQUEST_NOT_FOUND_SINCE

The request that was triggered was not found. It is available in a later version

404 NOT_FOUND

VERSION_OF_REQUEST_NOT_FOUND_REMOVED

The request that was triggered was not found. It has been removed in an earlier version

404 NOT_FOUND

SCHEDULER_ERROR

There was an error with the scheduler

500 INTERNAL_SERVER_ERROR

INVALID_VERSION_FORMAT

Invalid API version string used in the request for version, it must be of format 'v1'

400 BAD_REQUEST

CSV_PARSING_ERROR

There was an error with parsing the csv file.

500 INTERNAL_SERVER_ERROR

EXCEPTION_GENERATION_ERROR

There was an error generating the API exception

500 INTERNAL_SERVER_ERROR

MISSING_CONFIGURATION_VALUE

Configuration value is missing

422 UNPROCESSABLE_ENTITY

CONFIGURATION_VALUE_MAX_LENGTH_EXCEEDED

Configuration value cannot be more than 1000 characters long

422 UNPROCESSABLE_ENTITY

SEND_CERTIFICATE_EMAIL_FAILED_MISSING_EMAIL_ADDRESS

Certificate E-Mail failed, End Entity is missing E-Mail address

422 UNPROCESSABLE_ENTITY

CHECK_CONFIGURATION_EMAIL_FAILED_MISSING_USER_EMAIL

Failed to send test E-Mail, User E-Mail address is missing

422 UNPROCESSABLE_ENTITY

CHECK_CONFIGURATION_EMAIL_FAILED_API_CLIENT_NOT_SUPPORTED

Functionality for sending test E-Mail is not supported for API Clients

422 UNPROCESSABLE_ENTITY

CRYPTO_MODULE_WITH_NAME_EXISTS

A crypto module with the provided name already exists

409 CONFLICT

CRYPTO_MODULE_BUILT_IN_PASSWORD_MISSING

Password for built-in crypto module is missing

422 UNPROCESSABLE_ENTITY

INVALID_CRYPTO_MODULE_CONFIGURATION

Invalid crypto module configuration

422 UNPROCESSABLE_ENTITY

CRYPTO_MODULE_NOT_FOUND

Crypto module does not exist

404 NOT_FOUND

CRYPTO_MODULE_CREATE_KEY_PAIR_ERROR

Crypto module failed to create keypair

500 INTERNAL_SERVER_ERROR

CRYPTO_MODULE_CREATE_SECURE_RANDOM_ERROR

Crypto module failed to create secure random generator

500 INTERNAL_SERVER_ERROR

CRYPTO_MODULE_SERVICE_IMPROPER_CONFIGURATION

Crypto module has not been configured properly

422 UNPROCESSABLE_ENTITY

CRYPTO_MODULE_IS_ARCHIVED

Crypto module is archived

409 CONFLICT

CRYPTO_MODULE_ENCRYPT_DATA_ERROR

Crypto module failed to encrypt data

500 INTERNAL_SERVER_ERROR

CRYPTO_MODULE_DECRYPT_ENVELOPED_DATA_ERROR

Crypto module failed to decrypt CMS enveloped data

500 INTERNAL_SERVER_ERROR

CRYPTO_MODULE_ALREADY_ARCHIVED

Crypto module is already archived

409 CONFLICT

CRYPTO_MODULE_ALREADY_UNARCHIVED

Crypto module is already unarchived

409 CONFLICT

ACTIVE_CRYPTO_MODULE_CANNOT_BE_ARCHIVED

Current active crypto module cannot be archived

422 UNPROCESSABLE_ENTITY

ACTIVE_CRYPTO_MODULE_NOT_CONFIGURED

Active crypto module is not configured

422 UNPROCESSABLE_ENTITY

ACTIVE_CRYPTO_MODULE_NOT_CONFIGURED_CORRECTLY

Active crypto module is not configured properly

422 UNPROCESSABLE_ENTITY

PRIVATE_KEY_CANNOT_BE_DECRYPTED

Private key cannot be decrypted, no connected crypto module found

422 UNPROCESSABLE_ENTITY

PRIVATE_KEY_CANNOT_BE_RETRIEVED_FROM_PROVIDER

Private key cannot be retrieved from certificate provider

422 UNPROCESSABLE_ENTITY

ROLE_NOT_FOUND

Role does not exist

404 NOT_FOUND

ROLE_NOT_FOUND_UNPROCESSABLE_ENTITY

Role does not exist

422 UNPROCESSABLE_ENTITY

ROLE_WITH_NAME_EXISTS

A role with the provided name already exists

409 CONFLICT

ROLE_NAME_DOES_NOT_CONTAIN_CLM_PREFIX

Role name does not contain CLM_ prefix

400 BAD_REQUEST

CANNOT_DELETE_ROLE_ADMIN

Role CLM_ADMIN cannot be deleted

409 CONFLICT

CANNOT_UPDATE_ROLE_ADMIN

Role CLM_ADMIN cannot be edited

409 CONFLICT

CREATE_ROLE_WITHOUT_PROVIDING_PERMISSIONS

Unable to create new role without any permissions

400 BAD_REQUEST

UPDATE_ROLE_WITHOUT_PROVIDING_PERMISSIONS

Unable to update new role without any permissions

400 BAD_REQUEST