API Documentation

ImportCertificatesRequestDto

1.6.10.3. Content Type

application/json

1.6.10.4. Responses

Table 33. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Role names Found	GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

1.6.11.2. Return Type

ImportCertificatesResponseDto

1.6.11.3. Content Type

application/json

1.6.11.4. Responses

Table 34. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]
201	Certificates imported	ImportCertificatesResponseDto[ImportCertificatesResponseDto]

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

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

null

1.6.12.1.2. Body Parameter

Name

Description

Required

Default

Pattern

EmailDto

EmailDto

1.6.12.2. Return Type

1.6.12.3. Content Type

application/json

1.6.12.4. Responses

Table 35. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
204	E-Mail verification sent	<<>>
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

GetCertReqResponseDtoPage

1.6.13.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

1.6.13.3. Content Type

application/json

1.6.13.4. Responses

Table 36. http response codes
Code	Message	Datatype
200	Certificate Requests Found	GetCertReqResponseDtoPage[GetCertReqResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CertReqSearchRequestDto

1.6.14.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetCertReqResponseDtoPage

1.6.14.3. Content Type

application/json

1.6.14.4. Responses

Table 37. http response codes
Code	Message	Datatype
200	Certificate Requests Found	GetCertReqResponseDtoPage[GetCertReqResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

VerifyImportCertificatesRequestDto

1.6.15.2. Return Type

VerifyImportCertificatesResponseDto

1.6.15.3. Content Type

application/json

1.6.15.4. Responses

Table 38. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Import certificates request verified	VerifyImportCertificatesResponseDto[VerifyImportCertificatesResponseDto]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.7.1.2. Return Type

CreateCertificateResponseDto

1.7.1.3. Content Type

application/json

1.7.1.4. Responses

Table 39. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
201	Certificate Created	CreateCertificateResponseDto[CreateCertificateResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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]

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

CreateMultipleCertificateFromCertRequestsResponseDto

1.7.2.3. Content Type

application/json

1.7.2.4. Responses

Table 40. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
201	Certificates Created	CreateMultipleCertificateFromCertRequestsResponseDto[CreateMultipleCertificateFromCertRequestsResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the Policy for which the CA chain is requested

null

1.7.3.2. Return Type

CaCertificatePemDto

1.7.3.3. Content Type

application/json

1.7.3.4. Responses

Table 41. http response codes
Code	Message	Datatype
200	Policy CA chain downloaded successfully	CaCertificatePemDto[CaCertificatePemDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

1.7.4.2. Return Type

CertificatePemDto

1.7.4.3. Content Type

application/json

1.7.4.4. Responses

Table 42. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Downloaded	CertificatePemDto[CertificatePemDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

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

null

1.7.5.2. Return Type

CertificatePemDto

1.7.5.3. Content Type

application/json

1.7.5.4. Responses

Table 43. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Chain Downloaded	CertificatePemDto[CertificatePemDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

1.7.6.2. Return Type

CertificatePrivateKeyPemDto

1.7.6.3. Content Type

application/json

1.7.6.4. Responses

Table 44. http response codes
Code	Message	Datatype
200	Certificate private key downloaded	CertificatePrivateKeyPemDto[CertificatePrivateKeyPemDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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]

null

1.7.7.2. Return Type

ZippedFileDto

1.7.7.3. Content Type

application/json

1.7.7.4. Responses

Table 45. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Certificates Downloaded	ZippedFileDto[ZippedFileDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

1.7.8.2. Return Type

CrlDto

1.7.8.3. Content Type

application/json

1.7.8.4. Responses

Table 46. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate's crl downloaded	CrlDto[CrlDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the Certificate that will be sent to the Certificate's End Entity E-Mail

null

1.7.9.2. Return Type

1.7.9.3. Content Type

application/json

1.7.9.4. Responses

Table 47. http response codes
Code	Message	Datatype
204	Certificate E-Mail sent	<<>>
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

1.7.10.2. Return Type

GetAuditEventResponseDtoList

1.7.10.3. Content Type

application/json

1.7.10.4. Responses

Table 48. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate's Audit Events Found	GetAuditEventResponseDtoList[GetAuditEventResponseDtoList]

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

null

1.7.11.2. Return Type

GetCertificateResponseDto

1.7.11.3. Content Type

application/json

1.7.11.4. Responses

Table 49. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Found Certificate	GetCertificateResponseDto[GetCertificateResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

GetCertByIssuerDnBinAndSnDto

1.7.12.2. Return Type

GetCertificateResponseDto

1.7.12.3. Content Type

application/json

1.7.12.4. Responses

Table 50. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Found Certificate	GetCertificateResponseDto[GetCertificateResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

1.7.13.2. Return Type

GetCertificateResponseDto

1.7.13.3. Content Type

application/json

1.7.13.4. Responses

Table 51. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Found Certificate	GetCertificateResponseDto[GetCertificateResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.7.14.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

1.7.14.3. Content Type

application/json

1.7.14.4. Responses

Table 52. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Found Certificates	GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the Certificate that will be used to fetch role names with access to it

null

1.7.15.2. Return Type

1.7.15.3. Content Type

application/json

1.7.15.4. Responses

Table 53. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Role names Found	GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

1.7.16.2. Return Type

OcspStatusCheckDto

1.7.16.3. Content Type

application/json

1.7.16.4. Responses

Table 54. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	OCSP status of Certificate Found	OcspStatusCheckDto[OcspStatusCheckDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.7.17.1.2. Query Parameters

Name

Description

Required

Default

Pattern

size

The limit of the requested expiring Certificates

null

1.7.17.2. Return Type

MarkCertificatesAsRevokedRequestDto

1.7.17.3. Content Type

application/json

1.7.17.4. Responses

Table 55. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Expiring soon Certificates for the Realm Found	GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

1.7.18.2. Return Type

1.7.18.3. Content Type

application/json

1.7.18.4. Responses

Table 56. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
204	Certificates Marked As Revoked	<<>>
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

1.7.19.2. Return Type

KeystoreFileDto

1.7.19.3. Content Type

application/json

1.7.19.4. Responses

Table 57. http response codes
Code	Message	Datatype
200	P12 Certificate Retrieved	KeystoreFileDto[KeystoreFileDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the desired Certificate

null

revocationReason

The reason of the revoke

null

1.7.20.2. Return Type

RevokeCertificateResponseDto

1.7.20.3. Content Type

application/json

1.7.20.4. Responses

Table 58. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Revoked	RevokeCertificateResponseDto[RevokeCertificateResponseDto]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

RevokeCertificateRequestDto

1.7.21.2. Return Type

RevokeMultipleCertificateResponseDto

1.7.21.3. Content Type

application/json

1.7.21.4. Responses

Table 59. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Certificates Revoked	RevokeMultipleCertificateResponseDto[RevokeMultipleCertificateResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

1.7.22.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

CertificateSearchRequestDto

1.7.22.3. Content Type

application/json

1.7.22.4. Responses

Table 60. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Found Certificates	GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

1.7.23.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

CertificateValidationResponseDto

1.7.23.3. Content Type

application/json

1.7.23.4. Responses

Table 61. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Found Certificates	GetCertificateResponseDtoPage[GetCertificateResponseDtoPage]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

RawPemCertificateDto

1.7.24.2. Return Type

1.7.24.3. Content Type

application/json

1.7.24.4. Responses

Table 62. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate is validated	CertificateValidationResponseDto[CertificateValidationResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

RawPemCertificateDto

1.7.25.2. Return Type

CertificatePlainValidationResponseDto

1.7.25.3. Content Type

application/json

1.7.25.4. Responses

Table 63. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate is validated	CertificatePlainValidationResponseDto[CertificatePlainValidationResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of Certificate Provider that will be checked for connection

null

1.8.1.2. Return Type

CheckCertificateProviderConnectionDto

1.8.1.3. Content Type

application/json

1.8.1.4. Responses

Table 64. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Provider connected Checked	CheckCertificateProviderConnectionDto[CheckCertificateProviderConnectionDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreateCertificateProviderRequestDto

1.8.2.2. Return Type

CreateCertificateProviderResponseDto

1.8.2.3. Content Type

application/json

1.8.2.4. Responses

Table 65. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
201	Created Certificate Provider	CreateCertificateProviderResponseDto[CreateCertificateProviderResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the requested Certificate Provider

null

1.8.3.2. Return Type

GetCertificateProviderResponseDto

1.8.3.3. Content Type

application/json

1.8.3.4. Responses

Table 66. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Found Certificate Provider	GetCertificateProviderResponseDto[GetCertificateProviderResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

CertificateProviderSearchRequestDto

1.8.4.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetCertificateProviderResponseDtoPage

1.8.4.3. Content Type

application/json

1.8.4.4. Responses

Table 67. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Providers Found	GetCertificateProviderResponseDtoPage[GetCertificateProviderResponseDtoPage]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

CertificateProviderSearchRequestDto

1.8.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetCertificateProviderMinimalResponseDtoPage

1.8.5.3. Content Type

application/json

1.8.5.4. Responses

Table 68. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Providers Found	GetCertificateProviderMinimalResponseDtoPage[GetCertificateProviderMinimalResponseDtoPage]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of Certificate Provider that will be updated

null

1.8.6.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateCertificateProviderRequestDto

UpdateCertificateProviderRequestDto

1.8.6.2. Return Type

UpdateCertificateProviderResponseDto

1.8.6.3. Content Type

application/json

1.8.6.4. Responses

Table 69. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Provider Updated	UpdateCertificateProviderResponseDto[UpdateCertificateProviderResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the Certificate Provider for which the Template Signers are requested

null

1.9.1.2. Return Type

CaraTemplateSignerDtoList

1.9.1.3. Content Type

application/json

1.9.1.4. Responses

Table 70. http response codes
Code	Message	Datatype
200	Template Signers Found	CaraTemplateSignerDtoList[CaraTemplateSignerDtoList]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the Certificate Provider for which the MS CA Templates are requested

null

1.9.2.2. Return Type

MscaTemplatesResponseDto

1.9.2.3. Content Type

application/json

1.9.2.4. Responses

Table 71. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
200	MS CA Templates Found	MscaTemplatesResponseDto[MscaTemplatesResponseDto]

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 of the Certificate Provider for which the products are requested

null

1.9.3.2. Return Type

PublicCAsProductsResponseDto

1.9.3.3. Content Type

application/json

1.9.3.4. Responses

Table 72. http response codes
Code	Message	Datatype
200	Public CAs Products Found	PublicCAsProductsResponseDto[PublicCAsProductsResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the Certificate Provider for which the Template Signers are requested

null

1.9.4.2. Return Type

CaraTemplateSignerDtoList

1.9.4.3. Content Type

application/json

1.9.4.4. Responses

Table 73. http response codes
Code	Message	Datatype
200	Template Signers Found	CaraTemplateSignerDtoList[CaraTemplateSignerDtoList]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

CmpCalculateMacRequestDto

1.10.1.2. Return Type

CmpCalculateMacResponseDto

1.10.1.3. Content Type

application/json

1.10.1.4. Responses

Table 74. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Mac calculation operation was completed without errors. See response for verification result.	CmpCalculateMacResponseDto[CmpCalculateMacResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.10.2.2. Return Type

GetCmpConfigurationResponseDto

1.10.2.3. Content Type

application/json

1.10.2.4. Responses

Table 75. http response codes
Code	Message	Datatype
200	CMP configuration Found	GetCmpConfigurationResponseDto[GetCmpConfigurationResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

CmpSignRequestDto

1.10.3.2. Return Type

SignDataResponseDto

1.10.3.3. Content Type

application/json

1.10.3.4. Responses

Table 76. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Data signed	SignDataResponseDto[SignDataResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

1.10.4. verifyMac

POST /api/v1/cmp/verify-mac

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

1.10.4.1. Parameters

1.10.4.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CmpVerifyMacRequestDto

CmpVerifyMacRequestDto

1.10.4.2. Return Type

CmpVerifyMacResponseDto

1.10.4.3. Content Type

application/json

1.10.4.4. Responses

Table 77. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Mac verify operation was completed without errors. See response for verification result.	CmpVerifyMacResponseDto[CmpVerifyMacResponseDto]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 78. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
204	The Configuration E-Mail connection was checked successfully	<<>>
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

CreateConfigurationRequestDto

1.11.2.2. Return Type

CreateConfigurationResponseDto

1.11.2.3. Content Type

application/json

1.11.2.4. Responses

Table 79. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
201	Configuration Created	CreateConfigurationResponseDto[CreateConfigurationResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.11.3.1.2. Query Parameters

Name

Description

Required

Default

Pattern

version

The version of the resource that will be deleted

null

1.11.3.2. Return Type

1.11.3.3. Content Type

application/json

1.11.3.4. Responses

Table 80. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
204	Configuration Deleted	<<>>
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.11.4.2. Return Type

GetConfigurationResponseDto

1.11.4.3. Content Type

application/json

1.11.4.4. Responses

Table 81. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
200	Configuration Found	GetConfigurationResponseDto[GetConfigurationResponseDto]

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

SearchConfigurationRequestDto

1.11.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetConfigurationResponseDtoPage

1.11.5.3. Content Type

application/json

1.11.5.4. Responses

Table 82. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Found Configuration	GetConfigurationResponseDtoPage[GetConfigurationResponseDtoPage]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

UpdateConfigurationRequestDto

1.11.6.2. Return Type

UpdateConfigurationResponseDto

1.11.6.3. Content Type

application/json

1.11.6.4. Responses

Table 83. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Configuration Updated	UpdateConfigurationResponseDto[UpdateConfigurationResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

UpdateConfigurationBatchRequestDto

1.11.7.2. Return Type

UpdateConfigurationBatchResponseDto

1.11.7.3. Content Type

application/json

1.11.7.4. Responses

Table 84. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Configuration values Updated	UpdateConfigurationBatchResponseDto[UpdateConfigurationBatchResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreateCryptoModuleRequestDto

1.12.1.2. Return Type

CreateCryptoModuleResponseDto

1.12.1.3. Content Type

application/json

1.12.1.4. Responses

Table 85. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
201	Created Crypto Module	CreateCryptoModuleResponseDto[CreateCryptoModuleResponseDto]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

The ID of the requested Crypto Module

null

1.12.2.2. Return Type

GetCryptoModuleResponseDto

1.12.2.3. Content Type

application/json

1.12.2.4. Responses

Table 86. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Crypto Module found	GetCryptoModuleResponseDto[GetCryptoModuleResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.12.3.2. Return Type

GetCryptoModuleHealthCheckResponseDto

1.12.3.3. Content Type

application/json

1.12.3.4. Responses

Table 87. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Health check for crypto module performed	GetCryptoModuleHealthCheckResponseDto[GetCryptoModuleHealthCheckResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CryptoModuleSearchRequestDto

1.12.4.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetCryptoModuleResponseDtoPage

1.12.4.3. Content Type

application/json

1.12.4.4. Responses

Table 88. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Crypto Modules found	GetCryptoModuleResponseDtoPage[GetCryptoModuleResponseDtoPage]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreateEndEntityRequestDto

1.13.1.2. Return Type

CreateEndEntityResponseDto

1.13.1.3. Content Type

application/json

1.13.1.4. Responses

Table 89. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
201	Created End Entity	CreateEndEntityResponseDto[CreateEndEntityResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

FindEeByCertBytesRequestDto

1.13.2.2. Return Type

EndEntityDatasetRequestDto

1.13.2.3. Content Type

application/json

1.13.2.4. Responses

Table 90. http response codes
Code	Message	Datatype
200	Found End Entity	GetEndEntityResponseDto[GetEndEntityResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.13.3.1.2. Body Parameter

Name

Description

Required

Default

Pattern

EndEntityDatasetRequestDto

1.13.3.2. Return Type

1.13.3.3. Content Type

application/json

1.13.3.4. Responses

Table 91. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	End Entity found by Policy and dataset	GetEndEntityResponseDto[GetEndEntityResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

1.13.4. findEndEntityByPolicyIdAndPkcs10

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

Find End Entity by Policy and PKCS10

1.13.4.1. Parameters

1.13.4.1.1. Path Parameters

Name

Description

Required

Default

Pattern

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

null

1.13.4.1.2. Body Parameter

Name

Description

Required

Default

Pattern

Pkcs10Dto

Pkcs10Dto

1.13.4.2. Return Type

1.13.4.3. Content Type

application/json

1.13.4.4. Responses

Table 92. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	End Entity found by Policy and PKCS10	GetEndEntityResponseDto[GetEndEntityResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

1.13.5. getEndEntity

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

Get End Entity by Id

1.13.5.1. Parameters

1.13.5.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of End Entity to be searched

null

1.13.5.2. Return Type

1.13.5.3. Content Type

application/json

1.13.5.4. Responses

Table 93. http response codes
Code	Message	Datatype
200	Found End Entity	GetEndEntityResponseDto[GetEndEntityResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

1.13.6. getEndEntityByRealmIdAndExternalId

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

Get End Entity by Realm and External Id

1.13.6.1. Parameters

1.13.6.1.1. Path Parameters

Name

Description

Required

Default

Pattern

realmId

Id of Realm to be searched

null

externalId

Id of External to be searched

null

1.13.6.2. Return Type

1.13.6.3. Content Type

application/json

1.13.6.4. Responses

Table 94. http response codes
Code	Message	Datatype
200	Found End Entity	GetEndEntityResponseDto[GetEndEntityResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

1.13.7. getNameOfRolesWithEndEntityAccess

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

Get role names of respective end entity

1.13.7.1. Parameters

1.13.7.1.1. Path Parameters

Name

Description

Required

Default

Pattern

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

null

1.13.7.2. Return Type

1.13.7.3. Content Type

application/json

1.13.7.4. Responses

Table 95. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Role names Found	GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

1.13.8. searchAllEndEntities

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

Search all End Entities

1.13.8.1. Parameters

1.13.8.1.1. Body Parameter

Name

Description

Required

Default

Pattern

SearchAllRequestDto

GetEndEntityResponseDtoPage

1.13.8.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

1.13.8.3. Content Type

application/json

1.13.8.4. Responses

Table 96. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]
200	Found End Entities	GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage]

1.13.9. searchEndEntities

POST /api/v1/end-entities/search

Search End Entities

1.13.9.1. Parameters

1.13.9.1.1. Body Parameter

Name

Description

Required

Default

Pattern

EndEntitySearchRequestDto

EndEntitySearchRequestDto

1.13.9.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.13.9.2. Return Type

GetEndEntityResponseDtoPage

1.13.9.3. Content Type

application/json

1.13.9.4. Responses

Table 97. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]
200	Found End Entities	GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage]

1.13.10. setEndEntityAlias

PATCH /api/v1/end-entities/{id}/alias

Set End Entity Alias

1.13.10.1. Parameters

1.13.10.1.1. Path Parameters

Name

Description

Required

Default

Pattern

The id passed in the url is the End Entity's id for which the Alias will be set to

null

1.13.10.1.2. Body Parameter

Name

Description

Required

Default

Pattern

SetEndEntityAliasRequestDto

SetEndEntityAliasRequestDto

1.13.10.2. Return Type

EndEntityMassImportResponseDto

1.13.10.3. Content Type

application/json

1.13.10.4. Responses

Table 98. http response codes
Code	Message	Datatype
200	Alias for End Entity was set	GetEndEntityResponseDto[GetEndEntityResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

1.13.11. uploadEndEntitiesCsv

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

Add multiple End Entities from csv file

1.13.11.1. Parameters

1.13.11.1.1. Body Parameter

Name

Description

Required

Default

Pattern

EndEntitiesCsvDto

EndEntitiesCsvDto

1.13.11.2. Return Type

1.13.11.3. Content Type

application/json

1.13.11.4. Responses

Table 99. http response codes
Code	Message	Datatype
201	The End Entities were saved successfully	EndEntityMassImportResponseDto[EndEntityMassImportResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

EndEntityAuthenticationRequestDto

1.14.1.2. Return Type

EndEntityAuthenticationResponseDto

1.14.1.3. Content Type

application/json

1.14.1.4. Responses

Table 100. http response codes
Code	Message	Datatype
200	Authenticated successfully	EndEntityAuthenticationResponseDto[EndEntityAuthenticationResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreateEndEntityPasswordRequestDto

1.14.2.2. Return Type

CreateEndEntityPasswordResponseDto

1.14.2.3. Content Type

application/json

1.14.2.4. Responses

Table 101. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
201	Password for End Entity created	CreateEndEntityPasswordResponseDto[CreateEndEntityPasswordResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

EndEntityPasswordRequestDto

1.14.3.2. Return Type

1.14.3.3. Content Type

application/json

1.14.3.4. Responses

Table 102. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
204	Password for End Entity Deleted	<<>>
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

null

policyId

Id of Policy to be searched

null

1.14.4.2. Return Type

GetEndEntityPasswordResponseDto

1.14.4.3. Content Type

application/json

1.14.4.4. Responses

Table 103. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Found End Entity Password	GetEndEntityPasswordResponseDto[GetEndEntityPasswordResponseDto]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the End Entity for which the search is requested

null

1.14.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetEndEntityPasswordResponseDtoPage

1.14.5.3. Content Type

application/json

1.14.5.4. Responses

Table 104. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	End Entity Passwords Found	GetEndEntityPasswordResponseDtoPage[GetEndEntityPasswordResponseDtoPage]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

EndEntityPasswordRequestDto

1.14.6.2. Return Type

ResetEndEntityPasswordResponseDto

1.14.6.3. Content Type

application/json

1.14.6.4. Responses

Table 105. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Password for End Entity was reset	ResetEndEntityPasswordResponseDto[ResetEndEntityPasswordResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

GetApiErrorValuesResponseDtoList

1.15.1.3. Content Type

application/json

1.15.1.4. Responses

Table 106. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Api Error values found	GetApiErrorValuesResponseDtoList[GetApiErrorValuesResponseDtoList]

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

GetCertRequestPermissionResponseDtoList

1.15.2.3. Content Type

application/json

1.15.2.4. Responses

Table 107. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Request Permissions values found	GetCertRequestPermissionResponseDtoList[GetCertRequestPermissionResponseDtoList]

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

GetCertStatusResponseDtoList

1.15.3.3. Content Type

application/json

1.15.3.4. Responses

Table 108. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Status values found	GetCertStatusResponseDtoList[GetCertStatusResponseDtoList]

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

GetCertificatePermissionResponseDtoList

1.15.4.3. Content Type

application/json

1.15.4.4. Responses

Table 109. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Permissions values found	GetCertificatePermissionResponseDtoList[GetCertificatePermissionResponseDtoList]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetCertificateProviderTypeResponseDtoList

1.15.5.3. Content Type

application/json

1.15.5.4. Responses

Table 110. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Provider type values found	GetCertificateProviderTypeResponseDtoList[GetCertificateProviderTypeResponseDtoList]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetCertificateSearchKeyResponseDtoList

1.15.6.3. Content Type

application/json

1.15.6.4. Responses

Table 111. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Search Key values found	GetCertificateSearchKeyResponseDtoList[GetCertificateSearchKeyResponseDtoList]

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

GetCmpSignatureAlgorithmResponseDtoList

1.15.7.3. Content Type

application/json

1.15.7.4. Responses

Table 112. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	CMP Signature Algorithm values found	GetCmpSignatureAlgorithmResponseDtoList[GetCmpSignatureAlgorithmResponseDtoList]

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

GetCryptoAlgorithmResponseDtoList

1.15.8.3. Content Type

application/json

1.15.8.4. Responses

Table 113. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Crypto Algorithm values found	GetCryptoAlgorithmResponseDtoList[GetCryptoAlgorithmResponseDtoList]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetCryptoModuleTypeListResponseDto

1.15.9.3. Content Type

application/json

1.15.9.4. Responses

Table 114. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Crypto Module type values found	GetCryptoModuleTypeListResponseDto[GetCryptoModuleTypeListResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetECNamedCurveResponseDtoList

1.15.10.3. Content Type

application/json

1.15.10.4. Responses

Table 115. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	EC Named Curves values found	GetECNamedCurveResponseDtoList[GetECNamedCurveResponseDtoList]

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

GetEdDSANamedCurveResponseDtoList

1.15.11.3. Content Type

application/json

1.15.11.4. Responses

Table 116. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	EdDSA Named Curves values found	GetEdDSANamedCurveResponseDtoList[GetEdDSANamedCurveResponseDtoList]

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

GetEndEntityPermissionResponseDtoList

1.15.12.3. Content Type

application/json

1.15.12.4. Responses

Table 117. http response codes
Code	Message	Datatype
200	End Entity Permissions values found	GetEndEntityPermissionResponseDtoList[GetEndEntityPermissionResponseDtoList]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetEndEntityPropertyResponseDtoList

1.15.13.3. Content Type

application/json

1.15.13.4. Responses

Table 118. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	End Entity Properties values found	GetEndEntityPropertyResponseDtoList[GetEndEntityPropertyResponseDtoList]

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

GetEntitiesEnumResponseDtoList

1.15.14.3. Content Type

application/json

1.15.14.4. Responses

Table 119. http response codes
Code	Message	Datatype
200	End Entity Enum values found	GetEntitiesEnumResponseDtoList[GetEntitiesEnumResponseDtoList]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetEndEntityStrategyResponseDtoList

1.15.15.3. Content Type

application/json

1.15.15.4. Responses

Table 120. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Entity Strategy Enum values found	GetEndEntityStrategyResponseDtoList[GetEndEntityStrategyResponseDtoList]

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

GetGlobalPermissionResponseDtoList

1.15.16.3. Content Type

application/json

1.15.16.4. Responses

Table 121. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Global Permissions values found	GetGlobalPermissionResponseDtoList[GetGlobalPermissionResponseDtoList]

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

GetKeyPairModeResponseDtoList

1.15.17.3. Content Type

application/json

1.15.17.4. Responses

Table 122. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Key Pair Mode values found	GetKeyPairModeResponseDtoList[GetKeyPairModeResponseDtoList]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetPolicyPermissionResponseDtoList

1.15.18.3. Content Type

application/json

1.15.18.4. Responses

Table 123. http response codes
Code	Message	Datatype
200	Policy Permissions values found	GetPolicyPermissionResponseDtoList[GetPolicyPermissionResponseDtoList]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetRealmPermissionResponseDtoList

1.15.19.3. Content Type

application/json

1.15.19.4. Responses

Table 124. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Realm Permissions values found	GetRealmPermissionResponseDtoList[GetRealmPermissionResponseDtoList]

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

GetRevocationReasonResponseDtoList

1.15.20.3. Content Type

application/json

1.15.20.4. Responses

Table 125. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Revocation Reason values found	GetRevocationReasonResponseDtoList[GetRevocationReasonResponseDtoList]

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

GetRSAKeySizeResponseDtoList

1.15.21.3. Content Type

application/json

1.15.21.4. Responses

Table 126. http response codes
Code	Message	Datatype
200	RSA Key Size values found	GetRSAKeySizeResponseDtoList[GetRSAKeySizeResponseDtoList]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

GetValidForResponseDtoList

1.15.22.3. Content Type

application/json

1.15.22.4. Responses

Table 127. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Valid For values found	GetValidForResponseDtoList[GetValidForResponseDtoList]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]

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

CreateNewMailingListRequestDto

1.16.1.2. Return Type

CreateNewMailingListResponseDto

1.16.1.3. Content Type

application/json

1.16.1.4. Responses

Table 128. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
201	Mailing List Created	CreateNewMailingListResponseDto[CreateNewMailingListResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the requested Mailing List

null

1.16.2.2. Return Type

GetMailingListResponseDto

1.16.2.3. Content Type

application/json

1.16.2.4. Responses

Table 129. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Found Mailing List	GetMailingListResponseDto[GetMailingListResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

MailingListSearchRequestDto

1.16.3.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetMailingListResponseDtoPage

1.16.3.3. Content Type

application/json

1.16.3.4. Responses

Table 130. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Mailing Lists Found	GetMailingListResponseDtoPage[GetMailingListResponseDtoPage]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

The id of the Mailing List that will be updated

null

1.16.4.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateMailingListRequestDto

UpdateMailingListRequestDto

1.16.4.2. Return Type

UpdateMailingListResponseDto

1.16.4.3. Content Type

application/json

1.16.4.4. Responses

Table 131. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Mailing List Updated	UpdateMailingListResponseDto[UpdateMailingListResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreatePkcs10RequestDto

1.17.1.2. Return Type

CreatePkcs10ResponseDto

1.17.1.3. Content Type

application/json

1.17.1.4. Responses

Table 132. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	PKCS10 Request Created	CreatePkcs10ResponseDto[CreatePkcs10ResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

Pkcs10Dto

1.17.2.2. Return Type

ParsePkcs10ResponseDto

1.17.2.3. Content Type

application/json

1.17.2.4. Responses

Table 133. http response codes
Code	Message	Datatype
200	PKCS10 Request Parsed	ParsePkcs10ResponseDto[ParsePkcs10ResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the End Entity for which the search is requested

null

1.18.1.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

CheckEndEntityRequestDto

1.18.1.3. Content Type

application/json

1.18.1.4. Responses

Table 134. http response codes
Code	Message	Datatype
200	Policies Found	GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.18.2.1.2. Body Parameter

Name

Description

Required

Default

Pattern

CheckEndEntityRequestDto

1.18.2.2. Return Type

CheckEndEntityResponseDto

1.18.2.3. Content Type

application/json

1.18.2.4. Responses

Table 135. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	End Entity Rules Checked	CheckEndEntityResponseDto[CheckEndEntityResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreatePolicyRequestDto

1.18.3.2. Return Type

CreatePolicyResponseDto

1.18.3.3. Content Type

application/json

1.18.3.4. Responses

Table 136. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
201	Policy Created	CreatePolicyResponseDto[CreatePolicyResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

GetAllowedCryptoParametersRequestDto

1.18.4.2. Return Type

CryptoParametersDto

1.18.4.3. Content Type

application/json

1.18.4.4. Responses

Table 137. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	End Entity Rules Checked	CryptoParametersDto[CryptoParametersDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the Policy that will be used to fetch role names with access to it

null

1.18.5.2. Return Type

1.18.5.3. Content Type

application/json

1.18.5.4. Responses

Table 138. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Role names Found	GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the Certificate Provider for which the search of Policies is requested

null

1.18.6.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

1.18.6.3. Content Type

application/json

1.18.6.4. Responses

Table 139. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]
200	Policies Found connected to the specific Certificate Provider	GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]

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

GetPoliciesInRealmsDto

1.18.7.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

1.18.7.3. Content Type

application/json

1.18.7.4. Responses

Table 140. http response codes
Code	Message	Datatype
200	Policies Found	GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of Policy to be searched

null

1.18.8.2. Return Type

GetPolicyResponseDto

1.18.8.3. Content Type

application/json

1.18.8.4. Responses

Table 141. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Policy Found	GetPolicyResponseDto[GetPolicyResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of Realm for which Policies will be searched

null

1.18.9.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

1.18.9.3. Content Type

application/json

1.18.9.4. Responses

Table 142. http response codes
Code	Message	Datatype
200	Policies Found	GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

1.18.10.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

1.18.10.3. Content Type

application/json

1.18.10.4. Responses

Table 143. http response codes
Code	Message	Datatype
200	Policies Found	GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

PolicySearchRequestDto

1.18.11.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

UpdatePolicyResponseDto

1.18.11.3. Content Type

application/json

1.18.11.4. Responses

Table 144. http response codes
Code	Message	Datatype
200	Policies Found	GetPolicyResponseDtoPage[GetPolicyResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of Policy that will be updated

null

1.18.12.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdatePolicyRequestDto

UpdatePolicyRequestDto

1.18.12.2. Return Type

1.18.12.3. Content Type

application/json

1.18.12.4. Responses

Table 145. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Policy Updated	UpdatePolicyResponseDto[UpdatePolicyResponseDto]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

ExtractEndEntityInfoFromPkcs10RequestDto

1.19.1.2. Return Type

ExtractEndEntityInfoFromPkcs10ResponseDto

1.19.1.3. Content Type

application/json

1.19.1.4. Responses

Table 146. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]
200	Extracted End Entity info from PEM encoded PKCS10 Request	ExtractEndEntityInfoFromPkcs10ResponseDto[ExtractEndEntityInfoFromPkcs10ResponseDto]

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

VerifyTokenRequestDto

1.19.2.2. Return Type

EmailVerifiedCertReqResponseDto

1.19.2.3. Content Type

application/json

1.19.2.4. Responses

Table 147. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Verified Certificate Request and sent an E-Mail	EmailVerifiedCertReqResponseDto[EmailVerifiedCertReqResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreateRaCertBatchRequestDto

1.20.1.2. Return Type

ZippedCertsBatchDto

1.20.1.3. Content Type

application/json

1.20.1.4. Responses

Table 148. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	User's Ra Certificates Created	ZippedCertsBatchDto[ZippedCertsBatchDto]
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose Ra Certificate we are creating

null

1.20.2.1.2. Body Parameter

Name

Description

Required

Default

Pattern

CreateSingleRaCertRequestDto

CreateSingleRaCertRequestDto

1.20.2.2. Return Type

UpdateUserRaCertificateDto

1.20.2.3. Content Type

application/json

1.20.2.4. Responses

Table 149. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	User's Ra Certificate Created	UpdateUserRaCertificateDto[UpdateUserRaCertificateDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose Ra Certificate CRL we are downloading

null

1.20.3.2. Return Type

CrlDto

1.20.3.3. Content Type

application/json

1.20.3.4. Responses

Table 150. http response codes
Code	Message	Datatype
200	Ra Certificate of the User Downloaded	CrlDto[CrlDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose Ra Certificate we are downloading

null

1.20.4.2. Return Type

RaCertificatePemDto

1.20.4.3. Content Type

application/json

1.20.4.4. Responses

Table 151. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	User's Ra Certificate Downloaded	RaCertificatePemDto[RaCertificatePemDto]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose Certificate Chain we are downloading

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

null

1.20.5.2. Return Type

RaCertificatePemDto

1.20.5.3. Content Type

application/json

1.20.5.4. Responses

Table 152. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	User's Certificate Chain Downloaded	RaCertificatePemDto[RaCertificatePemDto]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose OCSP Status we are getting

null

1.20.6.2. Return Type

OcspStatusCheckDto

1.20.6.3. Content Type

application/json

1.20.6.4. Responses

Table 153. http response codes
Code	Message	Datatype
200	Got the Ra OCSP Status of the User	OcspStatusCheckDto[OcspStatusCheckDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose Ra Certificate we are searching for

null

1.20.7.2. Return Type

GetRaCertificateResponseDto

1.20.7.3. Content Type

application/json

1.20.7.4. Responses

Table 154. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Ra Certificate Found	GetRaCertificateResponseDto[GetRaCertificateResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose Ra PKCS12 Certificate we are retrieving

null

1.20.8.2. Return Type

KeystoreFileDto

1.20.8.3. Content Type

application/json

1.20.8.4. Responses

Table 155. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	User's Ra PKCS12 Certificate Retrieved	KeystoreFileDto[KeystoreFileDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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 of the User whose Ra Certificate we are revoking

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

RevokeRaCertificateResponseDto

1.20.9.3. Content Type

application/json

1.20.9.4. Responses

Table 156. http response codes
Code	Message	Datatype
200	User's Ra Certificate Revoked	RevokeRaCertificateResponseDto[RevokeRaCertificateResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

CreateRealmRequestDto

1.21.1.2. Return Type

CreateRealmResponseDto

1.21.1.3. Content Type

application/json

1.21.1.4. Responses

Table 157. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]
201	Realm Created	CreateRealmResponseDto[CreateRealmResponseDto]

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 of the Realm that will be used to fetch role names with access to it

null

1.21.2.2. Return Type

GetRealmResponseDtoPage

1.21.2.3. Content Type

application/json

1.21.2.4. Responses

Table 158. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Role names Found	GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the Realm that requesting to be found

null

1.21.3.2. Return Type

GetRealmResponseDto

1.21.3.3. Content Type

application/json

1.21.3.4. Responses

Table 159. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
200	Realm Found	GetRealmResponseDto[GetRealmResponseDto]

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)

size

The size of the page to be returned

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

1.21.4.3. Content Type

application/json

1.21.4.4. Responses

Table 160. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Realms Found	GetRealmResponseDtoPage[GetRealmResponseDtoPage]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

1.21.5. search

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

RealmSearchRequestDto

1.21.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetRealmResponseDtoPage

1.21.5.3. Content Type

application/json

1.21.5.4. Responses

Table 161. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Realms Found	GetRealmResponseDtoPage[GetRealmResponseDtoPage]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the Realm that will be updated

null

1.21.6.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateRealmRequestDto

UpdateRealmRequestDto

1.21.6.2. Return Type

UpdateRealmResponseDto

1.21.6.3. Content Type

application/json

1.21.6.4. Responses

Table 162. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]
200	Realm Updated	UpdateRealmResponseDto[UpdateRealmResponseDto]

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

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

null

1.22.1.2. Return Type

GetCertRequestStatusStatisticsResponseDto

1.22.1.3. Content Type

application/json

1.22.1.4. Responses

Table 163. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Request Status Statistics for the Realm Found	GetCertRequestStatusStatisticsResponseDto[GetCertRequestStatusStatisticsResponseDto]

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

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

null

1.22.2.2. Return Type

GetCertificateIssuerStatisticsResponseDto

1.22.2.3. Content Type

application/json

1.22.2.4. Responses

Table 164. http response codes
Code	Message	Datatype
200	Certificate Issuer Statistics for the Realm Found	GetCertificateIssuerStatisticsResponseDto[GetCertificateIssuerStatisticsResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.22.3.2. Return Type

GetCertificateProviderTypeStatisticsResponseDto

1.22.3.3. Content Type

application/json

1.22.3.4. Responses

Table 165. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Provider Type Statistics for the Realm Found	GetCertificateProviderTypeStatisticsResponseDto[GetCertificateProviderTypeStatisticsResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.22.4.2. Return Type

GetCertificatePublicKeyAlgorithmStatisticsResponseDto

1.22.4.3. Content Type

application/json

1.22.4.4. Responses

Table 166. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Public Key Algorithm Statistics for the Realm Found	GetCertificatePublicKeyAlgorithmStatisticsResponseDto[GetCertificatePublicKeyAlgorithmStatisticsResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.22.5.2. Return Type

GetCertificateStatusStatisticsResponseDto

1.22.5.3. Content Type

application/json

1.22.5.4. Responses

Table 167. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Certificate Status Statistics for the Realm Found	GetCertificateStatusStatisticsResponseDto[GetCertificateStatusStatisticsResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.22.6.2. Return Type

GetImportedCertificatesStatisticsResponseDto

1.22.6.3. Content Type

application/json

1.22.6.4. Responses

Table 168. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Imported Certificates Statistics for the Realm Found	GetImportedCertificatesStatisticsResponseDto[GetImportedCertificatesStatisticsResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.22.7.2. Return Type

GetAuditEventResponseDtoList

1.22.7.3. Content Type

application/json

1.22.7.4. Responses

Table 169. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Latest Certificate Audit Events	GetAuditEventResponseDtoList[GetAuditEventResponseDtoList]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

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

null

1.22.8.2. Return Type

GetSelfSignedCertificatesStatisticsResponseDto

1.22.8.3. Content Type

application/json

1.22.8.4. Responses

Table 170. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Self-signed Certificates Statistics for the Realm Found	GetSelfSignedCertificatesStatisticsResponseDto[GetSelfSignedCertificatesStatisticsResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

1.23.1.2. Return Type

1.23.1.3. Content Type

application/json

1.23.1.4. Responses

Table 171. http response codes
Code	Message	Datatype
200	API Client Roles assigned	UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

1.23.2.2. Return Type

1.23.2.3. Content Type

application/json

1.23.2.4. Responses

Table 172. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	User Roles assigned	UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

1.23.3.2. Return Type

1.23.3.3. Content Type

application/json

1.23.3.4. Responses

Table 173. http response codes
Code	Message	Datatype
200	API Client Roles unassigned	UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

1.23.4.2. Return Type

BatchDeleteRolesRequestDto

1.23.4.3. Content Type

application/json

1.23.4.4. Responses

Table 174. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	User Roles unassigned	UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

CreateRoleRequestDto

1.23.5.2. Return Type

CreateRoleResponseDto

1.23.5.3. Content Type

application/json

1.23.5.4. Responses

Table 175. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
201	Role created	CreateRoleResponseDto[CreateRoleResponseDto]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.23.6.2. Return Type

1.23.6.3. Content Type

application/json

1.23.6.4. Responses

Table 176. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
204	Role deleted	<<>>
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

1.23.7.2. Return Type

BatchDeleteRolesResponseDto

1.23.7.3. Content Type

application/json

1.23.7.4. Responses

Table 177. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
200	Role(s) deleted	BatchDeleteRolesResponseDto[BatchDeleteRolesResponseDto]

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

null

1.23.8.2. Return Type

GetSecurityIdentityRolesResponseDto

1.23.8.3. Content Type

application/json

1.23.8.4. Responses

Table 178. http response codes
Code	Message	Datatype
200	API Client Roles Found	GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.23.9.2. Return Type

GetRoleDetailsResponseDto

1.23.9.3. Content Type

application/json

1.23.9.4. Responses

Table 179. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Role Found	GetRoleDetailsResponseDto[GetRoleDetailsResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.23.10.2. Return Type

GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto

1.23.10.3. Content Type

application/json

1.23.10.4. Responses

Table 180. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Security identities Found	GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto[GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.23.11.2. Return Type

GetSecurityIdentityRolesResponseDto

1.23.11.3. Content Type

application/json

1.23.11.4. Responses

Table 181. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	User Roles Found	GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

SearchRoleRequestDto

1.23.12.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

GetRoleResponseDtoPage

1.23.12.3. Content Type

application/json

1.23.12.4. Responses

Table 182. http response codes
Code	Message	Datatype
200	Roles Found	GetRoleResponseDtoPage[GetRoleResponseDtoPage]
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.23.13.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateSecurityIdentityRolesRequestDto

UpdateSecurityIdentityRolesRequestDto

1.23.13.2. Return Type

1.23.13.3. Content Type

application/json

1.23.13.4. Responses

Table 183. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
204	API Client Roles Updated	<<>>
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.23.14.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateRoleRequestDto

UpdateRoleRequestDto

1.23.14.2. Return Type

UpdateRoleResponseDto

1.23.14.3. Content Type

application/json

1.23.14.4. Responses

Table 184. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
200	Role updated	UpdateRoleResponseDto[UpdateRoleResponseDto]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

null

1.23.15.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateSecurityIdentityRolesRequestDto

UpdateSecurityIdentityRolesRequestDto

1.23.15.2. Return Type

1.23.15.3. Content Type

application/json

1.23.15.4. Responses

Table 185. http response codes
Code	Message	Datatype
204	User Roles Updated	<<>>
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

ScepDecryptDataRequestDto

1.24.1.2. Return Type

ScepDecryptDataResponseDto

1.24.1.3. Content Type

application/json

1.24.1.4. Responses

Table 186. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Data decrypted	ScepDecryptDataResponseDto[ScepDecryptDataResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

ScepDecryptDataRequestDto

1.24.2.2. Return Type

ScepDecryptDataResponseDto

1.24.2.3. Content Type

application/json

1.24.2.4. Responses

Table 187. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
200	Data decrypted	ScepDecryptDataResponseDto[ScepDecryptDataResponseDto]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

ScepSignRequestDto

1.24.3.2. Return Type

ScepSignDataResponseDto

1.24.3.3. Content Type

application/json

1.24.3.4. Responses

Table 188. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Data signed	ScepSignDataResponseDto[ScepSignDataResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

ScepSignRequestDto

1.24.4.2. Return Type

ScepSignDataResponseDto

1.24.4.3. Content Type

application/json

1.24.4.4. Responses

Table 189. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Data signed	ScepSignDataResponseDto[ScepSignDataResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

SignDataRequestDto

1.25.1.2. Return Type

SignDataResponseDto

1.25.1.3. Content Type

application/json

1.25.1.4. Responses

Table 190. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	Data signed	SignDataResponseDto[SignDataResponseDto]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the User

null

1.26.1.1.2. Query Parameters

Name

Description

Required

Default

Pattern

enablePasswordLogin

null

1.26.1.2. Return Type

1.26.1.3. Content Type

application/json

1.26.1.4. Responses

Table 191. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
204	Set disable_password_login role	<<>>
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

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

FindUserByRaCertificateRequestDto

1.26.2.2. Return Type

1.26.2.3. Content Type

application/json

1.26.2.4. Responses

Table 192. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
422	Unprocessable Entity, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	User Found	UserDetailsDto[UserDetailsDto]
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of the User to be searched

null

1.26.3.2. Return Type

CreateNewUserDetailsDto

1.26.3.3. Content Type

application/json

1.26.3.4. Responses

Table 193. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
200	User Found	UserDetailsDto[UserDetailsDto]
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]

1.26.4. registerUser

POST /api/v1/users/

1.26.4.1. Parameters

1.26.4.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreateNewUserDetailsDto

1.26.4.2. Return Type

UpdateUserCertificateDetailsRequestDto

1.26.4.3. Content Type

application/json

1.26.4.4. Responses

Table 194. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
409	Conflict, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
201	User Registered	UserDetailsDto[UserDetailsDto]
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

UserSearchRequestDto

1.26.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

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

UserDetailsDtoPage

1.26.5.3. Content Type

application/json

1.26.5.4. Responses

Table 195. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	Users Found	UserDetailsDtoPage[UserDetailsDtoPage]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

UserListDto

1.26.6.2. Return Type

1.26.6.3. Content Type

application/json

1.26.6.4. Responses

Table 196. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
204	Batch update password E-Mails sent	<<>>
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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 of User whose details will be set

null

1.26.7.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateUserCertificateDetailsRequestDto

1.26.7.2. Return Type

1.26.7.3. Content Type

application/json

1.26.7.4. Responses

Table 197. http response codes
Code	Message	Datatype
500	Internal Error, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
400	Bad Request	ApiExceptionResponse[ApiExceptionResponse]
404	Not Found, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
405	Http method not allowed	ApiExceptionResponse[ApiExceptionResponse]
502	Bad Gateway, check the result for more information	ApiExceptionResponse[ApiExceptionResponse]
403	Access Denied	ApiExceptionResponse[ApiExceptionResponse]
200	User's Certificate Details Set	UserDetailsDto[UserDetailsDto]
401	Authentication Failed	ApiExceptionResponse[ApiExceptionResponse]
415	Specified media not supported for this endpoint	ApiExceptionResponse[ApiExceptionResponse]

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

ApiError

errorMessage

String

2.4. ApproveCertReqResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

certificateId

UUID

uuid

certRequestStatus

CertRequestStatus

userResponses

List of UserResponseDto

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

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

Set of [string]

2.12. BatchDeleteRolesResponseDto

Field Name

Required

Type

Description

Format

successful

Set of [string]

failed

Map of ApiError

2.13. CaCertificateDataPemDto

Field Name

Required

Type

Description

Format

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

Long

int64

name

String

caSubjectDn

String

2.17. CaraTemplateSignerDtoList

Field Name

Required

Type

Description

Format

caraTemplateSignerList

List of CaraTemplateSignerDto

2.18. CertReqSearchByPkcs10

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

Field Name

Required

Type

Description

Format

pkcs10ReqBase64

String

2.19. CertReqSearchRequestDto

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

Field Name

Required

Type

Description

Format

realmId

UUID

uuid

simpleSearchTerm

String

policyId

UUID

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

UUID

uuid

fileName

String

pemCertificate

String

2.26. CertificatePermission

Field Name

Required

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 CertStatus

certPublicKeyAlgorithms

Set of CryptoAlgorithm

serialNumber

String

issuerDn

String

subjectDn

String

issuerDnBin

String

subjectDnBin

String

validNotBeforeStart

Date

date-time

validNotBeforeEnd

Date

date-time

validNotAfterStart

Date

date-time

validNotAfterEnd

Date

date-time

selfSigned

Boolean

imported

Boolean

archived

Boolean

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

String

organization

String

organizationalUnit

String

country

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

2.38. CheckEndEntityResponseDto

Field Name

Required

Type

Description

Format

endEntityPropertyApiErrorMap

Map of ApiError

2.39. CmpCalculateMacRequestDto

Field Name

Required

Type

Description

Format

data

byte[]

byte

encodedPBMParameter

byte[]

byte

policyId

UUID

uuid

endEntityId

UUID

uuid

2.40. CmpCalculateMacResponseDto

Field Name

Required

Type

Description

Format

macValue

byte[]

byte

2.41. CmpConfigurationDto

Field Name

Required

Type

Description

Format

certificateProviderDto

CertificateProviderDto

signerConfigurationDto

SignerConfigurationDto

2.42. CmpConfigurationRequestDto

Field Name

Required

Type

Description

Format

certificateProviderId

UUID

uuid

signerConfigurationDto

SignerConfigurationDto

2.43. CmpConfigurationResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

byte[]

byte

data

byte[]

byte

encodedPBMParameter

byte[]

byte

policyId

UUID

uuid

endEntityId

UUID

uuid

2.48. CmpVerifyMacResponseDto

Field Name

Required

Type

Description

Format

cmpMacVerificationResult

CmpMacVerificationResult

2.49. CreateCertReqRequestDto

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

Field Name

Required

Type

Description

Format

policyId

UUID

uuid

endEntityId

UUID

uuid

validFor

ValidFor

keyPairMode

KeyPairMode

keyGenParamsDto

KeyGenParamsDto

pkcs10ReqBase64

String

publicKeyBase64

String

isSelfSigned

Boolean

2.50. CreateCertReqResponseDto

Field Name

Required

Type

Description

Format

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

metadata

AuditedAndVersionDtoUUID

2.51. CreateCertificateProviderRequestDto

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

Field Name

Required

Type

Description

Format

name

String

certificateProviderType

CertificateProviderType

configuration

Object

2.52. CreateCertificateProviderResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

certificateProviderType

CertificateProviderType

configuration

Object

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.53. 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.54. CreateConfigurationRequestDto

It includes all the necessary values to create a new Configuration

Field Name

Required

Type

Description

Format

setting

SettingsKey

configurationValue

String

2.55. CreateConfigurationResponseDto

Field Name

Required

Type

Description

Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

settingName

String

2.56. CreateCryptoModuleRequestDto

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

Field Name

Required

Type

Description

Format

cryptoModuleType

CryptoModuleType

name

String

configuration

Object

2.57. CreateCryptoModuleResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

cryptoModuleType

CryptoModuleType

configuration

Object

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

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

UUID

uuid

2.59. CreateEndEntityPasswordResponseDto

Field Name

Required

Type

Description

Format

endEntityIds

List of [UUID]

uuid

policyId

UUID

uuid

password

String

metadata

AuditedAndVersionDtoUUID

2.60. CreateEndEntityRequestDto

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

Field Name

Required

Type

Description

Format

realmId

UUID

uuid

commonName

String

organization

String

organizationalUnit

String

country

String

externalId

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

2.61. CreateEndEntityResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

commonName

String

organization

String

organizationalUnit

String

country

String

externalId

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

metadata

AuditedAndVersionDtoUUID

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

UUID

uuid

endEntitiesIds

List of [UUID]

uuid

validFor

ValidFor

keyPairMode

KeyPairMode

keyGenParamsDto

KeyGenParamsDto

pkcs10ReqBase64

String

publicKeyBase64

String

isSelfSigned

Boolean

2.63. CreateMultipleCertReqResponseDto

Field Name

Required

Type

Description

Format

certRequestsCreated

Map of CreateCertReqResponseDto

certRequestsFailed

Map of ApiError

certificateRequests

List of [UUID]

uuid

2.64. CreateMultipleCertificateFromCertRequestsResponseDto

Field Name

Required

Type

Description

Format

zipFileInBase64

String

filePassword

String

certificatesFailed

Map of ApiError

certificatesSuccessful

Map of [UUID]

uuid

certificateIds

List of [UUID]

uuid

2.65. 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.66. CreateNewApiClientResponse

Field Name

Required

Type

Description

Format

UUID

uuid

secret

String

clientId

String

name

String

metadata

AuditedAndVersionDtoUUID

2.67. CreateNewEmailRequestDto

Field Name

Required

Type

Description

Format

emailName

String

2.68. 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 CreateNewEmailRequestDto

2.69. CreateNewMailingListResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

emails

List of MailingListToEmailDto

archived

Boolean

metadata

AuditedAndVersionDtoUUID

2.70. CreateNewUserDetailsDto

It includes the basic properties needed for the creation

Field Name

Required

Type

Description

Format

firstName

String

lastName

String

passwordLoginEnabled

Boolean

2.71. CreatePkcs10RequestDto

It includes all the properties necessary for the creation

Field Name

Required

Type

Description

Format

keyGenParamsDto

KeyGenParamsDto

endEntityInfoDto

EndEntityInfoDto

2.72. CreatePkcs10ResponseDto

Field Name

Required

Type

Description

Format

pkcs10RequestPemEncoded

String

pkcs10RequestFileName

String

encryptedPrivateKeyInPemFormat

String

privateKeyName

String

privateKeyPassword

String

2.73. CreatePolicyRequestDto

It includes all the properties needed for the creation

Field Name

Required

Type

Description

Format

realmId

UUID

uuid

name

String

certificateProviderId

UUID

uuid

certificateProviderConfiguration

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of KeyPairMode

allowedValidForValues

Set of ValidFor

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

endEntityStrategy

EndEntityStrategy

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationRequestDto

CmpConfigurationRequestDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.74. CreatePolicyResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

certificateProviderDto

CertificateProviderDto

certificateProviderConfiguration

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of KeyPairMode

allowedValidForValues

Set of ValidFor

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

metadata

AuditedAndVersionDtoUUID

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationResponseDto

CmpConfigurationResponseDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.75. CreateRaCertBatchRequestDto

It includes all the properties needed for the batch creation

Field Name

Required

Type

Description

Format

validFor

ValidFor

keyGenParamsDto

KeyGenParamsDto

updateUserCertificateDtoList

List of UpdateUserCertificateDto

2.76. CreateRealmRequestDto

It includes all the properties needed for the creation

Field Name

Required

Type

Description

Format

name

String

mailingListId

UUID

uuid

2.77. CreateRealmResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

mailingListId

UUID

uuid

archived

Boolean

metadata

AuditedAndVersionDtoUUID

2.78. CreateRoleRequestDto

It includes all the properties needed for the creation

Field Name

Required

Type

Description

Format

name

String

globalPermissions

realmPermissions

policyPermissions

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

2.79. CreateRoleResponseDto

Field Name

Required

Type

Description

Format

name

String

globalPermissions

realmPermissions

policyPermissions

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

2.80. CreateSingleRaCertRequestDto

It includes all the properties needed for the creation

Field Name

Required

Type

Description

Format

validFor

ValidFor

keyPairMode

KeyPairMode

keyGenParamsDto

KeyGenParamsDto

pkcs10ReqBase64

String

publicKeyBase64

String

2.81. CrlDto

Field Name

Required

Type

Description

Format

fileName

String

crl

String

2.82. CryptoAlgorithm

Field Name

Required

Type

Description

Format

2.83. 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.84. CryptoModuleType

Field Name

Required

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

Field Name

Required

Type

Description

Format

entitiesId

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.89. EcKeyGenParams

Field Name

Required

Type

Description

Format

namedCurve

String

cryptoAlgorithm

CryptoAlgorithm

2.90. EcNamedCurve

Field Name

Required

Type

Description

Format

2.91. EdDsaCurve

Field Name

Required

Type

Description

Format

2.92. EdDsaKeyGenParams

Field Name

Required

Type

Description

Format

edDsaCurve

Field Name

Required

Type

Description

Format

endEntity

GetEndEntityResponseDto

policy

GetPolicyResponseDto

endEntityId

UUID

uuid

policyId

UUID

uuid

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

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

2.99. EndEntityFilterDto

Field Name

Required

Type

Description

Format

commonName

String

organization

String

organizationalUnit

String

country

String

externalId

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

2.100. EndEntityInfoDto

Field Name

Required

Type

Description

Format

commonName

String

organization

String

organizationalUnit

String

country

String

domains

List of [string]

ips

List of [string]

2.101. EndEntityMassImportResponseDto

Field Name

Required

Type

Description

Format

endEntityIds

List of [UUID]

uuid

2.102. EndEntityPasswordRequestDto

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

Field Name

Required

Type

Description

Format

endEntityId

UUID

uuid

policyId

realmId

UUID

uuid

simpleSearchTerm

String

policyId

UUID

uuid

endEntityIds

Set of [UUID]

uuid

endEntityFilterDto

EndEntityFilterDto

archived

Boolean

2.107. EndEntityStrategy

Field Name

Required

Type

Description

Format

2.108. EntitiesEnum

Field Name

Required

Type

Description

Format

2.109. ExaminePkcs10RequestRequestDto

It includes all the necessary properties to examine the PKCS10 request

Field Name

Required

Type

Description

Format

policyId

UUID

uuid

endEntityId

UUID

uuid

pkcs10ReqBase64

String

2.110. ExaminePkcs10RequestResponseDto

Field Name

Required

Type

Description

Format

isValid

Boolean

2.111. ExtractEndEntityInfoFromPkcs10RequestDto

It contains the PEM encoded PKCS10 Request

Field Name

Required

Type

Description

Format

pemEncodedPkcs10

String

2.112. ExtractEndEntityInfoFromPkcs10ResponseDto

Field Name

Required

Type

Description

Format

commonName

String

organization

String

organizationalUnit

String

country

String

domains

List of [string]

ips

List of [string]

2.113. FailedCertificateOrderResultDto

Field Name

Required

Type

Description

Format

certRequestId

UUID

uuid

apiError

ApiError

2.114. FailedImportCertRequestResponseDto

Field Name

Required

Type

Description

Format

certificateFingerprint

String

apiError

ApiError

2.115. FindEeByCertBytesRequestDto

It includes the properties needed to find the End Entity

Field Name

Required

Type

Description

Format

realmId

UUID

uuid

base64EncodedBytes

String

2.116. 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.117. GenericDto

Field Name

Required

Type

Description

Format

key

String

value

String

2.118. GetAllowedCryptoParametersRequestDto

Field Name

Required

Type

Description

Format

certificateProviderId

UUID

uuid

certificateProviderConfiguration

String

2.119. GetApiClientResponse

Field Name

Required

Type

Description

Format

UUID

uuid

realmIds

List of [UUID]

uuid

name

String

clientId

String

defaultPolicyId

UUID

uuid

providerId

UUID

uuid

metadata

AuditedAndVersionDtoUUID

2.120. GetApiClientResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetApiClientResponse

pageDetails

PageDetailsDto

2.121. GetApiErrorValuesResponseDtoList

Field Name

Required

Type

Description

Format

apiErrorList

List of ApiError

2.122. GetAuditEventResponseDtoList

Field Name

Required

Type

Description

Format

auditEventDtoList

List of AuditEventDto

2.123. GetAuthenticatedPrincipalPermissionsResponseDto

Field Name

Required

Type

Description

Format

globalPermissions

realmPermissions

Map of [set]

policyPermissions

Map of [set]

endEntityPermissions

Map of [set]

certRequestPermissions

Map of [set]

certificatePermissions

Map of [set]

2.124. GetCaResponseDto

Field Name

Required

Type

Description

Format

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.125. GetCertByIssuerDnBinAndSnDto

It includes all the needed properties to get the desired Certificate

Field Name

Required

Type

Description

Format

issuerDnBin

String

serialNumber

String

2.126. GetCertReqResponseDto

Field Name

Required

Type

Description

Format

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

Boolean

isSelfSigned

Boolean

userResponses

List of UserResponseDto

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

2.127. GetCertReqResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetCertReqResponseDto

pageDetails

PageDetailsDto

2.128. GetCertRequestAdditionalDataResponseDto

Field Name

Required

Type

Description

Format

additionalData

Object

isCertRequestUpdated

Boolean

2.129. GetCertRequestPermissionResponseDtoList

Field Name

Required

Type

Description

Format

certRequestPermissionList

List of CertRequestPermission

2.130. 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.131. GetCertStatusResponseDtoList

Field Name

Required

Type

Description

Format

certStatusList

List of CertStatus

2.132. GetCertificateIssuerStatisticsResponseDto

Field Name

Required

Type

Description

Format

empty

Boolean

2.133. GetCertificatePermissionResponseDtoList

Field Name

Required

Type

Description

Format

certificatePermissionList

List of CertificatePermission

2.134. GetCertificateProviderMinimalResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

certificateProviderType

CertificateProviderType

2.135. GetCertificateProviderMinimalResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetCertificateProviderMinimalResponseDto

pageDetails

PageDetailsDto

2.136. GetCertificateProviderResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

certificateProviderType

CertificateProviderType

configuration

Object

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

2.137. GetCertificateProviderResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetCertificateProviderResponseDto

pageDetails

PageDetailsDto

2.138. GetCertificateProviderTypeResponseDtoList

Field Name

Required

Type

Description

Format

certificateProviderTypeList

List of CertificateProviderType

2.139. GetCertificateProviderTypeStatisticsResponseDto

Field Name

Required

Type

Description

Format

mtgCara

Long

int64

msNdes

Long

int64

msca

Long

int64

globalSign

Long

int64

pswPublicCas

Long

int64

2.140. GetCertificatePublicKeyAlgorithmStatisticsResponseDto

Field Name

Required

Type

Description

Format

rsa

Long

int64

Long

int64

edDsa

Long

int64

2.141. GetCertificateResponseDto

Field Name

Required

Type

Description

Format

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

Boolean

isSelfSigned

Boolean

accessiblePrivateKey

Boolean

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.142. GetCertificateResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetCertificateResponseDto

pageDetails

PageDetailsDto

2.143. GetCertificateSearchKeyResponseDtoList

Field Name

Required

Type

Description

Format

certificateSearchKeyList

List of CertificateSearchKey

2.144. GetCertificateStatusStatisticsResponseDto

Field Name

Required

Type

Description

Format

active

Long

int64

expired

Long

int64

revoked

Long

int64

2.145. GetCmpConfigurationResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

cmpConfigurationDto

CmpConfigurationDto

policyId

UUID

uuid

signerCertChain

String

signerCertificateId

UUID

uuid

2.146. GetCmpSignatureAlgorithmResponseDtoList

Field Name

Required

Type

Description

Format

cmpSignatureAlgorithmList

List of CmpSignatureAlgorithm

2.147. GetConfigurationResponseDto

Field Name

Required

Type

Description

Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

2.148. GetConfigurationResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetConfigurationResponseDto

pageDetails

PageDetailsDto

2.149. GetCryptoAlgorithmResponseDtoList

Field Name

Required

Type

Description

Format

cryptoAlgorithmList

List of CryptoAlgorithm

2.150. GetCryptoModuleHealthCheckResponseDto

Field Name

Required

Type

Description

Format

isHealthy

Boolean

2.151. GetCryptoModuleResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

cryptoModuleType

CryptoModuleType

configuration

Object

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.152. GetCryptoModuleResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetCryptoModuleResponseDto

pageDetails

PageDetailsDto

2.153. GetCryptoModuleTypeListResponseDto

Field Name

Required

Type

Description

Format

cryptoModuleTypes

List of CryptoModuleType

2.154. GetECNamedCurveResponseDtoList

Field Name

Required

Type

Description

Format

ecNamedCurveList

List of EcNamedCurve

2.155. GetEdDSANamedCurveResponseDtoList

Field Name

Required

Type

Description

Format

edDsaCurveList

List of EdDsaCurve

2.156. GetEndEntityPasswordResponseDto

Field Name

Required

Type

Description

Format

endEntityId

UUID

uuid

endEntityName

String

policyId

UUID

uuid

policyName

String

metadata

AuditedAndVersionDtoUUID

2.157. GetEndEntityPasswordResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetEndEntityPasswordResponseDto

pageDetails

PageDetailsDto

2.158. GetEndEntityPermissionResponseDtoList

Field Name

Required

Type

Description

Format

endEntityPermissionList

List of EndEntityPermission

2.159. GetEndEntityPropertyResponseDtoList

Field Name

Required

Type

Description

Format

endEntityPropertyList

List of EndEntityProperty

2.160. GetEndEntityResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

realmId

UUID

uuid

commonName

String

organization

String

organizationalUnit

String

country

String

externalId

String

domains

List of [string]

ips

List of [string]

genericDtoList

List of GenericDto

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

endEntityStrategy

EndEntityStrategy

alias

String

matchesPolicyEndEntityRules

Boolean

2.161. GetEndEntityResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetEndEntityResponseDto

pageDetails

PageDetailsDto

2.162. GetEndEntityStrategyResponseDtoList

Field Name

Required

Type

Description

Format

endEntityStrategyList

List of EndEntityStrategy

2.163. GetEntitiesEnumResponseDtoList

Field Name

Required

Type

Description

Format

entitiesEnumList

List of EntitiesEnum

2.164. GetEntityRoleNamesResponseDto

Field Name

Required

Type

Description

Format

entityId

UUID

uuid

entityRoleNames

Set of [string]

2.165. GetGlobalPermissionResponseDtoList

Field Name

Required

Type

Description

Format

globalPermissionList

List of GlobalPermission

2.166. GetImportedCertificatesStatisticsResponseDto

Field Name

Required

Type

Description

Format

imported

Long

int64

issued

Long

int64

2.167. GetKeyPairModeResponseDtoList

Field Name

Required

Type

Description

Format

keyPairModeList

List of KeyPairMode

2.168. GetMailingListResponseDto

Field Name

Required

Type

Description

Format

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

UUID

uuid

name

String

emails

List of MailingListToEmailDto

2.169. GetMailingListResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetMailingListResponseDto

pageDetails

PageDetailsDto

2.170. GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto

Field Name

Required

Type

Description

Format

users

Set of MinimalSecurityIdentityRepresentationDto

apiClients

Set of MinimalSecurityIdentityRepresentationDto

2.171. GetPendingCertReqResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

policyId

UUID

uuid

endEntityId

UUID

uuid

keyPairMode

KeyPairMode

validFor

ValidFor

certRequestStatus

CertRequestStatus

keyGenParamsDto

KeyGenParamsDto

metadata

AuditedAndVersionDtoUUID

2.172. GetPendingCertReqResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetPendingCertReqResponseDto

pageDetails

PageDetailsDto

2.173. GetPoliciesInRealmsDto

It includes the Realm Ids, needed for the search

Field Name

Required

Type

Description

Format

realmIds

List of [UUID]

uuid

2.174. GetPolicyPermissionResponseDtoList

Field Name

Required

Type

Description

Format

policyPermissionList

List of PolicyPermission

2.175. GetPolicyResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

certificateProviderDto

CertificateProviderDto

certificateProviderConfiguration

String

realmId

UUID

uuid

requiresManualApproval

Boolean

allowedKeyPairModes

Set of KeyPairMode

allowedValidForValues

Set of ValidFor

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

metadata

AuditedAndVersionDtoUUID

endEntityStrategy

EndEntityStrategy

archival

ArchivedDtoUUID

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationResponseDto

CmpConfigurationResponseDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.176. GetPolicyResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetPolicyResponseDto

pageDetails

PageDetailsDto

2.177. GetRSAKeySizeResponseDtoList

Field Name

Required

Type

Description

Format

rsaKeySizeList

List of RsaKeySize

2.178. GetRaCertificateResponseDto

Field Name

Required

Type

Description

Format

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.179. GetRealmPermissionResponseDtoList

Field Name

Required

Type

Description

Format

realmPermissionList

List of RealmPermission

2.180. GetRealmResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

mailingListDto

MailingListDto

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.181. GetRealmResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetRealmResponseDto

pageDetails

PageDetailsDto

2.182. GetRevocationReasonResponseDtoList

Field Name

Required

Type

Description

Format

revocationReasonList

List of [string]

2.183. GetRoleDetailsResponseDto

Field Name

Required

Type

Description

Format

name

String

providerId

UUID

uuid

globalPermissions

realmPermissions

policyPermissions

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

2.184. GetRoleResponseDto

Field Name

Required

Type

Description

Format

name

String

globalPermissions

realmPermissions

policyPermissions

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

2.185. GetRoleResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of GetRoleResponseDto

pageDetails

PageDetailsDto

2.186. GetSecurityIdentityRolesResponseDto

Field Name

Required

Type

Description

Format

roles

Set of GetRoleResponseDto

2.187. GetSelfSignedCertificatesStatisticsResponseDto

Field Name

Required

Type

Description

Format

selfSigned

Long

int64

nonSelfSigned

Long

int64

2.188. GetTrustedCasRequestDto

The options regarding which CAs will be returned

Field Name

Required

Type

Description

Format

includeRootOnly

Boolean

includeVerifyServersOnly

Boolean

2.189. GetTrustedCasResponseDto

Field Name

Required

Type

Description

Format

trustedCas

List of [string]

2.190. GetValidForResponseDtoList

Field Name

Required

Type

Description

Format

validForList

List of ValidFor

2.191. GlobalPermission

Field Name

Required

Type

Description

Format

2.192. ImportCaDto

Field Name

Required

Type

Description

Format

UUID

uuid

fingerprint

String

isRootCa

Boolean

2.193. ImportCaRequestDto

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

Field Name

Required

Type

Description

Format

pemFileContents

String

2.194. ImportCaResponseDto

Field Name

Required

Type

Description

Format

importedCaDtoList

List of ImportCaDto

cas

List of [UUID]

uuid

2.195. ImportCertificatesRequestDto

It includes encoded certificates and the necessary metadata for it

Field Name

Required

Type

Description

Format

policyId

UUID

uuid

discoveredCertsInPem

List of ImportPemCertificatesDto

2.196. ImportCertificatesResponseDto

Field Name

Required

Type

Description

Format

hashAlgorithmId

String

successful

List of SuccessfulImportCertRequestResponseDto

failed

List of FailedImportCertRequestResponseDto

certificates

List of [UUID]

uuid

2.197. ImportPemCertificatesDto

Field Name

Required

Type

Description

Format

server

String

port

Integer

int32

pemCertificates

String

2.198. KeyGenParamsDto

Field Name

Required

Type

Description

Format

cryptoAlgorithm

CryptoAlgorithm

keySize

RsaKeySize

exponent

Integer

namedCurve

String

edDsaCurve

EdDsaCurve

2.199. KeyPairMode

Field Name

Required

Type

Description

Format

2.200. KeystoreFileDto

Field Name

Required

Type

Description

Format

base64EncodedPkcs12

String

base64EncodedJceKs

String

fileName

String

filePassword

String

2.201. MailingListDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

archived

Boolean

version

Integer

int32

2.202. 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.203. MailingListToEmailDto

Field Name

Required

Type

Description

Format

emailId

UUID

uuid

mailingListId

UUID

uuid

emailName

String

optOut

Boolean

2.204. 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.205. MinimalSecurityIdentityRepresentationDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

2.206. MscaTemplatesResponseDto

Field Name

Required

Type

Description

Format

templateNames

List of [string]

2.207. OcspCertStatus

Field Name

Required

Type

Description

Format

2.208. OcspStatusCheckDto

Field Name

Required

Type

Description

Format

ocspCertStatus

OcspCertStatus

2.209. OrderCertificateResponseDto

Field Name

Required

Type

Description

Format

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

certificateId

UUID

uuid

errorOccurred

Boolean

2.210. OrderMultipleCertificatesResponseDto

Field Name

Required

Type

Description

Format

base64EncodedZippedArtifacts

String

artifactsPassword

String

successfulCertificateOrders

List of SuccessfulCertificateOrderResultDto

failedCertificateOrders

List of FailedCertificateOrderResultDto

issuedCertificateIds

List of [UUID]

uuid

successfulCertificateRequests

List of [UUID]

uuid

2.211. PageDetailsDto

Field Name

Required

Type

Description

Format

totalElements

Long

int64

pageNumber

Integer

int32

pageSize

Integer

int32

numberOfElementsInPage

Integer

int32

2.212. ParsePkcs10ResponseDto

Field Name

Required

Type

Description

Format

keyPairMode

KeyPairMode

keyGenParamsDto

KeyGenParamsDto

pkcs10ReqBase64

String

2.213. Pkcs10Dto

It includes the base64 Encoded Pkcs10 needed to search for the End Entity

Field Name

Required

Type

Description

Format

base64EncodedPkcs10

String

2.214. PolicyPermission

Field Name

Required

Type

Description

Format

2.215. PolicySearchRequestDto

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

Field Name

Required

Type

Description

Format

realmId

UUID

uuid

simpleSearchTerm

String

policyIds

Set of [UUID]

uuid

archived

Boolean

2.216. PublicCAsProductType

Field Name

Required

Type

Description

Format

2.217. PublicCAsProductValidationType

Field Name

Required

Type

Description

Format

2.218. PublicCAsProductsResponseDto

Field Name

Required

Type

Description

Format

products

List of PublicCasProductResponseDto

2.219. PublicCasProductResponseDto

Field Name

Required

Type

Description

Format

number

String

monthValidity

Integer

int32

name

String

type

PublicCAsProductType

validationType

PublicCAsProductValidationType

signatureAlgorithms

List of [string]

2.220. RaCertificatePemDto

Field Name

Required

Type

Description

Format

Long

int64

fileName

String

pemCertificate

String

2.221. RawPemCertificateDto

PEM Encoded Certificate

Field Name

Required

Type

Description

Format

pemCertificate

String

2.222. RealmPermission

Field Name

Required

Type

Description

Format

2.223. 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.224. ResetApiClientSecretResponse

Field Name

Required

Type

Description

Format

secret

String

metadata

AuditedAndVersionDtoUUID

2.225. ResetEndEntityPasswordResponseDto

Field Name

Required

Type

Description

Format

password

String

metadata

AuditedAndVersionDtoUUID

2.226. RevocationReason

Field Name

Required

Type

Description

Format

2.227. RevokeCertificateDto

Field Name

Required

Type

Description

Format

UUID

uuid

revocationReason

RevocationReason

2.228. RevokeCertificateRequestDto

It includes all the properties needed to revoke the desired Certificates

Field Name

Required

Type

Description

Format

revokeCertificateDtos

List of RevokeCertificateDto

2.229. RevokeCertificateResponseDto

Field Name

Required

Type

Description

Format

certificateRevocationResult

CertificateRevocationResult

certificateRevocationReason

RevocationReason

revocationResult

String

2.230. RevokeMultipleCertificateResponseDto

Field Name

Required

Type

Description

Format

successfulRevocation

Boolean

Field Name

Required

Type

Description

Format

keySize

RsaKeySize

exponent

Integer

cryptoAlgorithm

CryptoAlgorithm

2.238. RsaKeySize

Field Name

Required

Type

Description

Format

2.239. ScepDecryptDataRequestDto

Field Name

Required

Type

Description

Format

data

byte[]

byte

policyId

UUID

uuid

2.240. ScepDecryptDataResponseDto

Field Name

Required

Type

Description

Format

data

byte[]

byte

2.241. ScepSignDataResponseDto

Field Name

Required

Type

Description

Format

signature

byte[]

byte

2.242. ScepSignRequestDto

Field Name

Required

Type

Description

Format

data

byte[]

byte

policyId

UUID

uuid

encodedIssuer

byte[]

byte

algorithmID

byte[]

byte

2.243. SearchAllRequestDto

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

Field Name

Required

Type

Description

Format

simpleSearchTerm

String

archived

Boolean

2.244. SearchCaResponseDto

Field Name

Required

Type

Description

Format

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.245. SearchCaResponseDtoPage

Field Name

Required

Type

Description

Format

content

List of SearchCaResponseDto

pageDetails

PageDetailsDto

2.246. SearchConfigurationRequestDto

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

Field Name

Required

Type

Description

Format

keys

List of SettingsKey

2.247. SearchRoleRequestDto

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

Field Name

Required

Type

Description

Format

simpleSearchTerm

String

2.248. SecurityIdentityType

Field Name

Required

Type

Description

Format

2.249. SetEndEntityAliasRequestDto

It includes all the properties needed to set an Alias for an End Entity

Field Name

Required

Type

Description

Format

endEntityStrategy

EndEntityStrategy

alias

String

2.250. SettingsKey

Field Name

Required

Type

Description

Format

2.251. SignDataRequestDto

Field Name

Required

Type

Description

Format

data

byte[]

byte

algorithmAID

byte[]

byte

policyId

UUID

uuid

encodedIssuer

byte[]

byte

2.252. SignDataResponseDto

Field Name

Required

Type

Description

Format

signature

byte[]

byte

2.253. SignerConfigurationDto

Field Name

Required

Type

Description

Format

signerConfiguration

String

cmpSignatureAlgorithm

CmpSignatureAlgorithm

2.254. SuccessfulCertificateOrderResultDto

Field Name

Required

Type

Description

Format

certRequestId

UUID

uuid

certificateId

UUID

uuid

2.255. SuccessfulImportCertRequestResponseDto

Field Name

Required

Type

Description

Format

certificateFingerprint

String

certRequestId

UUID

uuid

certRequestStatus

CertRequestStatus

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

version

Integer

The current Version of the Entity that the client is requesting to update. It is used to check whether a newer Version of the Entity currently exists before the update.

int32

2.257. UpdateApiClientResponse

Field Name

Required

Type

Description

Format

UUID

uuid

secret

String

metadata

AuditedAndVersionDtoUUID

2.258. UpdateCaRequestDto

It includes all the properties needed for the update

Field Name

Required

Type

Description

Format

verifyServers

Boolean

version

Integer

int32

2.259. UpdateCaResponseDto

Field Name

Required

Type

Description

Format

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.260. UpdateCertificateProviderRequestDto

It includes all the properties needed for the update

Field Name

Required

Type

Description

Format

name

String

configuration

Object

version

Integer

int32

2.261. UpdateCertificateProviderResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

certificateProviderType

CertificateProviderType

configuration

Object

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

2.262. UpdateConfigurationBatchRequestDto

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

Field Name

Required

Type

Description

Format

updateConfigurationRequestDtoList

List of UpdateConfigurationRequestDto

2.263. UpdateConfigurationBatchResponseDto

Field Name

Required

Type

Description

Format

updateConfigurationResponseDtoList

List of UpdateConfigurationResponseDto

configurations

List of [string]

2.264. UpdateConfigurationRequestDto

It includes all the necessary values to update an existing Configuration

Field Name

Required

Type

Description

Format

settingsKey

SettingsKey

configuration

String

version

Integer

int32

2.265. UpdateConfigurationResponseDto

Field Name

Required

Type

Description

Format

configurationValue

String

setting

SettingsKey

version

Integer

int32

configuration

String

2.266. UpdateMailingListRequestDto

It includes all the properties needed to complete the update

Field Name

Required

Type

Description

Format

name

String

emails

List of CreateNewEmailRequestDto

version

Integer

int32

2.267. UpdateMailingListResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

emails

List of MailingListToEmailDto

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.268. UpdatePolicyRequestDto

It includes all the properties needed for the update

Field Name

Required

Type

Description

Format

name

String

certificateProviderId

UUID

uuid

certificateProviderConfiguration

String

allowedKeyPairModes

Set of KeyPairMode

allowedValidForValues

Set of ValidFor

cryptoRestrictions

CryptoRestrictionsDto

version

Integer

int32

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

endEntityRules

Set of EndEntityRule

cmpEnabled

Boolean

cmpConfigurationRequestDto

CmpConfigurationRequestDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.269. UpdatePolicyResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

certificateProviderDto

CertificateProviderDto

certificateProviderConfiguration

String

requiresManualApproval

Boolean

allowedKeyPairModes

Set of KeyPairMode

allowedValidForValues

Set of ValidFor

cryptoRestrictions

CryptoRestrictionsDto

endEntityRules

Set of EndEntityRule

dualControl

Boolean

requiresEmailVerification

Boolean

endEntityStrategy

EndEntityStrategy

metadata

AuditedAndVersionDtoUUID

archival

ArchivedDtoUUID

enforceActiveCertUniqueness

Boolean

enforceActiveCertUniquenessExpirationToleranceInDays

Integer

int32

cmpEnabled

Boolean

cmpConfigurationResponseDto

CmpConfigurationResponseDto

certificateImportAllowed

Boolean

selfSignedAllowed

Boolean

wildcardAllowed

Boolean

2.270. UpdateRealmRequestDto

It includes all the properties needed for the update

Field Name

Required

Type

Description

Format

name

String

mailingListId

UUID

uuid

version

Integer

int32

2.271. UpdateRealmResponseDto

Field Name

Required

Type

Description

Format

UUID

uuid

name

String

mailingListDto

MailingListDto

archival

ArchivedDtoUUID

metadata

AuditedAndVersionDtoUUID

2.272. UpdateRoleRequestDto

It includes all the properties needed for the update

Field Name

Required

Type

Description

Format

name

String

globalPermissions

realmPermissions

policyPermissions

endEntityPermissions

Set of RoleEntityPermissionsDtoEndEntityPermission

certRequestPermissions

Set of RoleEntityPermissionsDtoCertRequestPermission

certificatePermissions

Set of RoleEntityPermissionsDtoCertificatePermission

2.273. UpdateRoleResponseDto

Field Name

Required

Type

Description

Format

name

String

globalPermissions

realmPermissions

policyPermissions