Endpoints
Admin
archiveEntitiesBatch
POST /api/v1/admin/batch-archive
Batch Archive resources from an Entity
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Archived the requested resources of an Entity |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
archiveSingleEntity
PATCH /api/v1/admin/{id}/archive
Archive a resource from an Entity
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Archived the requested resource of an Entity |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
deleteArchived
DELETE /api/v1/admin/archived
Delete archived resources from an Entity
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Deleted the archived resource of an Entity |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
deleteArchivedEntities
POST /api/v1/admin/batch-delete
Batch Delete archived resources from an Entity
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Deleted the requested resources |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
ApiClient
createNewApiClient
POST /api/v1/api-clients/
Create an Api Client
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Api Client created |
CreateNewApiClientResponse[CreateNewApiClientResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
deleteApiClient
DELETE /api/v1/api-clients/{id}
Delete Api Client
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Api Client Deleted |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getApiClientDetails
GET /api/v1/api-clients/{id}
Get Api Client
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Api Client |
GetApiClientDetailsResponse[GetApiClientDetailsResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
resetApiClientSecret
POST /api/v1/api-clients/{id}/reset-secret
Reset Api Client’s secret
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Api Client's secret was reset |
ResetApiClientSecretResponse[ResetApiClientSecretResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchApiClients
POST /api/v1/api-clients/search
Search Api Clients
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Api Clients |
GetApiClientResponseDtoPage[GetApiClientResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateApiClient
PUT /api/v1/api-clients/{id}
Update an Api Client
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The id of the desired Api Client |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Api Client updated |
UpdateApiClientResponse[UpdateApiClientResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
AsyncCertificate
orderCertificate
POST /api/v2/certificates/cert-requests/{id}
Order a Certificate by Certificate Request
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Certificate Ordered |
OrderCertificateResponseDto[OrderCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
orderMultipleCertificates
POST /api/v2/certificates/cert-requests
Order Multiple Certificates by Certificate Requests
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Certificates ordered |
OrderMultipleCertificatesResponseDto[OrderMultipleCertificatesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
AuthenticatedPrincipal
getAuthenticatedPrincipal
GET /api/v1/authenticated-principal/
Get Authenticated Principal
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Authenticated Principal Found |
AuthenticatedPrincipalResponseDto[AuthenticatedPrincipalResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getAuthenticatedPrincipalPermissions
GET /api/v1/authenticated-principal/permissions
Get Authenticated Principal concatenated permissions
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Authenticated Principal Permissions Found |
GetAuthenticatedPrincipalPermissionsResponseDto[GetAuthenticatedPrincipalPermissionsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Ca
downloadCaCertificate
GET /api/v1/cas/{id}/download
Download CA Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
CA Certificate Downloaded |
CaCertificateDataPemDto[CaCertificateDataPemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCa
GET /api/v1/cas/{id}
Get CA by Id
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found CA |
GetCaResponseDto[GetCaResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getTrustedCas
POST /api/v1/cas/get-trusted
Get trusted CAs in PEM format according to the search criteria.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Trusted CAs acquired |
GetTrustedCasResponseDto[GetTrustedCasResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
importCaCertificates
POST /api/v1/cas/import
Import CA Certificate(s) from pem file content
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
CA Certificate(s) Imported |
ImportCaResponseDto[ImportCaResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchCas
POST /api/v1/cas/search
Search CA
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found CA |
SearchCaResponseDtoPage[SearchCaResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateCa
PATCH /api/v1/cas/{id}
Update a CA
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of the CA that will be updated |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
CA Updated |
UpdateCaResponseDto[UpdateCaResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
verifyCaCertificates
POST /api/v1/cas/import/verify
Verify CA Certificate(s) from PEM file content
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
CA Certificate(s) Verified |
VerifyImportCaResponseDto[VerifyImportCaResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
CertRequest
approveCertRequest
PATCH /api/v1/cert-requests/{id}/approve
Approve a Certificate Request
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Request Approved |
ApproveCertReqResponseDto[ApproveCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createCertRequest
POST /api/v1/cert-requests/
Create a Certificate Request
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Certificate Request Created |
CreateCertReqResponseDto[CreateCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createMultipleCertRequest
POST /api/v1/cert-requests/multiple
Create a Certificate Request for multiple End Entities
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Certificate Request Created |
CreateMultipleCertReqResponseDto[CreateMultipleCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
declineCertRequest
PATCH /api/v1/cert-requests/{id}/decline
Decline a Certificate Request
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Request Declined |
DeclineCertReqResponseDto[DeclineCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
examinePkcs10Request
PUT /api/v1/cert-requests/examine-pkcs10-request
Examine PKCS10 request against End Entity and Policy
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Examination completed |
ExaminePkcs10RequestResponseDto[ExaminePkcs10RequestResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertRequest
GET /api/v1/cert-requests/{id}
Get a Certificate Request
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Request Found |
GetCertReqResponseDto[GetCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertRequestAdditionalData
PATCH /api/v1/cert-requests/{id}/additional-data
Get Certificate Request additional data
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Request Found |
GetCertRequestAdditionalDataResponseDto[GetCertRequestAdditionalDataResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertRequestByPkcs10AndEndEntity
POST /api/v1/cert-requests/end-entities/{id}/by-pkcs10
Get Certificate Request by End Entity and PKCS10
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The id of the End Entity, used to find the desired Certificate Request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Request found |
GetCertReqResponseDto[GetCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getMostRecentPendingCertificates
GET /api/v1/cert-requests/realms/{id}/pending
Get pending Certificate Requests of a specific Realm
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Pending Certificate Requests of Realm Found |
GetPendingCertReqResponseDtoPage[GetPendingCertReqResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getNameOfRolesWithCertRequestAccess
GET /api/v1/cert-requests/{id}/roles
Get role names of respective certificate request
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
importCertificates
POST /api/v1/cert-requests/import-certificates
Import certificates
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Certificates imported |
ImportCertificatesResponseDto[ImportCertificatesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
resendEmailVerificationForCertRequest
POST /api/v1/cert-requests/{id}/resend-verification-email
Resend E-Mail verification for a Certificate Request
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The id of the Certificate Request for which the resend verification E-Mail is requested |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
E-Mail verification sent |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchAllCertRequests
POST /api/v1/cert-requests/search-all
Search all Certificate Requests
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Requests Found |
GetCertReqResponseDtoPage[GetCertReqResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchCertRequests
POST /api/v1/cert-requests/search
Search Certificate Requests
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Requests Found |
GetCertReqResponseDtoPage[GetCertReqResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
verifyImportCertificates
POST /api/v1/cert-requests/import-certificates/verify
Verify import certificates request
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Import certificates request verified |
VerifyImportCertificatesResponseDto[VerifyImportCertificatesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Certificate
createCertificate
POST /api/v1/certificates/cert-requests/{id}
Create Certificate by Certificate Request
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Certificate Created |
CreateCertificateResponseDto[CreateCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createMultipleCertificates
POST /api/v1/certificates/cert-requests
Create Multiple Certificates by Certificate Requests
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Certificates Created |
CreateMultipleCertificateFromCertRequestsResponseDto[CreateMultipleCertificateFromCertRequestsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadCaChainForPolicy
GET /api/v1/certificates/policies/{id}/download-ca-chain
Download the CA chain for a specified Policy
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policy CA chain downloaded successfully |
CaCertificatePemDto[CaCertificatePemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadCertificate
GET /api/v1/certificates/{id}/download
Download Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Downloaded |
CertificatePemDto[CertificatePemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadCertificateChain
GET /api/v1/certificates/{id}/download-chain
Download Chain of Certificate
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Chain Downloaded |
CertificatePemDto[CertificatePemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadCertificatePrivateKey
GET /api/v1/certificates/{id}/download-private-key
Download private key of the Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate private key downloaded |
CertificatePrivateKeyPemDto[CertificatePrivateKeyPemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadCertificatesAsZip
GET /api/v1/certificates/batch-download
Batch Download Certificates
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ids |
The list of ids in order to specify the desired Certificates [UUID] |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificates Downloaded |
ZippedFileDto[ZippedFileDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadCrl
GET /api/v1/certificates/{id}/crl
Download crl for a Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate's crl downloaded |
CrlDto[CrlDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
emailCertificate
POST /api/v1/certificates/{id}/email
Send Certificate E-Mail
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Certificate E-Mail sent |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getAuditEventsForCertificate
GET /api/v1/certificates/{id}/audit-events
Get Audit Events for a Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate's Audit Events Found |
GetAuditEventResponseDtoList[GetAuditEventResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateByFingerprint
GET /api/v1/certificates/by-fingerprint
Get Certificate by fingerprint
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Certificate |
GetCertificateResponseDto[GetCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateByIssuerDnBinAndSerialNumber
POST /api/v1/certificates/by-issuer-dn-bin-and-serial-number
Get Certificate by issuer dn bin and serial number
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Certificate |
GetCertificateResponseDto[GetCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateDetails
GET /api/v1/certificates/{id}
Get Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Certificate |
GetCertificateResponseDto[GetCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificatesByRealmId
GET /api/v1/certificates/realms/{id}
Get available Certificates in Realm
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The id of the Realm which will be used to get the Certificates that are a part of it |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Certificates |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getNameOfRolesWithCertificateAccess
GET /api/v1/certificates/{id}/roles
Get role names of respective certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getOcspStatus
GET /api/v1/certificates/{id}/ocsp-status
Get the OCSP status of a Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OCSP status of Certificate Found |
OcspStatusCheckDto[OcspStatusCheckDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getSoonExpiringCertificates
GET /api/v1/certificates/realms/{id}/expiring
Get the Certificates that are expiring soon of the requested Realm
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expiring soon Certificates for the Realm Found |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
markCertificatesAsRevoked
PATCH /api/v1/certificates/mark-as-revoked
Mark Certificates as revoked
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Certificates Marked As Revoked |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
retrieveCertificateP12
GET /api/v1/certificates/{id}/pkcs12
Retrieve P12 Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
P12 Certificate Retrieved |
KeystoreFileDto[KeystoreFileDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
revokeCertificate
POST /api/v1/certificates/revoke
Revoke Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Revoked |
RevokeCertificateResponseDto[RevokeCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
revokeMultipleCertificates
POST /api/v1/certificates/batch-revoke
Batch Revoke Certificates
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificates Revoked |
RevokeMultipleCertificateResponseDto[RevokeMultipleCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchAllCertificates
POST /api/v1/certificates/search-all
Search all Certificates
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Certificates |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchCertificates
POST /api/v1/certificates/search
Search Certificates
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Certificates |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
validateCertificate
POST /api/v1/certificates/validate
Validates a PEM certificate returning true/false and CA chain, if the certificate can be validated by the known CAs in the system
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate is validated |
CertificateValidationResponseDto[CertificateValidationResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
validateCertificatePlain
POST /api/v1/certificates/validate-plain
Validates a PEM certificate returning true/false, if the certificate can be validated by the known CAs in the system
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate is validated |
CertificatePlainValidationResponseDto[CertificatePlainValidationResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
CertificateProvider
checkCertificateProviderConnection
POST /api/v1/certificate-providers/{id}/check-connection
Check connected of the Certificate Provider
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Provider connected Checked |
CheckCertificateProviderConnectionDto[CheckCertificateProviderConnectionDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createCertificateProvider
POST /api/v1/certificate-providers/
Create a Certificate Provider
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Created Certificate Provider |
CreateCertificateProviderResponseDto[CreateCertificateProviderResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateProvider
GET /api/v1/certificate-providers/{id}
Get Certificate Provider by Id
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Certificate Provider |
GetCertificateProviderResponseDto[GetCertificateProviderResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchCertificateProviders
POST /api/v1/certificate-providers/search
Find the Certificate Providers
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Providers Found |
GetCertificateProviderResponseDtoPage[GetCertificateProviderResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchCertificateProvidersForPolicyCreateUpdate
POST /api/v1/certificate-providers/minimal/search
Find the Certificate Providers (non admin)
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Providers Found |
GetCertificateProviderMinimalResponseDtoPage[GetCertificateProviderMinimalResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateCertificateProvider
PATCH /api/v1/certificate-providers/{id}
Update a Certificate Provider
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of Certificate Provider that will be updated |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Provider Updated |
UpdateCertificateProviderResponseDto[UpdateCertificateProviderResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
CertificateProviderOptions
getAllTemplateSignersByCertificateProviderId
GET /api/v1/certificate-providers-options/{id}/all-cara-template-signers
Returns all Template Signers of the Certificate Provider with this ID and the RA Template Signers
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Template Signers Found |
CaraTemplateSignerDtoList[CaraTemplateSignerDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getMscaTemplatesByCertificateProviderId
GET /api/v1/certificate-providers-options/{id}/msca-templates
Returns the MS CA Templates of the Certificate Provider with this ID
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
MS CA Templates Found |
MscaTemplatesResponseDto[MscaTemplatesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getPublicCasProducts
GET /api/v1/certificate-providers-options/{id}/public-cas-products
Returns the Public CAs products of the Certificate Provider with this ID
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Public CAs Products Found |
PublicCAsProductsResponseDto[PublicCAsProductsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getTemplateSignersByCertificateProviderId
GET /api/v1/certificate-providers-options/{id}/cara-template-signers
Returns the Template Signers of the Certificate Provider with this ID
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Template Signers Found |
CaraTemplateSignerDtoList[CaraTemplateSignerDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Cmp
calculateMac
POST /api/v1/cmp/calculate-mac
Perform a MAC calculation with an End Entity password and a policy
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Mac calculation operation was completed without errors. See response for verification result. |
CmpCalculateMacResponseDto[CmpCalculateMacResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCmpConfigurationByPolicyId
GET /api/v1/cmp/policies/{policyId}/configuration
Find a CMP configuration by a policy ID
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
CMP configuration Found |
GetCmpConfigurationResponseDto[GetCmpConfigurationResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
signData
POST /api/v1/cmp/sign
Signs the data with CMP signer for the policy provided in the parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Data signed |
SignDataResponseDto[SignDataResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
verifyMacEndEntityCommonName
POST /api/v1/cmp/verify-mac/cn
Verifies a MAC using an end-entity password and policy by searching for the end-entity using its common name.
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Mac verify operation was completed without errors. See response for verification result. |
CmpVerifyMacResponseDto[CmpVerifyMacResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
verifyMacEndEntityId
POST /api/v1/cmp/verify-mac/id
Verifies a MAC using an end-entity password and a policy by searching for the end-entity using its ID.
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Mac verify operation was completed without errors. See response for verification result. |
CmpVerifyMacResponseDto[CmpVerifyMacResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Configuration
checkEmailConnection
POST /api/v1/configuration/check-email-connection
Check the connection of the configuration E-Mail
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The Configuration E-Mail connection was checked successfully |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createConfiguration
POST /api/v1/configuration/
Create new Configuration
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Configuration Created |
CreateConfigurationResponseDto[CreateConfigurationResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
deleteConfiguration
DELETE /api/v1/configuration/{settingsKey}
Delete Configuration
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Configuration Deleted |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getConfiguration
GET /api/v1/configuration/{settingsKey}
Retrieve Configuration by Setting key
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Configuration Found |
GetConfigurationResponseDto[GetConfigurationResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchConfiguration
POST /api/v1/configuration/search
Search Configuration
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Configuration |
GetConfigurationResponseDtoPage[GetConfigurationResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateConfiguration
PATCH /api/v1/configuration/
Update Configuration
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Configuration Updated |
UpdateConfigurationResponseDto[UpdateConfigurationResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateConfigurationBatch
PATCH /api/v1/configuration/batch
Update Configuration values in batch mode
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Configuration values Updated |
UpdateConfigurationBatchResponseDto[UpdateConfigurationBatchResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
CryptoModules
createCryptoModule
POST /api/v1/crypto-modules/
Create a Crypto Module
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Created Crypto Module |
CreateCryptoModuleResponseDto[CreateCryptoModuleResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCryptoModule
GET /api/v1/crypto-modules/{id}
Get Crypto Module by ID
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Crypto Module found |
GetCryptoModuleResponseDto[GetCryptoModuleResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
performHealthCheck
PATCH /api/v1/crypto-modules/{id}/health-check
Perform health check for Crypto Module
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Health check for crypto module performed |
GetCryptoModuleHealthCheckResponseDto[GetCryptoModuleHealthCheckResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchCryptoModules
POST /api/v1/crypto-modules/search
Search the Crypto Modules
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Crypto Modules found |
GetCryptoModuleResponseDtoPage[GetCryptoModuleResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
EndEntity
createNewEndEntity
POST /api/v1/end-entities/
Create an End Entity
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Created End Entity |
CreateEndEntityResponseDto[CreateEndEntityResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
findEeByCertBytes
POST /api/v1/end-entities/find-by-cert-bytes
Get End Entity by certificate bytes
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found End Entity |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
findEndEntityByPolicyIdAndEndEntityDataset
POST /api/v1/end-entities/policies/{id}/by-end-entity-dataset
Find End Entity by Policy and End Entity dataset
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The id passed in the url is the id of the Policy that will be used for the search of the End Entity |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
End Entity found by Policy and dataset |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEndEntity
GET /api/v1/end-entities/{id}
Get End Entity by Id
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found End Entity |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEndEntityByRealmIdAndExternalId
GET /api/v1/end-entities/realms/{realmId}/externals/{externalId}
Get End Entity by Realm and External Id
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found End Entity |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getNameOfRolesWithEndEntityAccess
GET /api/v1/end-entities/{id}/roles
Get role names of respective end entity
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchAllEndEntities
POST /api/v1/end-entities/search-all
Search all End Entities
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found End Entities |
GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchEndEntities
POST /api/v1/end-entities/search
Search End Entities
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found End Entities |
GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
uploadEndEntitiesCsv
POST /api/v1/end-entities/upload-csv
Add multiple End Entities from csv file
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
The End Entities were saved successfully |
EndEntityMassImportResponseDto[EndEntityMassImportResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
EndEntityPassword
createNewEndEntityPassword
POST /api/v1/end-entity-passwords/
Create Password for End Entity
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Password for End Entity created |
CreateEndEntityPasswordResponseDto[CreateEndEntityPasswordResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
deleteEndEntityPassword
DELETE /api/v1/end-entity-passwords/
Delete Password of End Entity
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Password for End Entity Deleted |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEndEntityPasswordByEndEntityIdAndPolicyId
GET /api/v1/end-entity-passwords/end-entities/{endEntityId}/policies/{policyId}
Get End Entity Password by End Entity Id and Policy Id
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found End Entity Password |
GetEndEntityPasswordResponseDto[GetEndEntityPasswordResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEndEntityPasswordsByEndEntityId
GET /api/v1/end-entity-passwords/end-entities/{id}/
Find the End Entity Passwords connected with the specific End Entity
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of the End Entity for which the search is requested |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
End Entity Passwords Found |
GetEndEntityPasswordResponseDtoPage[GetEndEntityPasswordResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
resetEndEntityPassword
POST /api/v1/end-entity-passwords/reset
Reset Password of End Entity
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Password for End Entity was reset |
ResetEndEntityPasswordResponseDto[ResetEndEntityPasswordResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Enum
getApiErrorValues
GET /api/v1/public/enum/api-error-values
Get Api Error values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Api Error values found |
GetApiErrorValuesResponseDtoList[GetApiErrorValuesResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertRequestPermissionsValues
GET /api/v1/public/enum/cert-request-permissions
Get Certificate Request Permissions values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Request Permissions values found |
GetCertRequestPermissionResponseDtoList[GetCertRequestPermissionResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertStatusValues
GET /api/v1/public/enum/cert-status-values
Get Certificate Status values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Status values found |
GetCertStatusResponseDtoList[GetCertStatusResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificatePermissionsValues
GET /api/v1/public/enum/certificate-permissions
Get Certificate Permissions values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Permissions values found |
GetCertificatePermissionResponseDtoList[GetCertificatePermissionResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateProviderTypeResponseDtoList
GET /api/v1/public/enum/certificate-provider-type-values
Get Certificate Provider type values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Provider type values found |
GetCertificateProviderTypeResponseDtoList[GetCertificateProviderTypeResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateSearchKeyValues
GET /api/v1/public/enum/cert-search-key-values
Get Certificate Search Key values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Search Key values found |
GetCertificateSearchKeyResponseDtoList[GetCertificateSearchKeyResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCmpSignatureAlgorithmValues
GET /api/v1/public/enum/cmp-signature-algorithm-values
Get CMP Signature Algorithm values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
CMP Signature Algorithm values found |
GetCmpSignatureAlgorithmResponseDtoList[GetCmpSignatureAlgorithmResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCryptoAlgorithmValues
GET /api/v1/public/enum/crypto-algorithm-values
Get Crypto Algorithm values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Crypto Algorithm values found |
GetCryptoAlgorithmResponseDtoList[GetCryptoAlgorithmResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCryptoModuleTypes
GET /api/v1/public/enum/crypto-module-type-values
Get Crypto Module type values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Crypto Module type values found |
GetCryptoModuleTypeListResponseDto[GetCryptoModuleTypeListResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEcNamedCurvesValues
GET /api/v1/public/enum/ec-named-curves-values
Get EC Named Curves values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
EC Named Curves values found |
GetECNamedCurveResponseDtoList[GetECNamedCurveResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEdDSANamedCurvesValues
GET /api/v1/public/enum/eddsa-named-curves-values
Get EdDSA Named Curves values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
EdDSA Named Curves values found |
GetEdDSANamedCurveResponseDtoList[GetEdDSANamedCurveResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEndEntityPermissionsValues
GET /api/v1/public/enum/end-entity-permissions
Get End Entity Permissions values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
End Entity Permissions values found |
GetEndEntityPermissionResponseDtoList[GetEndEntityPermissionResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEndEntityPropertiesValues
GET /api/v1/public/enum/end-entity-properties
Get End Entity Properties values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
End Entity Properties values found |
GetEndEntityPropertyResponseDtoList[GetEndEntityPropertyResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEntitiesEnumValues
GET /api/v1/public/enum/entities-enum-values
Get End Entity Enum values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
End Entity Enum values found |
GetEntitiesEnumResponseDtoList[GetEntitiesEnumResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getEntityStrategyEnumValues
GET /api/v1/public/enum/entity-strategy-enum-values
Get Entity Strategy Enum values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Entity Strategy Enum values found |
GetEndEntityStrategyResponseDtoList[GetEndEntityStrategyResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getGlobalPermissionsValues
GET /api/v1/public/enum/global-permissions
Get Global Permissions values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Global Permissions values found |
GetGlobalPermissionResponseDtoList[GetGlobalPermissionResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getKeyPairModeValues
GET /api/v1/public/enum/key-pair-mode-values
Get Key Pair Mode values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Key Pair Mode values found |
GetKeyPairModeResponseDtoList[GetKeyPairModeResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getPolicyPermissionsValues
GET /api/v1/public/enum/policy-permissions
Get Policy Permissions values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policy Permissions values found |
GetPolicyPermissionResponseDtoList[GetPolicyPermissionResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getRealmPermissionsValues
GET /api/v1/public/enum/realm-permissions
Get Realm Permissions values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Realm Permissions values found |
GetRealmPermissionResponseDtoList[GetRealmPermissionResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getRevocationReasonValues
GET /api/v1/public/enum/revocation-reason-values
Get Revocation Reason values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Revocation Reason values found |
GetRevocationReasonResponseDtoList[GetRevocationReasonResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getRsaKeySizeValues
GET /api/v1/public/enum/rsa-key-size-values
Get RSA Key Size values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
RSA Key Size values found |
GetRSAKeySizeResponseDtoList[GetRSAKeySizeResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getValidForValues
GET /api/v1/public/enum/valid-for-values
Get Valid For values
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Valid For values found |
GetValidForResponseDtoList[GetValidForResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
MailingList
createNewMailingList
POST /api/v1/mailing-lists/
Create Mailing List
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Mailing List Created |
CreateNewMailingListResponseDto[CreateNewMailingListResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getMailingList
GET /api/v1/mailing-lists/{id}
Get Mailing List by Id
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Found Mailing List |
GetMailingListResponseDto[GetMailingListResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchMailingLists
POST /api/v1/mailing-lists/search
Search Mailing Lists
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Mailing Lists Found |
GetMailingListResponseDtoPage[GetMailingListResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateMailingList
POST /api/v1/mailing-lists/{id}
Update a Mailing List
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The id of the Mailing List that will be updated |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Mailing List Updated |
UpdateMailingListResponseDto[UpdateMailingListResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Pkcs10
createPkcs10Request
POST /api/v1/pkcs10/
Create a PKCS10 Request
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PKCS10 Request Created |
CreatePkcs10ResponseDto[CreatePkcs10ResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
parsePkcs10
POST /api/v1/pkcs10/parse
Parse a PKCS10 Request
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
PKCS10 Request Parsed |
ParsePkcs10ResponseDto[ParsePkcs10ResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Policy
availablePoliciesWithoutPasswordByEndEntityId
GET /api/v1/policies/end-entities/{id}/no-password
Find the Policies without an End Entity Password for a specific End Entity
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of the End Entity for which the search is requested |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
checkEndEntityWithRules
POST /api/v1/policies/{id}/rules
Check End Entity Rules
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
End Entity Rules Checked |
CheckEndEntityResponseDto[CheckEndEntityResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createNewPolicy
POST /api/v1/policies/
Create a Policy
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Policy Created |
CreatePolicyResponseDto[CreatePolicyResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getAllowedCryptoParameters
PUT /api/v1/policies/allowed-crypto-params
Get policy allowed crypto parameters for provider provider and provider configuration
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
End Entity Rules Checked |
CryptoParametersDto[CryptoParametersDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getNameOfRolesWithPolicyAccess
GET /api/v1/policies/{id}/roles
Get role names of respective policy
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getPoliciesByCertificateProviderId
GET /api/v1/policies/certificate-providers/{id}
Search Policies that use a specific Certificate Provider
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
ID of the Certificate Provider for which the search of Policies is requested |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policies Found connected to the specific Certificate Provider |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getPoliciesInRealms
POST /api/v1/policies/realms
Find the Policies of multiple Realms
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getPolicy
GET /api/v1/policies/{id}
Find a specific Policy
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policy Found |
GetPolicyResponseDto[GetPolicyResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getPolicyByRealmId
GET /api/v1/policies/realms/{id}
Find the Policies of a Realm
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of Realm for which Policies will be searched |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchAllPolicies
POST /api/v1/policies/search-all
Search all Policies
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchPolicies
POST /api/v1/policies/search
Search Policies
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updatePolicy
PATCH /api/v1/policies/{id}
Update a Policy
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of Policy that will be updated |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Policy Updated |
UpdatePolicyResponseDto[UpdatePolicyResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
PublicUser
extractEndEntityInfoFromPemEncodedPkcs10
POST /api/v1/public/extract-end-entity-from-pkcs10
Extract End Entity info from PEM encoded PKCS10 Request
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Extracted End Entity info from PEM encoded PKCS10 Request |
ExtractEndEntityInfoFromPkcs10ResponseDto[ExtractEndEntityInfoFromPkcs10ResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
verifyCertificateRequestByEmail
POST /api/v1/public/verify-cert-request-with-email
Verify Certificate Request by E-Mail
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Verified Certificate Request and sent an E-Mail |
EmailVerifiedCertReqResponseDto[EmailVerifiedCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
RaCertificate
createBatchRaCertificateForUsers
POST /api/v1/ra-certificates/users/batch
Create Batch Ra Certificates for a User
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User's Ra Certificates Created |
ZippedCertsBatchDto[ZippedCertsBatchDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createRaCertificateForSingleUser
POST /api/v1/ra-certificates/users/{id}
Create/renew Ra Certificate for a single User
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of the User whose Ra Certificate we are creating |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User's Ra Certificate Created |
UpdateUserRaCertificateDto[UpdateUserRaCertificateDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadRaCertCrl
GET /api/v1/ra-certificates/users/{id}/crl
Download the Ra Certificate of a User
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Ra Certificate of the User Downloaded |
CrlDto[CrlDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadUserRaCertificate
GET /api/v1/ra-certificates/users/{id}/download
Download the Ra Certificate of a User
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User's Ra Certificate Downloaded |
RaCertificatePemDto[RaCertificatePemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
downloadUserRaCertificateChain
GET /api/v1/ra-certificates/users/{id}/download-chain
Download the Certificate Chain of a User
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User's Certificate Chain Downloaded |
RaCertificatePemDto[RaCertificatePemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getRaOcspStatus
GET /api/v1/ra-certificates/users/{id}/ocsp-status
Get the Ra OCSP Status of a User
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Got the Ra OCSP Status of the User |
OcspStatusCheckDto[OcspStatusCheckDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getUserRaCertificate
GET /api/v1/ra-certificates/users/{id}
Find a specific User’s Ra Certificate
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Ra Certificate Found |
GetRaCertificateResponseDto[GetRaCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
retrieveRaCertificateP12
GET /api/v1/ra-certificates/users/{id}/pkcs12
Retrieve the Ra PKCS12 Certificate of a User
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User's Ra PKCS12 Certificate Retrieved |
KeystoreFileDto[KeystoreFileDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
revokeRaCertificate
POST /api/v1/ra-certificates/users/{id}/revoke
Revoke the Ra Certificate of a User
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User's Ra Certificate Revoked |
RevokeRaCertificateResponseDto[RevokeRaCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Realm
createNewRealm
POST /api/v1/realms/
Create a Realm
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Realm Created |
CreateRealmResponseDto[CreateRealmResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getNameOfRolesWithRealmAccess
GET /api/v1/realms/{id}/roles
Get role names of respective realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getRealm
GET /api/v1/realms/{id}
Find Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Realm Found |
GetRealmResponseDto[GetRealmResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getRealms
GET /api/v1/realms/
Find Realms
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Realms Found |
GetRealmResponseDtoPage[GetRealmResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
search
POST /api/v1/realms/search
Search Realms
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Realms Found |
GetRealmResponseDtoPage[GetRealmResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateRealm
PATCH /api/v1/realms/{id}
Update a Realm
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of the Realm that will be updated |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Realm Updated |
UpdateRealmResponseDto[UpdateRealmResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
RealmStatistics
getCertRequestStatusStatisticsForRealm
GET /api/v1/realm-statistics/{id}/cert-request-status
Get the Certificate Request Status Statistics of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Request Status Statistics for the Realm Found |
GetCertRequestStatusStatisticsResponseDto[GetCertRequestStatusStatisticsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateIssuerStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-issuer
Get the Certificate Issuer Statistics of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Issuer Statistics for the Realm Found |
GetCertificateIssuerStatisticsResponseDto[GetCertificateIssuerStatisticsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateProviderTypeStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-provider-type
Get the Certificate Provider Type Statistics of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Provider Type Statistics for the Realm Found |
GetCertificateProviderTypeStatisticsResponseDto[GetCertificateProviderTypeStatisticsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificatePublicKeyAlgorithmStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-public-key-algorithm
Get the Certificate Public Key Algorithm Statistics of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Public Key Algorithm Statistics for the Realm Found |
GetCertificatePublicKeyAlgorithmStatisticsResponseDto[GetCertificatePublicKeyAlgorithmStatisticsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getCertificateStatusStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-status
Get the Certificate Status Statistics of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Certificate Status Statistics for the Realm Found |
GetCertificateStatusStatisticsResponseDto[GetCertificateStatusStatisticsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getImportedCertificatesStatisticsForRealm
GET /api/v1/realm-statistics/{id}/imported-certificates
Get the Imported Certificates Statistics of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Imported Certificates Statistics for the Realm Found |
GetImportedCertificatesStatisticsResponseDto[GetImportedCertificatesStatisticsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getLatestAuditEvents
GET /api/v1/realm-statistics/{id}/latest-audit-events
Get the latest Certificate Audit Events of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Latest Certificate Audit Events |
GetAuditEventResponseDtoList[GetAuditEventResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getSelfSignedCertificatesStatisticsForRealm
GET /api/v1/realm-statistics/{id}/self-signed-certificates
Get the Self-signed Certificates Statistics of the requested Realm
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Self-signed Certificates Statistics for the Realm Found |
GetSelfSignedCertificatesStatisticsResponseDto[GetSelfSignedCertificatesStatisticsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Roles
batchAssignApiClientRoles
PUT /api/v1/roles/api-clients/assign
Assign Roles for multiple API Clients
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
API Client Roles assigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
batchAssignUserRoles
PUT /api/v1/roles/users/assign
Assign Roles for multiple Users
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User Roles assigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
batchUnassignApiClientRoles
PUT /api/v1/roles/api-clients/unassign
Unassign Roles from multiple API Clients
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
API Client Roles unassigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
batchUnassignUserRoles
PUT /api/v1/roles/users/unassign
Unassign Roles from multiple Users
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User Roles unassigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
createRole
POST /api/v1/roles/
Create Role
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Role created |
CreateRoleResponseDto[CreateRoleResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
deleteRole
DELETE /api/v1/roles/{name}
Delete Role
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Role deleted |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
deleteRoles
POST /api/v1/roles/batch-delete
Batch Delete Roles
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role(s) deleted |
BatchDeleteRolesResponseDto[BatchDeleteRolesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getApiClientRoles
GET /api/v1/roles/api-clients/{apiClientId}
Get API Client Roles
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
API Client Roles Found |
GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getRoleDetails
GET /api/v1/roles/{name}
Get Role
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role Found |
GetRoleDetailsResponseDto[GetRoleDetailsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getSecurityIdentitiesOfRole
GET /api/v1/roles/{role}/security-identities
Get security identities of a role
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Security identities Found |
GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto[GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getUserRoles
GET /api/v1/roles/users/{userId}
Get User Roles
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User Roles Found |
GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchRoles
POST /api/v1/roles/search
Search Roles
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Roles Found |
GetRoleResponseDtoPage[GetRoleResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateApiClientRoles
PUT /api/v1/roles/api-clients/{apiClientId}
Update API Client Roles
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
apiClientId |
The id of the API Client |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
API Client Roles Updated |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateRole
PUT /api/v1/roles/{name}
Update Role
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Role updated |
UpdateRoleResponseDto[UpdateRoleResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
updateUserRoles
PUT /api/v1/roles/users/{userId}
Update User Roles
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
User Roles Updated |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Scep
decryptData
POST /api/v1/scep/decrypt
Decrypts the data with the signer of the policy provided in the parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Data decrypted |
ScepDecryptDataResponseDto[ScepDecryptDataResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
raDecryptData
POST /api/v1/scep/ra-decrypt
Decrypts the data with the RA signer of the policy provided in the parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Data decrypted |
ScepDecryptDataResponseDto[ScepDecryptDataResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
raSignDataScep
POST /api/v1/scep/ra-sign
Signs the data with the RA signer of the policy provided in the parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Data signed |
ScepSignDataResponseDto[ScepSignDataResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
signDataScep
POST /api/v1/scep/sign
Signs the data with the signer of the policy provided in the parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Data signed |
ScepSignDataResponseDto[ScepSignDataResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Sign
signDataWithCA
POST /api/v1/sign/sign-with-ca
Signs the data with the CA of the policy provided in the parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Data signed |
SignDataResponseDto[SignDataResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
User
editPasswordLoginRoleToUser
POST /api/v1/users/{id}/update-password-login
Set or unset disable_password_login Role to User
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Set disable_password_login role |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
findUserByRaCertificate
POST /api/v1/users/certificates/ra-certificate
Find User by the RA Certificate
Parameters
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User Found |
GetUserDetailsResponseDto[GetUserDetailsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
getUser
GET /api/v1/users/{id}
Find User
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User Found |
GetUserDetailsResponseDto[GetUserDetailsResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
registerUser
POST /api/v1/users/
Register a User
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
User Registered |
GetUserResponseDto[GetUserResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
searchUsers
POST /api/v1/users/search
Search Users
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Users Found |
GetUserResponseDtoPage[GetUserResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
sendUpdatePasswordEmailBatch
POST /api/v1/users/email-update-password-batch
Send Batch update password E-Mails
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Batch update password E-Mails sent |
<<>> |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
setUserCertificateDetails
PUT /api/v1/users/{id}/set-details
Set a user’s Certificate Details
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Id of User whose details will be set |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User's Certificate Details Set |
GetUserResponseDto[GetUserResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
Models
ApiClientSearchRequestDto
It includes filters that will be used to search for the desired resources
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
simpleSearchTerm |
String |
ApiExceptionResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
apiError |
X |
ApiError |
||
errorMessage |
String |
ApproveCertReqResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
certificateId |
UUID |
uuid |
||
certRequestStatus |
CertRequestStatus |
|||
userResponses |
List of UserResponseDto |
|||
metadata |
AuditedAndVersionDtoUUID |
ArchiveAllEntitiesRequestDto
It includes all the desired ids of a specific Type of Entity that will have their archived status updated
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
archiveEntityRequestDtoList |
List of [UUID] |
uuid |
ArchivedDtoUUID
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
archived |
Boolean |
|||
archivedDate |
Date |
date-time |
||
archivedBy |
UUID |
uuid |
||
archivedByType |
SecurityIdentityType |
AuditEventDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
objectId |
UUID |
uuid |
||
eventDescription |
String |
|||
occurredDate |
Date |
date-time |
AuditedAndVersionDtoUUID
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdBy |
UUID |
uuid |
||
createdByType |
SecurityIdentityType |
|||
createdDate |
Date |
date-time |
||
lastModifiedBy |
UUID |
uuid |
||
lastModifiedByType |
SecurityIdentityType |
|||
lastModifiedDate |
Date |
date-time |
||
version |
Integer |
int32 |
AuthenticatedPrincipalResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
authenticatedPrincipalType |
SecurityIdentityType |
BatchCertificateCreationErrorResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
failedUserId |
UUID |
uuid |
||
apiError |
ApiError |
BatchDeleteRolesRequestDto
It includes all the names of the roles to be deleted
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
roleNames |
X |
Set of [string] |
BatchDeleteRolesResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
successful |
Set of [string] |
|||
failed |
Map of ApiError |
CaCertificateDataPemDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
filename |
String |
|||
pemCertificate |
String |
CaSearchRequestDto
It includes filters that will be used to search for the desired resources
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
simpleSearchTerm |
String |
|||
issuerSearch |
Boolean |
|||
caIds |
Set of [UUID] |
uuid |
||
validNotBeforeStart |
Date |
date-time |
||
validNotBeforeEnd |
Date |
date-time |
||
validNotAfterStart |
Date |
date-time |
||
validNotAfterEnd |
Date |
date-time |
||
archived |
Boolean |
CaraTemplateSignerDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
String |
|||
caSubjectDn |
String |
CaraTemplateSignerDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
caraTemplateSignerList |
List of CaraTemplateSignerDto |
CertReqSearchByPkcs10
It includes the PKCS10, which is needed to find the desired Certificate Request
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
pkcs10ReqBase64 |
X |
String |
CertReqSearchRequestDto
It includes all the properties that can be used for the search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
X |
UUID |
uuid |
|
simpleSearchTerm |
String |
|||
policyId |
UUID |
uuid |
||
certRequestIds |
Set of [UUID] |
uuid |
||
archived |
Boolean |
CertificateDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
endEntityId |
UUID |
uuid |
||
policyId |
UUID |
uuid |
||
serialNumber |
String |
|||
subjectDn |
String |
|||
subjectCommonName |
String |
|||
issuerDn |
String |
|||
issuerCommonName |
String |
|||
validNotBefore |
String |
|||
validNotAfter |
String |
|||
certStatus |
CertStatus |
|||
certPublicKeyAlgorithm |
CryptoAlgorithm |
|||
fingerprint |
String |
|||
certRequestId |
UUID |
uuid |
||
metadata |
AuditedAndVersionDtoUUID |
CertificatePemDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
fileName |
String |
|||
pemCertificate |
String |
CertificatePrivateKeyPemDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
fileName |
String |
|||
pemPrivateKey |
String |
CertificateProviderDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
X |
String |
||
certificateProviderType |
X |
CertificateProviderType |
CertificateProviderSearchRequestDto
It includes filters that will be used to search for the desired resources
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateProviderIds |
Set of [UUID] |
uuid |
||
archived |
Boolean |
|||
certificateProviderType |
CertificateProviderType |
CertificateSearchRequestDto
It includes filters that will be used to search for the desired resources
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
UUID |
uuid |
||
simpleSearchTerm |
String |
|||
certificateIds |
Set of [UUID] |
uuid |
||
endEntityIds |
Set of [UUID] |
uuid |
||
policyIds |
Set of [UUID] |
uuid |
||
certStatuses |
Set of CertStatus |
|||
certPublicKeyAlgorithms |
Set of CryptoAlgorithm |
|||
serialNumber |
String |
|||
issuerDn |
String |
|||
subjectDn |
String |
|||
issuerDnBin |
String |
|||
subjectDnBin |
String |
|||
validNotBeforeStart |
Date |
date-time |
||
validNotBeforeEnd |
Date |
date-time |
||
validNotAfterStart |
Date |
date-time |
||
validNotAfterEnd |
Date |
date-time |
||
selfSigned |
Boolean |
|||
imported |
Boolean |
|||
archived |
Boolean |
CertificateValidationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
result |
Boolean |
|||
errorDescription |
String |
|||
certificateChain |
String |
CheckEndEntityRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commonName |
X |
String |
||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
String |
||||
domains |
List of [string] |
|||
ips |
List of [string] |
|||
genericDtoList |
List of GenericDto |
CheckEndEntityResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityPropertyApiErrorMap |
Map of ApiError |
CmpCalculateMacRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
byte[] |
byte |
||
encodedPBMParameter |
byte[] |
byte |
||
policyId |
X |
UUID |
uuid |
|
endEntityId |
X |
UUID |
uuid |
CmpConfigurationDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateProviderDto |
X |
CertificateProviderDto |
||
signerConfigurationDto |
X |
SignerConfigurationDto |
CmpConfigurationRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateProviderId |
X |
UUID |
uuid |
|
signerConfigurationDto |
X |
SignerConfigurationDto |
CmpConfigurationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
policyId |
X |
UUID |
uuid |
|
cmpConfigurationDto |
CmpConfigurationDto |
CmpVerifyMacEndEntityCommonNameRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
macValue |
byte[] |
byte |
||
data |
byte[] |
byte |
||
encodedPBMParameter |
byte[] |
byte |
||
policyId |
X |
UUID |
uuid |
|
endEntityCommonName |
X |
String |
CmpVerifyMacEndEntityIdRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
macValue |
byte[] |
byte |
||
data |
byte[] |
byte |
||
encodedPBMParameter |
byte[] |
byte |
||
policyId |
X |
UUID |
uuid |
|
endEntityId |
X |
UUID |
uuid |
CmpVerifyMacResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cmpMacVerificationResult |
X |
CmpMacVerificationResult |
||
endEntityId |
UUID |
uuid |
CreateCertReqRequestDto
It includes all the properties needed for the creation of a Certificate Request
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
policyId |
X |
UUID |
uuid |
|
endEntityId |
X |
UUID |
uuid |
|
validFor |
ValidFor |
|||
keyPairMode |
X |
KeyPairMode |
||
keyGenParamsDto |
KeyGenParamsDto |
|||
pkcs10ReqBase64 |
String |
|||
publicKeyBase64 |
String |
|||
isSelfSigned |
Boolean |
CreateCertReqResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certRequestId |
UUID |
uuid |
||
certRequestStatus |
CertRequestStatus |
|||
metadata |
AuditedAndVersionDtoUUID |
CreateCertificateProviderRequestDto
It includes all the necessary values to create a new Certificate Provider
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
certificateProviderType |
X |
CertificateProviderType |
||
configuration |
X |
Object |
CreateCertificateProviderResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
X |
String |
||
certificateProviderType |
X |
CertificateProviderType |
||
configuration |
X |
Object |
||
metadata |
AuditedAndVersionDtoUUID |
|||
archival |
ArchivedDtoUUID |
CreateCertificateResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificate |
CertificateDto |
|||
base64EncodedPkcs12 |
String |
|||
base64EncodedJceKs |
String |
|||
fileName |
String |
|||
filePassword |
String |
|||
version |
Integer |
int32 |
||
accessiblePrivateKey |
Boolean |
|||
errorOccurred |
Boolean |
|||
commonName |
String |
|||
certificateId |
String |
CreateConfigurationRequestDto
It includes all the necessary values to create a new Configuration
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
setting |
X |
SettingsKey |
||
configurationValue |
String |
CreateConfigurationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
configurationValue |
String |
|||
setting |
SettingsKey |
|||
version |
Integer |
int32 |
||
settingName |
String |
CreateCryptoModuleRequestDto
It includes all the necessary values to create a new Crypto Module
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cryptoModuleType |
X |
CryptoModuleType |
||
name |
String |
|||
configuration |
X |
Object |
CreateCryptoModuleResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
X |
String |
||
cryptoModuleType |
X |
CryptoModuleType |
||
configuration |
X |
Object |
||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
CreateEndEntityPasswordRequestDto
It includes all the properties needed for the creation of a Password for and End Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityIds |
List of [UUID] |
uuid |
||
policyId |
X |
UUID |
uuid |
CreateEndEntityPasswordResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityIds |
List of [UUID] |
uuid |
||
policyId |
UUID |
uuid |
||
password |
String |
|||
metadata |
AuditedAndVersionDtoUUID |
CreateEndEntityRequestDto
It includes all the necessary values to create a new End Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
X |
UUID |
uuid |
|
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
externalId |
String |
|||
String |
||||
domains |
List of [string] |
|||
ips |
List of [string] |
|||
genericDtoList |
List of GenericDto |
CreateEndEntityResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
externalId |
String |
|||
String |
||||
domains |
List of [string] |
|||
ips |
List of [string] |
|||
genericDtoList |
List of GenericDto |
|||
metadata |
AuditedAndVersionDtoUUID |
CreateMultipleCertReqRequestDto
It includes all the properties needed for the creation of a Certificate Request for multiple End Entities
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
policyId |
X |
UUID |
uuid |
|
endEntitiesIds |
X |
List of [UUID] |
uuid |
|
validFor |
ValidFor |
|||
keyPairMode |
X |
KeyPairMode |
||
keyGenParamsDto |
KeyGenParamsDto |
|||
pkcs10ReqBase64 |
String |
|||
publicKeyBase64 |
String |
|||
isSelfSigned |
Boolean |
CreateMultipleCertReqResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certRequestsCreated |
Map of CreateCertReqResponseDto |
|||
certRequestsFailed |
Map of ApiError |
|||
certificateRequests |
List of [UUID] |
uuid |
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 |
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 |
CreateNewApiClientResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
secret |
String |
|||
clientId |
String |
|||
name |
String |
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 |
CreateNewMailingListResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
|||
emails |
List of MailingListToEmailDto |
|||
archived |
Boolean |
|||
metadata |
AuditedAndVersionDtoUUID |
CreateNewUserDetailsDto
It includes the basic properties needed for the creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
firstName |
X |
String |
||
lastName |
X |
String |
||
String |
||||
passwordLoginEnabled |
Boolean |
CreatePkcs10RequestDto
It includes all the properties necessary for the creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
keyGenParamsDto |
KeyGenParamsDto |
|||
endEntityInfoDto |
EndEntityInfoDto |
CreatePkcs10ResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
pkcs10RequestPemEncoded |
String |
|||
pkcs10RequestFileName |
String |
|||
encryptedPrivateKeyInPemFormat |
String |
|||
privateKeyName |
String |
|||
privateKeyPassword |
String |
CreatePolicyRequestDto
It includes all the properties needed for the creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
X |
UUID |
uuid |
|
name |
String |
|||
certificateProviderId |
X |
UUID |
uuid |
|
certificateProviderConfiguration |
X |
String |
||
requiresManualApproval |
Boolean |
|||
allowedKeyPairModes |
Set of KeyPairMode |
|||
allowedValidForValues |
Set of ValidFor |
|||
cryptoRestrictions |
X |
CryptoRestrictionsDto |
||
endEntityRules |
Set of EndEntityRule |
|||
dualControl |
Boolean |
|||
requiresEmailVerification |
Boolean |
|||
endEntityStrategy |
X |
EndEntityStrategy |
||
enforceActiveCertUniqueness |
Boolean |
|||
enforceActiveCertUniquenessExpirationToleranceInDays |
Integer |
int32 |
||
cmpEnabled |
Boolean |
|||
cmpConfigurationRequestDto |
CmpConfigurationRequestDto |
|||
certificateImportAllowed |
Boolean |
|||
selfSignedAllowed |
Boolean |
|||
wildcardAllowed |
Boolean |
CreatePolicyResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
|||
certificateProviderDto |
CertificateProviderDto |
|||
certificateProviderConfiguration |
String |
|||
requiresManualApproval |
Boolean |
|||
allowedKeyPairModes |
Set of KeyPairMode |
|||
allowedValidForValues |
Set of ValidFor |
|||
cryptoRestrictions |
CryptoRestrictionsDto |
|||
endEntityRules |
Set of EndEntityRule |
|||
dualControl |
Boolean |
|||
requiresEmailVerification |
Boolean |
|||
metadata |
AuditedAndVersionDtoUUID |
|||
enforceActiveCertUniqueness |
Boolean |
|||
enforceActiveCertUniquenessExpirationToleranceInDays |
Integer |
int32 |
||
cmpEnabled |
Boolean |
|||
cmpConfigurationResponseDto |
CmpConfigurationResponseDto |
|||
certificateImportAllowed |
Boolean |
|||
selfSignedAllowed |
Boolean |
|||
wildcardAllowed |
Boolean |
CreateRaCertBatchRequestDto
It includes all the properties needed for the batch creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
validFor |
ValidFor |
|||
keyGenParamsDto |
KeyGenParamsDto |
|||
userIds |
List of [UUID] |
uuid |
CreateRealmRequestDto
It includes all the properties needed for the creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
String |
||
mailingListId |
UUID |
uuid |
CreateRealmResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
|||
mailingListId |
UUID |
uuid |
||
archived |
Boolean |
|||
metadata |
AuditedAndVersionDtoUUID |
CreateRoleRequestDto
It includes all the properties needed for the creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
globalPermissions |
Set of GlobalPermission |
|||
realmPermissions |
X |
|||
policyPermissions |
X |
|||
endEntityPermissions |
X |
|||
certRequestPermissions |
X |
|||
certificatePermissions |
X |
CreateRoleResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
globalPermissions |
Set of GlobalPermission |
|||
realmPermissions |
||||
policyPermissions |
||||
endEntityPermissions |
||||
certRequestPermissions |
||||
certificatePermissions |
CreateSingleRaCertRequestDto
It includes all the properties needed for the creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
validFor |
ValidFor |
|||
keyPairMode |
X |
KeyPairMode |
||
keyGenParamsDto |
KeyGenParamsDto |
|||
pkcs10ReqBase64 |
String |
|||
publicKeyBase64 |
String |
CryptoModuleSearchRequestDto
It includes filters that will be used to search for the desired resources
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
simpleSearchTerm |
String |
|||
archived |
Boolean |
CryptoParametersDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
keyPairModes |
Set of KeyPairMode |
|||
cryptoRestrictions |
CryptoRestrictionsDto |
CryptoRestrictionsDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowedCryptoAlgorithms |
List of CryptoAlgorithm |
|||
rsaKeyGenParams |
X |
List of RsaKeyGenParams |
||
ecKeyGenParams |
X |
List of EcKeyGenParams |
||
edDsaKeyGenParams |
X |
List of EdDsaKeyGenParams |
DeclineCertReqResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
certRequestStatus |
CertRequestStatus |
|||
userResponses |
List of UserResponseDto |
|||
metadata |
AuditedAndVersionDtoUUID |
DeleteArchivedEntitiesRequestDto
It includes all the desired ids of a specific Type of Entity that will be deleted
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entitiesId |
X |
List of [UUID] |
The list of Entity Ids that will be parsed to Delete them. These Entities must be archived and the Ids must be of Type UUID |
uuid |
EcKeyGenParams
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
namedCurve |
String |
|||
cryptoAlgorithm |
X |
CryptoAlgorithm |
EdDsaKeyGenParams
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
edDsaCurve |
X |
EdDsaCurve |
||
cryptoAlgorithm |
X |
CryptoAlgorithm |
EmailDto
It includes the E-Mail address that the E-Mail will be sent to
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
X |
String |
EmailVerifiedCertReqResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
certRequestStatus |
CertRequestStatus |
|||
metadata |
AuditedAndVersionDtoUUID |
EndEntitiesCsvDto
It includes the multipart file in Base64 format and the realm's id
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
X |
UUID |
uuid |
|
csvFile |
X |
String |
EndEntityAuthenticationRequestDto
It includes all the properties needed to authenticate with an End Entity and it's set Password
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityId |
X |
UUID |
uuid |
|
password |
X |
String |
EndEntityAuthenticationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntity |
X |
GetEndEntityResponseDto |
||
policy |
X |
GetPolicyResponseDto |
||
endEntityId |
UUID |
uuid |
||
policyId |
UUID |
uuid |
EndEntityDatasetRequestDto
It includes the End-Entity details required to identify the End-Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
String |
||||
domains |
List of [string] |
|||
ips |
List of [string] |
|||
genericDtoList |
List of GenericDto |
EndEntityFilterDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
String |
||||
externalId |
String |
|||
domains |
List of [string] |
|||
ips |
List of [string] |
|||
genericDtoList |
List of GenericDto |
EndEntityInfoDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
String |
||||
domains |
List of [string] |
|||
ips |
List of [string] |
EndEntityMassImportResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityIds |
List of [UUID] |
uuid |
EndEntityPasswordRequestDto
It includes all the properties needed for the deletion of an End Entity's Password
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityId |
X |
UUID |
uuid |
|
policyId |
X |
UUID |
uuid |
|
version |
Integer |
int32 |
EndEntityRule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
required |
Boolean |
|||
endEntityProperty |
X |
EndEntityProperty |
||
allowedValues |
X |
Set of [string] |
EndEntitySearchRequestDto
It includes all the properties that can be searched with
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
X |
UUID |
uuid |
|
simpleSearchTerm |
String |
|||
policyId |
UUID |
uuid |
||
endEntityIds |
Set of [UUID] |
uuid |
||
endEntityFilterDto |
EndEntityFilterDto |
|||
archived |
Boolean |
ExaminePkcs10RequestRequestDto
It includes all the necessary properties to examine the PKCS10 request
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
policyId |
X |
UUID |
uuid |
|
endEntityId |
X |
UUID |
uuid |
|
pkcs10ReqBase64 |
X |
String |
ExtractEndEntityInfoFromPkcs10RequestDto
It contains the PEM encoded PKCS10 Request
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
pemEncodedPkcs10 |
String |
ExtractEndEntityInfoFromPkcs10ResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
String |
||||
domains |
List of [string] |
|||
ips |
List of [string] |
FailedCertificateOrderResultDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certRequestId |
UUID |
uuid |
||
apiError |
ApiError |
FailedImportCertRequestResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateFingerprint |
String |
|||
apiError |
ApiError |
FindEeByCertBytesRequestDto
It includes the properties needed to find the End Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
X |
UUID |
uuid |
|
base64EncodedBytes |
String |
FindUserByRaCertificateRequestDto
It includes the Base64 version of the User's RA Certificate that we are searching for
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
base64EncodedBytes |
String |
GetAllowedCryptoParametersRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateProviderId |
X |
UUID |
uuid |
|
certificateProviderConfiguration |
String |
GetApiClientDetailsResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
realmIds |
X |
List of [UUID] |
uuid |
|
name |
String |
|||
clientId |
String |
|||
defaultPolicyId |
UUID |
uuid |
GetApiClientResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
String |
|||
clientId |
String |
GetApiClientResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetApiClientResponse |
|||
pageDetails |
PageDetailsDto |
GetApiErrorValuesResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
apiErrorList |
List of ApiError |
GetAuditEventResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
auditEventDtoList |
List of AuditEventDto |
GetAuthenticatedPrincipalPermissionsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
globalPermissions |
Set of GlobalPermission |
|||
realmPermissions |
Map of [set] |
|||
policyPermissions |
Map of [set] |
|||
endEntityPermissions |
Map of [set] |
|||
certRequestPermissions |
Map of [set] |
|||
certificatePermissions |
Map of [set] |
GetCaResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
validNotBefore |
Date |
date-time |
||
validNotAfter |
Date |
date-time |
||
fingerprint |
String |
|||
issuerCaId |
UUID |
uuid |
||
rootCa |
Boolean |
|||
issuerDn |
String |
|||
subjectDn |
String |
|||
verifyServers |
Boolean |
|||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
GetCertByIssuerDnBinAndSnDto
It includes all the needed properties to get the desired Certificate
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
issuerDnBin |
String |
|||
serialNumber |
String |
GetCertReqResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
policyId |
UUID |
uuid |
||
policyName |
String |
|||
endEntityId |
UUID |
uuid |
||
endEntityCommonName |
String |
|||
endEntityEmailAddress |
String |
|||
keyPairMode |
KeyPairMode |
|||
validFor |
ValidFor |
|||
certRequestStatus |
CertRequestStatus |
|||
keyGenParamsDto |
KeyGenParamsDto |
|||
certificateId |
UUID |
uuid |
||
isImported |
X |
Boolean |
||
isSelfSigned |
X |
Boolean |
||
userResponses |
List of UserResponseDto |
|||
metadata |
AuditedAndVersionDtoUUID |
|||
archival |
ArchivedDtoUUID |
GetCertReqResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetCertReqResponseDto |
|||
pageDetails |
PageDetailsDto |
GetCertRequestAdditionalDataResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalData |
Object |
|||
isCertRequestUpdated |
Boolean |
GetCertRequestPermissionResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certRequestPermissionList |
List of CertRequestPermission |
GetCertRequestStatusStatisticsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
requiresEmailVerification |
Long |
int64 |
||
pendingApproval |
Long |
int64 |
||
approved |
Long |
int64 |
||
declined |
Long |
int64 |
||
pendingIssuance |
Long |
int64 |
||
issued |
Long |
int64 |
||
issuanceFailed |
Long |
int64 |
GetCertStatusResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certStatusList |
List of CertStatus |
GetCertificatePermissionResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificatePermissionList |
List of CertificatePermission |
GetCertificateProviderMinimalResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
X |
String |
||
certificateProviderType |
X |
CertificateProviderType |
GetCertificateProviderMinimalResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
||||
pageDetails |
PageDetailsDto |
GetCertificateProviderResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
X |
String |
||
certificateProviderType |
X |
CertificateProviderType |
||
configuration |
X |
Object |
||
metadata |
AuditedAndVersionDtoUUID |
|||
archival |
ArchivedDtoUUID |
GetCertificateProviderResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
||||
pageDetails |
PageDetailsDto |
GetCertificateProviderTypeResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateProviderTypeList |
List of CertificateProviderType |
GetCertificateProviderTypeStatisticsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
mtgCara |
Long |
int64 |
||
msNdes |
Long |
int64 |
||
msca |
Long |
int64 |
||
globalSign |
Long |
int64 |
||
pswPublicCas |
Long |
int64 |
GetCertificatePublicKeyAlgorithmStatisticsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
rsa |
Long |
int64 |
||
ec |
Long |
int64 |
||
edDsa |
Long |
int64 |
GetCertificateResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
endEntityId |
UUID |
uuid |
||
endEntityCommonName |
String |
|||
policyId |
UUID |
uuid |
||
policyName |
String |
|||
serialNumber |
String |
|||
subjectDn |
String |
|||
subjectCommonName |
String |
|||
issuerDn |
String |
|||
issuerCommonName |
String |
|||
validNotBefore |
String |
|||
validNotAfter |
String |
|||
certStatus |
CertStatus |
|||
certRevocationReason |
RevocationReason |
|||
certPublicKeyAlgorithm |
CryptoAlgorithm |
|||
fingerprint |
String |
|||
certRequestId |
UUID |
uuid |
||
isImported |
X |
Boolean |
||
isSelfSigned |
X |
Boolean |
||
accessiblePrivateKey |
X |
Boolean |
||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
GetCertificateResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetCertificateResponseDto |
|||
pageDetails |
PageDetailsDto |
GetCertificateSearchKeyResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateSearchKeyList |
List of CertificateSearchKey |
GetCertificateStatusStatisticsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
active |
Long |
int64 |
||
expired |
Long |
int64 |
||
revoked |
Long |
int64 |
GetCmpConfigurationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
cmpConfigurationDto |
CmpConfigurationDto |
|||
policyId |
UUID |
uuid |
||
signerCertChain |
String |
|||
signerCertificateId |
UUID |
uuid |
GetCmpSignatureAlgorithmResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cmpSignatureAlgorithmList |
List of CmpSignatureAlgorithm |
GetConfigurationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
configurationValue |
String |
|||
setting |
SettingsKey |
|||
version |
Integer |
int32 |
GetConfigurationResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetConfigurationResponseDto |
|||
pageDetails |
PageDetailsDto |
GetCryptoAlgorithmResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cryptoAlgorithmList |
List of CryptoAlgorithm |
GetCryptoModuleResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
X |
String |
||
cryptoModuleType |
X |
CryptoModuleType |
||
configuration |
X |
Object |
||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
GetCryptoModuleResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetCryptoModuleResponseDto |
|||
pageDetails |
PageDetailsDto |
GetCryptoModuleTypeListResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cryptoModuleTypes |
List of CryptoModuleType |
GetECNamedCurveResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ecNamedCurveList |
List of EcNamedCurve |
GetEdDSANamedCurveResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
edDsaCurveList |
List of EdDsaCurve |
GetEndEntityPasswordResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityId |
UUID |
uuid |
||
endEntityName |
String |
|||
policyId |
UUID |
uuid |
||
policyName |
String |
|||
metadata |
AuditedAndVersionDtoUUID |
GetEndEntityPasswordResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetEndEntityPasswordResponseDto |
|||
pageDetails |
PageDetailsDto |
GetEndEntityPermissionResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityPermissionList |
List of EndEntityPermission |
GetEndEntityPropertyResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityPropertyList |
List of EndEntityProperty |
GetEndEntityResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
realmId |
X |
UUID |
uuid |
|
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
externalId |
String |
|||
String |
||||
domains |
List of [string] |
|||
ips |
List of [string] |
|||
genericDtoList |
List of GenericDto |
|||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
|||
endEntityStrategy |
EndEntityStrategy |
|||
alias |
String |
|||
matchesPolicyEndEntityRules |
Boolean |
GetEndEntityResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetEndEntityResponseDto |
|||
pageDetails |
PageDetailsDto |
GetEndEntityStrategyResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endEntityStrategyList |
List of EndEntityStrategy |
GetEntitiesEnumResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entitiesEnumList |
List of EntitiesEnum |
GetEntityRoleNamesResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entityId |
UUID |
uuid |
||
entityRoleNames |
Set of [string] |
GetGlobalPermissionResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
globalPermissionList |
List of GlobalPermission |
GetImportedCertificatesStatisticsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
imported |
Long |
int64 |
||
issued |
Long |
int64 |
GetKeyPairModeResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
keyPairModeList |
List of KeyPairMode |
GetMailingListResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
metadata |
AuditedAndVersionDtoUUID |
|||
archival |
ArchivedDtoUUID |
|||
id |
UUID |
uuid |
||
name |
String |
|||
emails |
List of MailingListToEmailDto |
GetMailingListResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetMailingListResponseDto |
|||
pageDetails |
PageDetailsDto |
GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
users |
||||
apiClients |
GetPendingCertReqResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
policyId |
UUID |
uuid |
||
endEntityId |
UUID |
uuid |
||
keyPairMode |
KeyPairMode |
|||
validFor |
ValidFor |
|||
certRequestStatus |
CertRequestStatus |
|||
keyGenParamsDto |
KeyGenParamsDto |
|||
metadata |
AuditedAndVersionDtoUUID |
GetPendingCertReqResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetPendingCertReqResponseDto |
|||
pageDetails |
PageDetailsDto |
GetPoliciesInRealmsDto
It includes the Realm Ids, needed for the search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmIds |
List of [UUID] |
uuid |
GetPolicyPermissionResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
policyPermissionList |
List of PolicyPermission |
GetPolicyResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
String |
|||
certificateProviderDto |
X |
CertificateProviderDto |
||
certificateProviderConfiguration |
X |
String |
||
realmId |
X |
UUID |
uuid |
|
requiresManualApproval |
Boolean |
|||
allowedKeyPairModes |
Set of KeyPairMode |
|||
allowedValidForValues |
Set of ValidFor |
|||
cryptoRestrictions |
X |
CryptoRestrictionsDto |
||
endEntityRules |
Set of EndEntityRule |
|||
dualControl |
Boolean |
|||
requiresEmailVerification |
Boolean |
|||
metadata |
AuditedAndVersionDtoUUID |
|||
endEntityStrategy |
X |
EndEntityStrategy |
||
archival |
ArchivedDtoUUID |
|||
enforceActiveCertUniqueness |
Boolean |
|||
enforceActiveCertUniquenessExpirationToleranceInDays |
Integer |
int32 |
||
cmpEnabled |
Boolean |
|||
cmpConfigurationResponseDto |
CmpConfigurationResponseDto |
|||
certificateImportAllowed |
Boolean |
|||
selfSignedAllowed |
Boolean |
|||
wildcardAllowed |
Boolean |
GetPolicyResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetPolicyResponseDto |
|||
pageDetails |
PageDetailsDto |
GetRSAKeySizeResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
rsaKeySizeList |
List of RsaKeySize |
GetRaCertificateResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
serialNumber |
String |
|||
subjectDn |
String |
|||
subjectCommonName |
String |
|||
issuerDn |
String |
|||
issuerCommonName |
String |
|||
validNotBefore |
Date |
date-time |
||
validNotAfter |
Date |
date-time |
||
certStatus |
CertStatus |
|||
certPublicKeyAlgorithm |
CryptoAlgorithm |
|||
fingerprint |
String |
|||
accessiblePrivateKey |
Boolean |
GetRealmPermissionResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmPermissionList |
List of RealmPermission |
GetRealmResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
|||
mailingListDto |
MailingListDto |
|||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
GetRealmResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetRealmResponseDto |
|||
pageDetails |
PageDetailsDto |
GetRevocationReasonResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
revocationReasonList |
List of [string] |
GetRoleDetailsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
providerId |
UUID |
uuid |
||
globalPermissions |
Set of GlobalPermission |
|||
realmPermissions |
||||
policyPermissions |
||||
endEntityPermissions |
||||
certRequestPermissions |
||||
certificatePermissions |
GetRoleResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
globalPermissions |
Set of GlobalPermission |
|||
realmPermissions |
||||
policyPermissions |
||||
endEntityPermissions |
||||
certRequestPermissions |
||||
certificatePermissions |
GetRoleResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetRoleResponseDto |
|||
pageDetails |
PageDetailsDto |
GetSecurityIdentityRolesResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
roles |
X |
Set of GetRoleResponseDto |
GetSelfSignedCertificatesStatisticsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
selfSigned |
Long |
int64 |
||
nonSelfSigned |
Long |
int64 |
GetTrustedCasRequestDto
The options regarding which CAs will be returned
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeRootOnly |
Boolean |
|||
includeVerifyServersOnly |
Boolean |
GetTrustedCasResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
trustedCas |
List of [string] |
GetUserDetailsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
username |
String |
|||
firstName |
String |
|||
lastName |
String |
|||
String |
||||
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
enabled |
Boolean |
|||
passwordLoginEnabled |
Boolean |
GetUserResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
username |
String |
|||
firstName |
String |
|||
lastName |
String |
|||
String |
||||
commonName |
String |
|||
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
enabled |
Boolean |
GetUserResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of GetUserResponseDto |
|||
pageDetails |
PageDetailsDto |
GetValidForResponseDtoList
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
validForList |
List of ValidFor |
ImportCaDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
fingerprint |
String |
|||
isRootCa |
Boolean |
ImportCaRequestDto
The content of the PEM file containing the CAs to be verified
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
pemFileContents |
String |
ImportCaResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
importedCaDtoList |
List of ImportCaDto |
|||
cas |
List of [UUID] |
uuid |
ImportCertificatesRequestDto
It includes encoded certificates and the necessary metadata for it
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
policyId |
X |
UUID |
uuid |
|
discoveredCertsInPem |
List of ImportPemCertificatesDto |
ImportCertificatesResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
hashAlgorithmId |
String |
|||
successful |
||||
failed |
||||
certificates |
List of [UUID] |
uuid |
ImportPemCertificatesDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
server |
String |
|||
port |
Integer |
int32 |
||
pemCertificates |
String |
KeyGenParamsDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cryptoAlgorithm |
X |
CryptoAlgorithm |
||
keySize |
RsaKeySize |
|||
exponent |
Integer |
|||
namedCurve |
String |
|||
edDsaCurve |
EdDsaCurve |
KeystoreFileDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
base64EncodedPkcs12 |
String |
|||
base64EncodedJceKs |
String |
|||
fileName |
String |
|||
filePassword |
String |
MailingListDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
|||
archived |
Boolean |
|||
version |
Integer |
int32 |
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 |
MailingListToEmailDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
emailId |
UUID |
uuid |
||
mailingListId |
UUID |
uuid |
||
emailName |
String |
|||
optOut |
Boolean |
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 |
MinimalSecurityIdentityRepresentationDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
MscaTemplatesResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
templateNames |
List of [string] |
OrderCertificateResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certRequestId |
UUID |
uuid |
||
certRequestStatus |
CertRequestStatus |
|||
certificateId |
UUID |
uuid |
||
errorOccurred |
Boolean |
OrderMultipleCertificatesResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
base64EncodedZippedArtifacts |
String |
|||
artifactsPassword |
String |
|||
successfulCertificateOrders |
||||
failedCertificateOrders |
List of FailedCertificateOrderResultDto |
|||
issuedCertificateIds |
List of [UUID] |
uuid |
||
successfulCertificateRequests |
List of [UUID] |
uuid |
PageDetailsDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
totalElements |
X |
Long |
int64 |
|
pageNumber |
X |
Integer |
int32 |
|
pageSize |
X |
Integer |
int32 |
|
numberOfElementsInPage |
X |
Integer |
int32 |
ParsePkcs10ResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
keyPairMode |
X |
KeyPairMode |
||
keyGenParamsDto |
X |
KeyGenParamsDto |
||
pkcs10ReqBase64 |
String |
Pkcs10Dto
It includes all the properties necessary for parsing
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
base64EncodedPkcs10 |
X |
String |
PolicySearchRequestDto
It includes all the properties that can be used for the search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
realmId |
X |
UUID |
uuid |
|
simpleSearchTerm |
String |
|||
policyIds |
Set of [UUID] |
uuid |
||
archived |
Boolean |
PublicCAsProductsResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
products |
List of PublicCasProductResponseDto |
PublicCasProductResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
number |
String |
|||
monthValidity |
Integer |
int32 |
||
name |
String |
|||
type |
PublicCAsProductType |
|||
validationType |
PublicCAsProductValidationType |
|||
signatureAlgorithms |
List of [string] |
RaCertificatePemDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
fileName |
String |
|||
pemCertificate |
String |
RawPemCertificateDto
PEM Encoded Certificate
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
pemCertificate |
String |
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 |
ResetEndEntityPasswordResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
password |
String |
|||
metadata |
AuditedAndVersionDtoUUID |
RevokeCertificateDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
revocationReason |
RevocationReason |
RevokeCertificateRequestDto
It includes all the properties needed to revoke the desired Certificates
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
revokeCertificateDtos |
List of RevokeCertificateDto |
RevokeCertificateResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateRevocationResult |
X |
CertificateRevocationResult |
||
certificateRevocationReason |
RevocationReason |
|||
revocationResult |
String |
RevokeMultipleCertificateResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
successfulRevocation |
Boolean |
RevokeRaCertificateResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateRevocationResult |
X |
CertificateRevocationResult |
||
revocationResult |
String |
RoleEntityPermissionsDtoCertRequestPermission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entityId |
X |
UUID |
uuid |
|
permissions |
X |
Set of CertRequestPermission |
RoleEntityPermissionsDtoCertificatePermission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entityId |
X |
UUID |
uuid |
|
permissions |
X |
Set of CertificatePermission |
RoleEntityPermissionsDtoEndEntityPermission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entityId |
X |
UUID |
uuid |
|
permissions |
X |
Set of EndEntityPermission |
RoleEntityPermissionsDtoPolicyPermission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entityId |
X |
UUID |
uuid |
|
permissions |
X |
Set of PolicyPermission |
RoleEntityPermissionsDtoRealmPermission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
entityId |
X |
UUID |
uuid |
|
permissions |
X |
Set of RealmPermission |
RsaKeyGenParams
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
keySize |
X |
RsaKeySize |
||
exponent |
Integer |
|||
cryptoAlgorithm |
X |
CryptoAlgorithm |
ScepDecryptDataRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
byte[] |
byte |
||
policyId |
X |
UUID |
uuid |
ScepSignRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
byte[] |
byte |
||
policyId |
X |
UUID |
uuid |
|
encodedIssuer |
byte[] |
byte |
||
algorithmID |
byte[] |
byte |
SearchAllRequestDto
It includes all the properties that can be used for the search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
simpleSearchTerm |
String |
|||
archived |
Boolean |
SearchCaResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
validNotBefore |
Date |
date-time |
||
validNotAfter |
Date |
date-time |
||
fingerprint |
String |
|||
issuerCaId |
UUID |
uuid |
||
rootCa |
Boolean |
|||
issuerDn |
String |
|||
subjectDn |
String |
|||
verifyServers |
Boolean |
|||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
SearchCaResponseDtoPage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
List of SearchCaResponseDto |
|||
pageDetails |
PageDetailsDto |
SearchConfigurationRequestDto
It includes filters that will be used to search for the desired resources
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
keys |
List of SettingsKey |
SearchRoleRequestDto
It includes filters that will be used to search for the desired resources
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
simpleSearchTerm |
String |
SignDataRequestDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
byte[] |
byte |
||
algorithmAID |
byte[] |
byte |
||
policyId |
X |
UUID |
uuid |
|
encodedIssuer |
byte[] |
byte |
SignerConfigurationDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
signerConfiguration |
X |
String |
||
cmpSignatureAlgorithm |
X |
CmpSignatureAlgorithm |
SuccessfulCertificateOrderResultDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certRequestId |
UUID |
uuid |
||
certificateId |
UUID |
uuid |
SuccessfulImportCertRequestResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
certificateFingerprint |
String |
|||
certRequestId |
UUID |
uuid |
||
certRequestStatus |
CertRequestStatus |
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 |
UpdateCaRequestDto
It includes all the properties needed for the update
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
verifyServers |
Boolean |
|||
version |
Integer |
int32 |
UpdateCaResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
validNotBefore |
Date |
date-time |
||
validNotAfter |
Date |
date-time |
||
fingerprint |
String |
|||
issuerCaId |
UUID |
uuid |
||
rootCa |
Boolean |
|||
issuerDn |
String |
|||
subjectDn |
String |
|||
verifyServers |
Boolean |
|||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
UpdateCertificateProviderRequestDto
It includes all the properties needed for the update
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
configuration |
X |
Object |
||
version |
Integer |
int32 |
UpdateCertificateProviderResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
UUID |
uuid |
|
name |
X |
String |
||
certificateProviderType |
X |
CertificateProviderType |
||
configuration |
X |
Object |
||
metadata |
AuditedAndVersionDtoUUID |
|||
archival |
ArchivedDtoUUID |
UpdateConfigurationBatchRequestDto
It includes all the necessary values to update a batch of existing Configurations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
updateConfigurationRequestDtoList |
List of UpdateConfigurationRequestDto |
UpdateConfigurationBatchResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
updateConfigurationResponseDtoList |
List of UpdateConfigurationResponseDto |
|||
configurations |
List of [string] |
UpdateConfigurationRequestDto
It includes all the necessary values to update an existing Configuration
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
settingsKey |
X |
SettingsKey |
||
configuration |
String |
|||
version |
Integer |
int32 |
UpdateConfigurationResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
configurationValue |
String |
|||
setting |
SettingsKey |
|||
version |
Integer |
int32 |
||
configuration |
String |
UpdateMailingListRequestDto
It includes all the properties needed to complete the update
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
emails |
List of CreateNewEmailRequestDto |
|||
version |
X |
Integer |
int32 |
UpdateMailingListResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
metadata |
AuditedAndVersionDtoUUID |
|||
archival |
ArchivedDtoUUID |
|||
id |
UUID |
uuid |
||
name |
String |
|||
emails |
List of MailingListToEmailDto |
UpdatePolicyRequestDto
It includes all the properties needed for the update
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
certificateProviderId |
X |
UUID |
uuid |
|
certificateProviderConfiguration |
X |
String |
||
allowedKeyPairModes |
Set of KeyPairMode |
|||
allowedValidForValues |
Set of ValidFor |
|||
cryptoRestrictions |
X |
CryptoRestrictionsDto |
||
version |
Integer |
int32 |
||
enforceActiveCertUniqueness |
Boolean |
|||
enforceActiveCertUniquenessExpirationToleranceInDays |
Integer |
int32 |
||
endEntityRules |
Set of EndEntityRule |
|||
cmpEnabled |
Boolean |
|||
cmpConfigurationRequestDto |
CmpConfigurationRequestDto |
|||
certificateImportAllowed |
Boolean |
|||
selfSignedAllowed |
Boolean |
|||
wildcardAllowed |
Boolean |
UpdatePolicyResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
|||
certificateProviderDto |
CertificateProviderDto |
|||
certificateProviderConfiguration |
String |
|||
requiresManualApproval |
Boolean |
|||
allowedKeyPairModes |
Set of KeyPairMode |
|||
allowedValidForValues |
Set of ValidFor |
|||
cryptoRestrictions |
CryptoRestrictionsDto |
|||
endEntityRules |
Set of EndEntityRule |
|||
dualControl |
Boolean |
|||
requiresEmailVerification |
Boolean |
|||
endEntityStrategy |
X |
EndEntityStrategy |
||
metadata |
AuditedAndVersionDtoUUID |
|||
archival |
ArchivedDtoUUID |
|||
enforceActiveCertUniqueness |
Boolean |
|||
enforceActiveCertUniquenessExpirationToleranceInDays |
Integer |
int32 |
||
cmpEnabled |
Boolean |
|||
cmpConfigurationResponseDto |
CmpConfigurationResponseDto |
|||
certificateImportAllowed |
Boolean |
|||
selfSignedAllowed |
Boolean |
|||
wildcardAllowed |
Boolean |
UpdateRealmRequestDto
It includes all the properties needed for the update
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
String |
||
mailingListId |
UUID |
uuid |
||
version |
Integer |
int32 |
UpdateRealmResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
name |
String |
|||
mailingListDto |
MailingListDto |
|||
archival |
ArchivedDtoUUID |
|||
metadata |
AuditedAndVersionDtoUUID |
UpdateRoleRequestDto
It includes all the properties needed for the update
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
globalPermissions |
Set of GlobalPermission |
|||
realmPermissions |
X |
|||
policyPermissions |
X |
|||
endEntityPermissions |
X |
|||
certRequestPermissions |
X |
|||
certificatePermissions |
X |
UpdateRoleResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
globalPermissions |
Set of GlobalPermission |
|||
realmPermissions |
||||
policyPermissions |
||||
endEntityPermissions |
||||
certRequestPermissions |
||||
certificatePermissions |
UpdateSecurityIdentityRolesBatchRequestDto
It includes all the roles to be assigned to API clients
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ids |
X |
Set of [UUID] |
uuid |
|
roles |
X |
Set of [string] |
UpdateSecurityIdentityRolesBatchResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
successful |
Set of [UUID] |
uuid |
||
failed |
Map of ApiError |
UpdateSecurityIdentityRolesRequestDto
It includes all the roles to be associated with API client
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
roles |
X |
Set of [string] |
UpdateUserCertificateDetailsRequestDto
It includes the new user details
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
organization |
String |
|||
organizationalUnit |
String |
|||
country |
String |
|||
commonName |
X |
String |
UpdateUserRaCertificateDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
certFromProviderReference |
String |
|||
certificateId |
UUID |
uuid |
||
base64EncodedPkcs12 |
String |
|||
base64EncodedJceKs |
String |
|||
fileName |
String |
|||
filePassword |
String |
|||
accessiblePrivateKey |
Boolean |
UserListDto
It includes the list of provider id's associated with the users that a password update email will be sent.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
userProviderIdList |
List of [UUID] |
uuid |
UserResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
UUID |
uuid |
||
securityIdentityType |
SecurityIdentityType |
|||
certRequestAction |
CertRequestAction |
UserSearchRequestDto
It includes all the properties that can be used for searching
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
simpleSearchTerm |
String |
VerifyImportCaDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
isRootCa |
Boolean |
|||
rootFingerprint |
String |
VerifyImportCaResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
verifiedImportCaDtoList |
List of VerifyImportCaDto |
VerifyImportCertificatesRequestDto
It includes encoded certificates and the necessary metadata for it
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
policyId |
X |
UUID |
uuid |
|
discoveredCertsInPem |
List of ImportPemCertificatesDto |
VerifyImportCertificatesResponseDto
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
totalCertificatesToImport |
Long |
int64 |
VerifyTokenRequestDto
It includes the Token
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
token |
String |