API Documentation
1. Endpoints
1.1. Admin
1.1.1. archiveEntitiesBatch
POST /api/v1/admin/batch-archive
Batch Archive resources from an Entity
1.1.1.1. Parameters
1.1.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Archived the requested resources of an Entity |
<<>> |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.1.2. archiveSingleEntity
PATCH /api/v1/admin/{id}/archive
Archive a resource from an Entity
1.1.2.1. Parameters
1.1.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Archived the requested resource of an Entity |
<<>> |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.1.3. deleteArchived
DELETE /api/v1/admin/archived
Delete archived resources from an Entity
1.1.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Deleted the archived resource of an Entity |
<<>> |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.1.4. deleteArchivedEntities
POST /api/v1/admin/batch-delete
Batch Delete archived resources from an Entity
1.1.4.1. Parameters
1.1.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Deleted the requested resources |
<<>> |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.1.5. synchronizeApiClients
PUT /api/v1/admin/sync-api-clients
Import provider Clients
1.1.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Imported provider Clients |
<<>> |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.1.6. synchronizeUsers
PUT /api/v1/admin/sync-users
Import provider Users
1.1.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Imported provider Users |
<<>> |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.2. ApiClient
1.2.1. createNewApiClient
POST /api/v1/api-clients/
Create an Api Client
1.2.1.1. Parameters
1.2.1.4. Responses
Code | Message | Datatype |
---|---|---|
201 |
Api Client created |
CreateNewApiClientResponse[CreateNewApiClientResponse] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.2.2. deleteApiClient
DELETE /api/v1/api-clients/{id}
Delete Api Client
1.2.2.1. Parameters
1.2.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Api Client Deleted |
<<>> |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.2.3. getApiClientDetails
GET /api/v1/api-clients/{id}
Get Api Client
1.2.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Api Client |
GetApiClientResponse[GetApiClientResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.2.4. resetApiClientSecret
POST /api/v1/api-clients/{id}/reset-secret
Reset Api Client’s secret
1.2.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Api Client's secret was reset |
ResetApiClientSecretResponse[ResetApiClientSecretResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.2.5. searchApiClients
POST /api/v1/api-clients/search
Search Api Clients
1.2.5.1. Parameters
1.2.5.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.2.5.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Found Api Clients |
GetApiClientResponseDtoPage[GetApiClientResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.2.6. updateApiClient
PATCH /api/v1/api-clients/{id}
Update an Api Client
1.2.6.1. Parameters
1.2.6.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id of the desired Api Client |
X |
null |
1.2.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Api Client updated |
UpdateApiClientResponse[UpdateApiClientResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.3. AsyncCertificate
1.3.1. orderCertificate
POST /api/v2/certificates/cert-requests/{id}
Order a Certificate by Certificate Request
1.3.1.4. Responses
Code | Message | Datatype |
---|---|---|
201 |
Certificate Ordered |
OrderCertificateResponseDto[OrderCertificateResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.3.2. orderMultipleCertificates
POST /api/v2/certificates/cert-requests
Order Multiple Certificates by Certificate Requests
1.3.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Certificates ordered |
OrderMultipleCertificatesResponseDto[OrderMultipleCertificatesResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.4. AuthenticatedPrincipal
1.4.1. getAuthenticatedPrincipal
GET /api/v1/authenticated-principal/
Get Authenticated Principal
1.4.1.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Authenticated Principal Found |
AuthenticatedPrincipalResponseDto[AuthenticatedPrincipalResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.4.2. getAuthenticatedPrincipalPermissions
GET /api/v1/authenticated-principal/permissions
Get Authenticated Principal concatenated permissions
1.4.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Authenticated Principal Permissions Found |
GetAuthenticatedPrincipalPermissionsResponseDto[GetAuthenticatedPrincipalPermissionsResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.5. Ca
1.5.1. downloadCaCertificate
GET /api/v1/cas/{id}/download
Download CA Certificate
1.5.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
CA Certificate Downloaded |
CaCertificateDataPemDto[CaCertificateDataPemDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.5.2. getCa
GET /api/v1/cas/{id}
Get CA by Id
1.5.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found CA |
GetCaResponseDto[GetCaResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.5.3. getTrustedCas
POST /api/v1/cas/get-trusted
Get trusted CAs in PEM format according to the search criteria.
1.5.3.1. Parameters
1.5.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Trusted CAs acquired |
GetTrustedCasResponseDto[GetTrustedCasResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.5.4. importCaCertificates
POST /api/v1/cas/import
Import CA Certificate(s) from pem file content
1.5.4.1. Parameters
1.5.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
CA Certificate(s) Imported |
ImportCaResponseDto[ImportCaResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.5.5. searchCas
POST /api/v1/cas/search
Search CA
1.5.5.1. Parameters
1.5.5.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.5.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found CA |
SearchCaResponseDtoPage[SearchCaResponseDtoPage] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.5.6. updateCa
PATCH /api/v1/cas/{id}
Update a CA
1.5.6.1. Parameters
1.5.6.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of the CA that will be updated |
X |
null |
1.5.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
CA Updated |
UpdateCaResponseDto[UpdateCaResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.5.7. verifyCaCertificates
POST /api/v1/cas/import/verify
Verify CA Certificate(s) from PEM file content
1.5.7.1. Parameters
1.5.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
CA Certificate(s) Verified |
VerifyImportCaResponseDto[VerifyImportCaResponseDto] |
1.6. CertRequest
1.6.1. approveCertRequest
PATCH /api/v1/cert-requests/{id}/approve
Approve a Certificate Request
1.6.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Request Approved |
ApproveCertReqResponseDto[ApproveCertReqResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.2. createCertRequest
POST /api/v1/cert-requests/
Create a Certificate Request
1.6.2.1. Parameters
1.6.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Certificate Request Created |
CreateCertReqResponseDto[CreateCertReqResponseDto] |
1.6.3. createMultipleCertRequest
POST /api/v1/cert-requests/multiple
Create a Certificate Request for multiple End Entities
1.6.3.1. Parameters
1.6.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Certificate Request Created |
CreateMultipleCertReqResponseDto[CreateMultipleCertReqResponseDto] |
1.6.4. declineCertRequest
PATCH /api/v1/cert-requests/{id}/decline
Decline a Certificate Request
1.6.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Request Declined |
DeclineCertReqResponseDto[DeclineCertReqResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.5. examinePkcs10Request
PUT /api/v1/cert-requests/examine-pkcs10-request
Examine PKCS10 request against End Entity and Policy
1.6.5.1. Parameters
1.6.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Examination completed |
ExaminePkcs10RequestResponseDto[ExaminePkcs10RequestResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.6. getCertRequest
GET /api/v1/cert-requests/{id}
Get a Certificate Request
1.6.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Request Found |
GetCertReqResponseDto[GetCertReqResponseDto] |
1.6.7. getCertRequestAdditionalData
PATCH /api/v1/cert-requests/{id}/additional-data
Get Certificate Request additional data
1.6.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Request Found |
GetCertRequestAdditionalDataResponseDto[GetCertRequestAdditionalDataResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.8. getCertRequestByPkcs10AndEndEntity
POST /api/v1/cert-requests/end-entities/{id}/by-pkcs10
Get Certificate Request by End Entity and PKCS10
1.6.8.1. Parameters
1.6.8.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id of the End Entity, used to find the desired Certificate Request |
X |
null |
1.6.8.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Request found |
GetCertReqResponseDto[GetCertReqResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.9. getMostRecentPendingCertificates
GET /api/v1/cert-requests/realms/{id}/pending
Get pending Certificate Requests of a specific Realm
1.6.9.1. Parameters
1.6.9.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Pending Certificate Requests of Realm Found |
GetPendingCertReqResponseDtoPage[GetPendingCertReqResponseDtoPage] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.10. getNameOfRolesWithCertRequestAccess
GET /api/v1/cert-requests/{id}/roles
Get role names of respective certificate request
1.6.10.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.11. importCertificates
POST /api/v1/cert-requests/import-certificates
Import certificates
1.6.11.1. Parameters
1.6.11.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Certificates imported |
ImportCertificatesResponseDto[ImportCertificatesResponseDto] |
1.6.12. resendEmailVerificationForCertRequest
POST /api/v1/cert-requests/{id}/resend-verification-email
Resend E-Mail verification for a Certificate Request
1.6.12.1. Parameters
1.6.12.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id of the Certificate Request for which the resend verification E-Mail is requested |
X |
null |
1.6.12.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
E-Mail verification sent |
<<>> |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.13. searchAllCertRequests
POST /api/v1/cert-requests/search-all
Search all Certificate Requests
1.6.13.1. Parameters
1.6.13.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.6.13.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Certificate Requests Found |
GetCertReqResponseDtoPage[GetCertReqResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.14. searchCertRequests
POST /api/v1/cert-requests/search
Search Certificate Requests
1.6.14.1. Parameters
1.6.14.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.6.14.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Certificate Requests Found |
GetCertReqResponseDtoPage[GetCertReqResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.6.15. verifyImportCertificates
POST /api/v1/cert-requests/import-certificates/verify
Verify import certificates request
1.6.15.1. Parameters
1.6.15.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Import certificates request verified |
VerifyImportCertificatesResponseDto[VerifyImportCertificatesResponseDto] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.7. Certificate
1.7.1. createCertificate
POST /api/v1/certificates/cert-requests/{id}
Create Certificate by Certificate Request
1.7.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Certificate Created |
CreateCertificateResponseDto[CreateCertificateResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.2. createMultipleCertificates
POST /api/v1/certificates/cert-requests
Create Multiple Certificates by Certificate Requests
1.7.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Certificates Created |
CreateMultipleCertificateFromCertRequestsResponseDto[CreateMultipleCertificateFromCertRequestsResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.3. downloadCaChainForPolicy
GET /api/v1/certificates/policies/{id}/download-ca-chain
Download the CA chain for a specified Policy
1.7.3.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Policy CA chain downloaded successfully |
CaCertificatePemDto[CaCertificatePemDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.4. downloadCertificate
GET /api/v1/certificates/{id}/download
Download Certificate
1.7.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Downloaded |
CertificatePemDto[CertificatePemDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.5. downloadCertificateChain
GET /api/v1/certificates/{id}/download-chain
Download Chain of Certificate
1.7.5.1. Parameters
1.7.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Chain Downloaded |
CertificatePemDto[CertificatePemDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.6. downloadCertificatePrivateKey
GET /api/v1/certificates/{id}/download-private-key
Download private key of the Certificate
1.7.6.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Certificate private key downloaded |
CertificatePrivateKeyPemDto[CertificatePrivateKeyPemDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.7. downloadCertificatesAsZip
GET /api/v1/certificates/batch-download
Batch Download Certificates
1.7.7.1. Parameters
1.7.7.1.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
ids |
The list of ids in order to specify the desired Certificates [UUID] |
X |
null |
1.7.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificates Downloaded |
ZippedFileDto[ZippedFileDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.8. downloadCrl
GET /api/v1/certificates/{id}/crl
Download crl for a Certificate
1.7.8.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate's crl downloaded |
CrlDto[CrlDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.9. emailCertificate
POST /api/v1/certificates/{id}/email
Send Certificate E-Mail
1.7.9.4. Responses
Code | Message | Datatype |
---|---|---|
204 |
Certificate E-Mail sent |
<<>> |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.10. getAuditEventsForCertificate
GET /api/v1/certificates/{id}/audit-events
Get Audit Events for a Certificate
1.7.10.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate's Audit Events Found |
GetAuditEventResponseDtoList[GetAuditEventResponseDtoList] |
1.7.11. getCertificateByFingerprint
GET /api/v1/certificates/by-fingerprint
Get Certificate by fingerprint
1.7.11.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Certificate |
GetCertificateResponseDto[GetCertificateResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.12. getCertificateByIssuerDnBinAndSerialNumber
POST /api/v1/certificates/by-issuer-dn-bin-and-serial-number
Get Certificate by issuer dn bin and serial number
1.7.12.1. Parameters
1.7.12.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Certificate |
GetCertificateResponseDto[GetCertificateResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.13. getCertificateDetails
GET /api/v1/certificates/{id}
Get Certificate
1.7.13.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Certificate |
GetCertificateResponseDto[GetCertificateResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.14. getCertificatesByRealmId
GET /api/v1/certificates/realms/{id}
Get available Certificates in Realm
1.7.14.1. Parameters
1.7.14.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id of the Realm which will be used to get the Certificates that are a part of it |
X |
null |
1.7.14.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.7.14.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Certificates |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.15. getNameOfRolesWithCertificateAccess
GET /api/v1/certificates/{id}/roles
Get role names of respective certificate
1.7.15.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.16. getOcspStatus
GET /api/v1/certificates/{id}/ocsp-status
Get the OCSP status of a Certificate
1.7.16.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
OCSP status of Certificate Found |
OcspStatusCheckDto[OcspStatusCheckDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.17. getSoonExpiringCertificates
GET /api/v1/certificates/realms/{id}/expiring
Get the Certificates that are expiring soon of the requested Realm
1.7.17.1. Parameters
1.7.17.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Expiring soon Certificates for the Realm Found |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.18. markCertificatesAsRevoked
PATCH /api/v1/certificates/mark-as-revoked
Mark Certificates as revoked
1.7.18.1. Parameters
1.7.18.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Certificates Marked As Revoked |
<<>> |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.19. retrieveCertificateP12
GET /api/v1/certificates/{id}/pkcs12
Retrieve P12 Certificate
1.7.19.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
P12 Certificate Retrieved |
KeystoreFileDto[KeystoreFileDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.20. revokeCertificate
POST /api/v1/certificates/revoke
Revoke Certificate
1.7.20.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Revoked |
RevokeCertificateResponseDto[RevokeCertificateResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.21. revokeMultipleCertificates
POST /api/v1/certificates/batch-revoke
Batch Revoke Certificates
1.7.21.1. Parameters
1.7.21.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificates Revoked |
RevokeMultipleCertificateResponseDto[RevokeMultipleCertificateResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.22. searchAllCertificates
POST /api/v1/certificates/search-all
Search all Certificates
1.7.22.1. Parameters
1.7.22.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.7.22.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Certificates |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.23. searchCertificates
POST /api/v1/certificates/search
Search Certificates
1.7.23.1. Parameters
1.7.23.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.7.23.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Certificates |
GetCertificateResponseDtoPage[GetCertificateResponseDtoPage] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.24. validateCertificate
POST /api/v1/certificates/validate
Validates a PEM certificate returning true/false and CA chain, if the certificate can be validated by the known CAs in the system
1.7.24.1. Parameters
1.7.24.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate is validated |
CertificateValidationResponseDto[CertificateValidationResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.7.25. validateCertificatePlain
POST /api/v1/certificates/validate-plain
Validates a PEM certificate returning true/false, if the certificate can be validated by the known CAs in the system
1.7.25.1. Parameters
1.7.25.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate is validated |
CertificatePlainValidationResponseDto[CertificatePlainValidationResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.8. CertificateProvider
1.8.1. checkCertificateProviderConnection
POST /api/v1/certificate-providers/{id}/check-connection
Check connected of the Certificate Provider
1.8.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Provider connected Checked |
CheckCertificateProviderConnectionDto[CheckCertificateProviderConnectionDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.8.2. createCertificateProvider
POST /api/v1/certificate-providers/
Create a Certificate Provider
1.8.2.1. Parameters
1.8.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Created Certificate Provider |
CreateCertificateProviderResponseDto[CreateCertificateProviderResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.8.3. getCertificateProvider
GET /api/v1/certificate-providers/{id}
Get Certificate Provider by Id
1.8.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Certificate Provider |
GetCertificateProviderResponseDto[GetCertificateProviderResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.8.4. searchCertificateProviders
POST /api/v1/certificate-providers/search
Find the Certificate Providers
1.8.4.1. Parameters
1.8.4.1.1. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
CertificateProviderSearchRequestDto |
X |
1.8.4.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.8.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Providers Found |
GetCertificateProviderResponseDtoPage[GetCertificateProviderResponseDtoPage] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.8.5. searchCertificateProvidersForPolicyCreateUpdate
POST /api/v1/certificate-providers/minimal/search
Find the Certificate Providers (non admin)
1.8.5.1. Parameters
1.8.5.1.1. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
CertificateProviderSearchRequestDto |
X |
1.8.5.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.8.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Providers Found |
GetCertificateProviderMinimalResponseDtoPage[GetCertificateProviderMinimalResponseDtoPage] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.8.6. updateCertificateProvider
PATCH /api/v1/certificate-providers/{id}
Update a Certificate Provider
1.8.6.1. Parameters
1.8.6.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of Certificate Provider that will be updated |
X |
null |
1.8.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Provider Updated |
UpdateCertificateProviderResponseDto[UpdateCertificateProviderResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.9. CertificateProviderOptions
1.9.1. getAllTemplateSignersByCertificateProviderId
GET /api/v1/certificate-providers-options/{id}/all-cara-template-signers
Returns all Template Signers of the Certificate Provider with this ID and the RA Template Signers
1.9.1.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Template Signers Found |
CaraTemplateSignerDtoList[CaraTemplateSignerDtoList] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.9.2. getMscaTemplatesByCertificateProviderId
GET /api/v1/certificate-providers-options/{id}/msca-templates
Returns the MS CA Templates of the Certificate Provider with this ID
1.9.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
MS CA Templates Found |
MscaTemplatesResponseDto[MscaTemplatesResponseDto] |
1.9.3. getPublicCasProducts
GET /api/v1/certificate-providers-options/{id}/public-cas-products
Returns the Public CAs products of the Certificate Provider with this ID
1.9.3.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Public CAs Products Found |
PublicCAsProductsResponseDto[PublicCAsProductsResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.9.4. getTemplateSignersByCertificateProviderId
GET /api/v1/certificate-providers-options/{id}/cara-template-signers
Returns the Template Signers of the Certificate Provider with this ID
1.9.4.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Template Signers Found |
CaraTemplateSignerDtoList[CaraTemplateSignerDtoList] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.10. Cmp
1.10.1. calculateMac
POST /api/v1/cmp/calculate-mac
Perform a MAC calculation with an End Entity password and a policy
1.10.1.1. Parameters
1.10.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Mac calculation operation was completed without errors. See response for verification result. |
CmpCalculateMacResponseDto[CmpCalculateMacResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.10.2. getCmpConfigurationByPolicyId
GET /api/v1/cmp/policies/{policyId}/configuration
Find a CMP configuration by a policy ID
1.10.2.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
CMP configuration Found |
GetCmpConfigurationResponseDto[GetCmpConfigurationResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.10.3. signData
POST /api/v1/cmp/sign
Signs the data with CMP signer for the policy provided in the parameters
1.10.3.1. Parameters
1.10.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Data signed |
SignDataResponseDto[SignDataResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.10.4. verifyMac
POST /api/v1/cmp/verify-mac
Perform a MAC verification with an End Entity password and a policy
1.10.4.1. Parameters
1.10.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Mac verify operation was completed without errors. See response for verification result. |
CmpVerifyMacResponseDto[CmpVerifyMacResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.11. Configuration
1.11.1. checkEmailConnection
POST /api/v1/configuration/check-email-connection
Check the connection of the configuration E-Mail
1.11.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
The Configuration E-Mail connection was checked successfully |
<<>> |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.11.2. createConfiguration
POST /api/v1/configuration/
Create new Configuration
1.11.2.1. Parameters
1.11.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Configuration Created |
CreateConfigurationResponseDto[CreateConfigurationResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.11.3. deleteConfiguration
DELETE /api/v1/configuration/{settingsKey}
Delete Configuration
1.11.3.1. Parameters
1.11.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Configuration Deleted |
<<>> |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.11.4. getConfiguration
GET /api/v1/configuration/{settingsKey}
Retrieve Configuration by Setting key
1.11.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Configuration Found |
GetConfigurationResponseDto[GetConfigurationResponseDto] |
1.11.5. searchConfiguration
POST /api/v1/configuration/search
Search Configuration
1.11.5.1. Parameters
1.11.5.1.1. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
SearchConfigurationRequestDto |
X |
1.11.5.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.11.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Configuration |
GetConfigurationResponseDtoPage[GetConfigurationResponseDtoPage] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.11.6. updateConfiguration
PATCH /api/v1/configuration/
Update Configuration
1.11.6.1. Parameters
1.11.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Configuration Updated |
UpdateConfigurationResponseDto[UpdateConfigurationResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.11.7. updateConfigurationBatch
PATCH /api/v1/configuration/batch
Update Configuration values in batch mode
1.11.7.1. Parameters
1.11.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Configuration values Updated |
UpdateConfigurationBatchResponseDto[UpdateConfigurationBatchResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.12. CryptoModules
1.12.1. createCryptoModule
POST /api/v1/crypto-modules/
Create a Crypto Module
1.12.1.1. Parameters
1.12.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Created Crypto Module |
CreateCryptoModuleResponseDto[CreateCryptoModuleResponseDto] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.12.2. getCryptoModule
GET /api/v1/crypto-modules/{id}
Get Crypto Module by ID
1.12.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Crypto Module found |
GetCryptoModuleResponseDto[GetCryptoModuleResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.12.3. performHealthCheck
PATCH /api/v1/crypto-modules/{id}/health-check
Perform health check for Crypto Module
1.12.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Health check for crypto module performed |
GetCryptoModuleHealthCheckResponseDto[GetCryptoModuleHealthCheckResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.12.4. searchCryptoModules
POST /api/v1/crypto-modules/search
Search the Crypto Modules
1.12.4.1. Parameters
1.12.4.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.12.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Crypto Modules found |
GetCryptoModuleResponseDtoPage[GetCryptoModuleResponseDtoPage] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.13. EndEntity
1.13.1. createNewEndEntity
POST /api/v1/end-entities/
Create an End Entity
1.13.1.1. Parameters
1.13.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Created End Entity |
CreateEndEntityResponseDto[CreateEndEntityResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.2. findEeByCertBytes
POST /api/v1/end-entities/find-by-cert-bytes
Get End Entity by certificate bytes
1.13.2.1. Parameters
1.13.2.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Found End Entity |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.3. findEndEntityByPolicyIdAndEndEntityDataset
POST /api/v1/end-entities/policies/{id}/by-end-entity-dataset
Find End Entity by Policy and End Entity dataset
1.13.3.1. Parameters
1.13.3.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id passed in the url is the id of the Policy that will be used for the search of the End Entity |
X |
null |
1.13.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
End Entity found by Policy and dataset |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.4. findEndEntityByPolicyIdAndPkcs10
POST /api/v1/end-entities/policies/{id}/by-pkcs10
Find End Entity by Policy and PKCS10
1.13.4.1. Parameters
1.13.4.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id passed in the url is the id of the Policy that will be used for the search of the End Entity |
X |
null |
1.13.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
End Entity found by Policy and PKCS10 |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.5. getEndEntity
GET /api/v1/end-entities/{id}
Get End Entity by Id
1.13.5.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Found End Entity |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.6. getEndEntityByRealmIdAndExternalId
GET /api/v1/end-entities/realms/{realmId}/externals/{externalId}
Get End Entity by Realm and External Id
1.13.6.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Found End Entity |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.7. getNameOfRolesWithEndEntityAccess
GET /api/v1/end-entities/{id}/roles
Get role names of respective end entity
1.13.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.8. searchAllEndEntities
POST /api/v1/end-entities/search-all
Search all End Entities
1.13.8.1. Parameters
1.13.8.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.13.8.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found End Entities |
GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage] |
1.13.9. searchEndEntities
POST /api/v1/end-entities/search
Search End Entities
1.13.9.1. Parameters
1.13.9.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.13.9.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found End Entities |
GetEndEntityResponseDtoPage[GetEndEntityResponseDtoPage] |
1.13.10. setEndEntityAlias
PATCH /api/v1/end-entities/{id}/alias
Set End Entity Alias
1.13.10.1. Parameters
1.13.10.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id passed in the url is the End Entity's id for which the Alias will be set to |
X |
null |
1.13.10.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Alias for End Entity was set |
GetEndEntityResponseDto[GetEndEntityResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.13.11. uploadEndEntitiesCsv
POST /api/v1/end-entities/upload-csv
Add multiple End Entities from csv file
1.13.11.1. Parameters
1.13.11.4. Responses
Code | Message | Datatype |
---|---|---|
201 |
The End Entities were saved successfully |
EndEntityMassImportResponseDto[EndEntityMassImportResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.14. EndEntityPassword
1.14.2. createNewEndEntityPassword
POST /api/v1/end-entity-passwords/
Create Password for End Entity
1.14.2.1. Parameters
1.14.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Password for End Entity created |
CreateEndEntityPasswordResponseDto[CreateEndEntityPasswordResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.14.3. deleteEndEntityPassword
DELETE /api/v1/end-entity-passwords/
Delete Password of End Entity
1.14.3.1. Parameters
1.14.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Password for End Entity Deleted |
<<>> |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.14.4. getEndEntityPasswordByEndEntityIdAndPolicyId
GET /api/v1/end-entity-passwords/end-entities/{endEntityId}/policies/{policyId}
Get End Entity Password by End Entity Id and Policy Id
1.14.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found End Entity Password |
GetEndEntityPasswordResponseDto[GetEndEntityPasswordResponseDto] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.14.5. getEndEntityPasswordsByEndEntityId
GET /api/v1/end-entity-passwords/end-entities/{id}/
Find the End Entity Passwords connected with the specific End Entity
1.14.5.1. Parameters
1.14.5.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of the End Entity for which the search is requested |
X |
null |
1.14.5.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.14.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
End Entity Passwords Found |
GetEndEntityPasswordResponseDtoPage[GetEndEntityPasswordResponseDtoPage] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.14.6. resetEndEntityPassword
POST /api/v1/end-entity-passwords/reset
Reset Password of End Entity
1.14.6.1. Parameters
1.14.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Password for End Entity was reset |
ResetEndEntityPasswordResponseDto[ResetEndEntityPasswordResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.15. Enum
1.15.1. getApiErrorValues
GET /api/v1/public/enum/api-error-values
Get Api Error values
1.15.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Api Error values found |
GetApiErrorValuesResponseDtoList[GetApiErrorValuesResponseDtoList] |
1.15.2. getCertRequestPermissionsValues
GET /api/v1/public/enum/cert-request-permissions
Get Certificate Request Permissions values
1.15.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Request Permissions values found |
GetCertRequestPermissionResponseDtoList[GetCertRequestPermissionResponseDtoList] |
1.15.3. getCertStatusValues
GET /api/v1/public/enum/cert-status-values
Get Certificate Status values
1.15.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Status values found |
GetCertStatusResponseDtoList[GetCertStatusResponseDtoList] |
1.15.4. getCertificatePermissionsValues
GET /api/v1/public/enum/certificate-permissions
Get Certificate Permissions values
1.15.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Permissions values found |
GetCertificatePermissionResponseDtoList[GetCertificatePermissionResponseDtoList] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.5. getCertificateProviderTypeResponseDtoList
GET /api/v1/public/enum/certificate-provider-type-values
Get Certificate Provider type values
1.15.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Provider type values found |
GetCertificateProviderTypeResponseDtoList[GetCertificateProviderTypeResponseDtoList] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.6. getCertificateSearchKeyValues
GET /api/v1/public/enum/cert-search-key-values
Get Certificate Search Key values
1.15.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Search Key values found |
GetCertificateSearchKeyResponseDtoList[GetCertificateSearchKeyResponseDtoList] |
1.15.7. getCmpSignatureAlgorithmValues
GET /api/v1/public/enum/cmp-signature-algorithm-values
Get CMP Signature Algorithm values
1.15.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
CMP Signature Algorithm values found |
GetCmpSignatureAlgorithmResponseDtoList[GetCmpSignatureAlgorithmResponseDtoList] |
1.15.8. getCryptoAlgorithmValues
GET /api/v1/public/enum/crypto-algorithm-values
Get Crypto Algorithm values
1.15.8.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Crypto Algorithm values found |
GetCryptoAlgorithmResponseDtoList[GetCryptoAlgorithmResponseDtoList] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.9. getCryptoModuleTypes
GET /api/v1/public/enum/crypto-module-type-values
Get Crypto Module type values
1.15.9.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Crypto Module type values found |
GetCryptoModuleTypeListResponseDto[GetCryptoModuleTypeListResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.10. getEcNamedCurvesValues
GET /api/v1/public/enum/ec-named-curves-values
Get EC Named Curves values
1.15.10.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
EC Named Curves values found |
GetECNamedCurveResponseDtoList[GetECNamedCurveResponseDtoList] |
1.15.11. getEdDSANamedCurvesValues
GET /api/v1/public/enum/eddsa-named-curves-values
Get EdDSA Named Curves values
1.15.11.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
EdDSA Named Curves values found |
GetEdDSANamedCurveResponseDtoList[GetEdDSANamedCurveResponseDtoList] |
1.15.12. getEndEntityPermissionsValues
GET /api/v1/public/enum/end-entity-permissions
Get End Entity Permissions values
1.15.12.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
End Entity Permissions values found |
GetEndEntityPermissionResponseDtoList[GetEndEntityPermissionResponseDtoList] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.13. getEndEntityPropertiesValues
GET /api/v1/public/enum/end-entity-properties
Get End Entity Properties values
1.15.13.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
End Entity Properties values found |
GetEndEntityPropertyResponseDtoList[GetEndEntityPropertyResponseDtoList] |
1.15.14. getEntitiesEnumValues
GET /api/v1/public/enum/entities-enum-values
Get End Entity Enum values
1.15.14.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
End Entity Enum values found |
GetEntitiesEnumResponseDtoList[GetEntitiesEnumResponseDtoList] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.15. getEntityStrategyEnumValues
GET /api/v1/public/enum/entity-strategy-enum-values
Get Entity Strategy Enum values
1.15.15.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Entity Strategy Enum values found |
GetEndEntityStrategyResponseDtoList[GetEndEntityStrategyResponseDtoList] |
1.15.16. getGlobalPermissionsValues
GET /api/v1/public/enum/global-permissions
Get Global Permissions values
1.15.16.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Global Permissions values found |
GetGlobalPermissionResponseDtoList[GetGlobalPermissionResponseDtoList] |
1.15.17. getKeyPairModeValues
GET /api/v1/public/enum/key-pair-mode-values
Get Key Pair Mode values
1.15.17.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Key Pair Mode values found |
GetKeyPairModeResponseDtoList[GetKeyPairModeResponseDtoList] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.18. getPolicyPermissionsValues
GET /api/v1/public/enum/policy-permissions
Get Policy Permissions values
1.15.18.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Policy Permissions values found |
GetPolicyPermissionResponseDtoList[GetPolicyPermissionResponseDtoList] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.19. getRealmPermissionsValues
GET /api/v1/public/enum/realm-permissions
Get Realm Permissions values
1.15.19.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Realm Permissions values found |
GetRealmPermissionResponseDtoList[GetRealmPermissionResponseDtoList] |
1.15.20. getRevocationReasonValues
GET /api/v1/public/enum/revocation-reason-values
Get Revocation Reason values
1.15.20.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Revocation Reason values found |
GetRevocationReasonResponseDtoList[GetRevocationReasonResponseDtoList] |
1.15.21. getRsaKeySizeValues
GET /api/v1/public/enum/rsa-key-size-values
Get RSA Key Size values
1.15.21.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
RSA Key Size values found |
GetRSAKeySizeResponseDtoList[GetRSAKeySizeResponseDtoList] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.15.22. getValidForValues
GET /api/v1/public/enum/valid-for-values
Get Valid For values
1.15.22.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Valid For values found |
GetValidForResponseDtoList[GetValidForResponseDtoList] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
1.16. MailingList
1.16.1. createNewMailingList
POST /api/v1/mailing-lists/
Create Mailing List
1.16.1.1. Parameters
1.16.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Mailing List Created |
CreateNewMailingListResponseDto[CreateNewMailingListResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.16.2. getMailingList
GET /api/v1/mailing-lists/{id}
Get Mailing List by Id
1.16.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Found Mailing List |
GetMailingListResponseDto[GetMailingListResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.16.3. searchMailingLists
POST /api/v1/mailing-lists/search
Search Mailing Lists
1.16.3.1. Parameters
1.16.3.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.16.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Mailing Lists Found |
GetMailingListResponseDtoPage[GetMailingListResponseDtoPage] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.16.4. updateMailingList
POST /api/v1/mailing-lists/{id}
Update a Mailing List
1.16.4.1. Parameters
1.16.4.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
The id of the Mailing List that will be updated |
X |
null |
1.16.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Mailing List Updated |
UpdateMailingListResponseDto[UpdateMailingListResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.17. Pkcs10
1.17.1. createPkcs10Request
POST /api/v1/pkcs10/
Create a PKCS10 Request
1.17.1.1. Parameters
1.17.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
PKCS10 Request Created |
CreatePkcs10ResponseDto[CreatePkcs10ResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.17.2. parsePkcs10
POST /api/v1/pkcs10/parse
Parse a PKCS10 Request
1.17.2.1. Parameters
1.17.2.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
PKCS10 Request Parsed |
ParsePkcs10ResponseDto[ParsePkcs10ResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18. Policy
1.18.1. availablePoliciesWithoutPasswordByEndEntityId
GET /api/v1/policies/end-entities/{id}/no-password
Find the Policies without an End Entity Password for a specific End Entity
1.18.1.1. Parameters
1.18.1.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of the End Entity for which the search is requested |
X |
null |
1.18.1.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.18.1.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.2. checkEndEntityWithRules
POST /api/v1/policies/{id}/rules
Check End Entity Rules
1.18.2.1. Parameters
1.18.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
End Entity Rules Checked |
CheckEndEntityResponseDto[CheckEndEntityResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.3. createNewPolicy
POST /api/v1/policies/
Create a Policy
1.18.3.1. Parameters
1.18.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Policy Created |
CreatePolicyResponseDto[CreatePolicyResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.4. getAllowedCryptoParameters
PUT /api/v1/policies/allowed-crypto-params
Get policy allowed crypto parameters for provider provider and provider configuration
1.18.4.1. Parameters
1.18.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
End Entity Rules Checked |
CryptoParametersDto[CryptoParametersDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.5. getNameOfRolesWithPolicyAccess
GET /api/v1/policies/{id}/roles
Get role names of respective policy
1.18.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.6. getPoliciesByCertificateProviderId
GET /api/v1/policies/certificate-providers/{id}
Search Policies that use a specific Certificate Provider
1.18.6.1. Parameters
1.18.6.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
ID of the Certificate Provider for which the search of Policies is requested |
X |
null |
1.18.6.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.18.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Policies Found connected to the specific Certificate Provider |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
1.18.7. getPoliciesInRealms
POST /api/v1/policies/realms
Find the Policies of multiple Realms
1.18.7.1. Parameters
1.18.7.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.18.7.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.8. getPolicy
GET /api/v1/policies/{id}
Find a specific Policy
1.18.8.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Policy Found |
GetPolicyResponseDto[GetPolicyResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.9. getPolicyByRealmId
GET /api/v1/policies/realms/{id}
Find the Policies of a Realm
1.18.9.1. Parameters
1.18.9.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of Realm for which Policies will be searched |
X |
null |
1.18.9.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.18.9.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.10. searchAllPolicies
POST /api/v1/policies/search-all
Search all Policies
1.18.10.1. Parameters
1.18.10.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.18.10.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.11. searchPolicies
POST /api/v1/policies/search
Search Policies
1.18.11.1. Parameters
1.18.11.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.18.11.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Policies Found |
GetPolicyResponseDtoPage[GetPolicyResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.18.12. updatePolicy
PATCH /api/v1/policies/{id}
Update a Policy
1.18.12.1. Parameters
1.18.12.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of Policy that will be updated |
X |
null |
1.18.12.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Policy Updated |
UpdatePolicyResponseDto[UpdatePolicyResponseDto] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.19. PublicUser
1.19.1. extractEndEntityInfoFromPemEncodedPkcs10
POST /api/v1/public/extract-end-entity-from-pkcs10
Extract End Entity info from PEM encoded PKCS10 Request
1.19.1.1. Parameters
1.19.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Extracted End Entity info from PEM encoded PKCS10 Request |
ExtractEndEntityInfoFromPkcs10ResponseDto[ExtractEndEntityInfoFromPkcs10ResponseDto] |
1.19.2. verifyCertificateRequestByEmail
POST /api/v1/public/verify-cert-request-with-email
Verify Certificate Request by E-Mail
1.19.2.1. Parameters
1.19.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Verified Certificate Request and sent an E-Mail |
EmailVerifiedCertReqResponseDto[EmailVerifiedCertReqResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.20. RaCertificate
1.20.1. createBatchRaCertificateForUsers
POST /api/v1/ra-certificates/users/batch
Create Batch Ra Certificates for a User
1.20.1.1. Parameters
1.20.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User's Ra Certificates Created |
ZippedCertsBatchDto[ZippedCertsBatchDto] |
502 |
Bad Gateway, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.2. createRaCertificateForSingleUser
POST /api/v1/ra-certificates/users/{id}
Create/renew Ra Certificate for a single User
1.20.2.1. Parameters
1.20.2.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of the User whose Ra Certificate we are creating |
X |
null |
1.20.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User's Ra Certificate Created |
UpdateUserRaCertificateDto[UpdateUserRaCertificateDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.3. downloadRaCertCrl
GET /api/v1/ra-certificates/users/{id}/crl
Download the Ra Certificate of a User
1.20.3.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Ra Certificate of the User Downloaded |
CrlDto[CrlDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.4. downloadUserRaCertificate
GET /api/v1/ra-certificates/users/{id}/download
Download the Ra Certificate of a User
1.20.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User's Ra Certificate Downloaded |
RaCertificatePemDto[RaCertificatePemDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.5. downloadUserRaCertificateChain
GET /api/v1/ra-certificates/users/{id}/download-chain
Download the Certificate Chain of a User
1.20.5.1. Parameters
1.20.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User's Certificate Chain Downloaded |
RaCertificatePemDto[RaCertificatePemDto] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.6. getRaOcspStatus
GET /api/v1/ra-certificates/users/{id}/ocsp-status
Get the Ra OCSP Status of a User
1.20.6.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Got the Ra OCSP Status of the User |
OcspStatusCheckDto[OcspStatusCheckDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.7. getUserRaCertificate
GET /api/v1/ra-certificates/users/{id}
Find a specific User’s Ra Certificate
1.20.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Ra Certificate Found |
GetRaCertificateResponseDto[GetRaCertificateResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.8. retrieveRaCertificateP12
GET /api/v1/ra-certificates/users/{id}/pkcs12
Retrieve the Ra PKCS12 Certificate of a User
1.20.8.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User's Ra PKCS12 Certificate Retrieved |
KeystoreFileDto[KeystoreFileDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.20.9. revokeRaCertificate
POST /api/v1/ra-certificates/users/{id}/revoke
Revoke the Ra Certificate of a User
1.20.9.1. Parameters
1.20.9.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
User's Ra Certificate Revoked |
RevokeRaCertificateResponseDto[RevokeRaCertificateResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.21. Realm
1.21.1. createNewRealm
POST /api/v1/realms/
Create a Realm
1.21.1.1. Parameters
1.21.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Realm Created |
CreateRealmResponseDto[CreateRealmResponseDto] |
1.21.2. getNameOfRolesWithRealmAccess
GET /api/v1/realms/{id}/roles
Get role names of respective realm
1.21.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Role names Found |
GetEntityRoleNamesResponseDto[GetEntityRoleNamesResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.21.3. getRealm
GET /api/v1/realms/{id}
Find Realm
1.21.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Realm Found |
GetRealmResponseDto[GetRealmResponseDto] |
1.21.4. getRealms
GET /api/v1/realms/
Find Realms
1.21.4.1. Parameters
1.21.4.1.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.21.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Realms Found |
GetRealmResponseDtoPage[GetRealmResponseDtoPage] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.21.5. search
POST /api/v1/realms/search
Search Realms
1.21.5.1. Parameters
1.21.5.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.21.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Realms Found |
GetRealmResponseDtoPage[GetRealmResponseDtoPage] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.21.6. updateRealm
PATCH /api/v1/realms/{id}
Update a Realm
1.21.6.1. Parameters
1.21.6.1.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Id of the Realm that will be updated |
X |
null |
1.21.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
409 |
Conflict, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Realm Updated |
UpdateRealmResponseDto[UpdateRealmResponseDto] |
1.22. RealmStatistics
1.22.1. getCertRequestStatusStatisticsForRealm
GET /api/v1/realm-statistics/{id}/cert-request-status
Get the Certificate Request Status Statistics of the requested Realm
1.22.1.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Request Status Statistics for the Realm Found |
GetCertRequestStatusStatisticsResponseDto[GetCertRequestStatusStatisticsResponseDto] |
1.22.2. getCertificateIssuerStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-issuer
Get the Certificate Issuer Statistics of the requested Realm
1.22.2.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Certificate Issuer Statistics for the Realm Found |
GetCertificateIssuerStatisticsResponseDto[GetCertificateIssuerStatisticsResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.22.3. getCertificateProviderTypeStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-provider-type
Get the Certificate Provider Type Statistics of the requested Realm
1.22.3.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Provider Type Statistics for the Realm Found |
GetCertificateProviderTypeStatisticsResponseDto[GetCertificateProviderTypeStatisticsResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.22.4. getCertificatePublicKeyAlgorithmStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-public-key-algorithm
Get the Certificate Public Key Algorithm Statistics of the requested Realm
1.22.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Public Key Algorithm Statistics for the Realm Found |
GetCertificatePublicKeyAlgorithmStatisticsResponseDto[GetCertificatePublicKeyAlgorithmStatisticsResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.22.5. getCertificateStatusStatisticsForRealm
GET /api/v1/realm-statistics/{id}/certificate-status
Get the Certificate Status Statistics of the requested Realm
1.22.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Certificate Status Statistics for the Realm Found |
GetCertificateStatusStatisticsResponseDto[GetCertificateStatusStatisticsResponseDto] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.22.6. getImportedCertificatesStatisticsForRealm
GET /api/v1/realm-statistics/{id}/imported-certificates
Get the Imported Certificates Statistics of the requested Realm
1.22.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Imported Certificates Statistics for the Realm Found |
GetImportedCertificatesStatisticsResponseDto[GetImportedCertificatesStatisticsResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.22.7. getLatestAuditEvents
GET /api/v1/realm-statistics/{id}/latest-audit-events
Get the latest Certificate Audit Events of the requested Realm
1.22.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Latest Certificate Audit Events |
GetAuditEventResponseDtoList[GetAuditEventResponseDtoList] |
422 |
Unprocessable Entity, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.22.8. getSelfSignedCertificatesStatisticsForRealm
GET /api/v1/realm-statistics/{id}/self-signed-certificates
Get the Self-signed Certificates Statistics of the requested Realm
1.22.8.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Self-signed Certificates Statistics for the Realm Found |
GetSelfSignedCertificatesStatisticsResponseDto[GetSelfSignedCertificatesStatisticsResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.23. Roles
1.23.1. batchAssignApiClientRoles
PUT /api/v1/roles/api-clients/assign
Assign Roles for multiple API Clients
1.23.1.1. Parameters
1.23.1.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
API Client Roles assigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.2. batchAssignUserRoles
PUT /api/v1/roles/users/assign
Assign Roles for multiple Users
1.23.2.1. Parameters
1.23.2.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User Roles assigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.3. batchUnassignApiClientRoles
PUT /api/v1/roles/api-clients/unassign
Unassign Roles from multiple API Clients
1.23.3.1. Parameters
1.23.3.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
API Client Roles unassigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.4. batchUnassignUserRoles
PUT /api/v1/roles/users/unassign
Unassign Roles from multiple Users
1.23.4.1. Parameters
1.23.4.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User Roles unassigned |
UpdateSecurityIdentityRolesBatchResponseDto[UpdateSecurityIdentityRolesBatchResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.5. createRole
POST /api/v1/roles/
Create Role
1.23.5.1. Parameters
1.23.5.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
201 |
Role created |
CreateRoleResponseDto[CreateRoleResponseDto] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.6. deleteRole
DELETE /api/v1/roles/{name}
Delete Role
1.23.6.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
204 |
Role deleted |
<<>> |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.7. deleteRoles
POST /api/v1/roles/batch-delete
Batch Delete Roles
1.23.7.1. Parameters
1.23.7.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Role(s) deleted |
BatchDeleteRolesResponseDto[BatchDeleteRolesResponseDto] |
1.23.8. getApiClientRoles
GET /api/v1/roles/api-clients/{apiClientId}
Get API Client Roles
1.23.8.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
API Client Roles Found |
GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.9. getRoleDetails
GET /api/v1/roles/{name}
Get Role
1.23.9.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Role Found |
GetRoleDetailsResponseDto[GetRoleDetailsResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.10. getSecurityIdentitiesOfRole
GET /api/v1/roles/{role}/security-identities
Get security identities of a role
1.23.10.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
Security identities Found |
GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto[GetMinimalRealmRoleSecurityIdentityRepresentationResponseDto] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.11. getUserRoles
GET /api/v1/roles/users/{userId}
Get User Roles
1.23.11.4. Responses
Code | Message | Datatype |
---|---|---|
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
200 |
User Roles Found |
GetSecurityIdentityRolesResponseDto[GetSecurityIdentityRolesResponseDto] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |
415 |
Specified media not supported for this endpoint |
ApiExceptionResponse[ApiExceptionResponse] |
1.23.12. searchRoles
POST /api/v1/roles/search
Search Roles
1.23.12.1. Parameters
1.23.12.1.2. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
page |
Zero-based page index (0..N) |
- |
0 |
|
size |
The size of the page to be returned |
- |
20 |
|
sort |
Sorting criteria in the format: property,(asc |
desc). Default sort order is ascending. Multiple sort criteria are supported. [String] |
- |
null |
1.23.12.4. Responses
Code | Message | Datatype |
---|---|---|
200 |
Roles Found |
GetRoleResponseDtoPage[GetRoleResponseDtoPage] |
500 |
Internal Error, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
400 |
Bad Request |
ApiExceptionResponse[ApiExceptionResponse] |
404 |
Not Found, check the result for more information |
ApiExceptionResponse[ApiExceptionResponse] |
405 |
Http method not allowed |
ApiExceptionResponse[ApiExceptionResponse] |
403 |
Access Denied |
ApiExceptionResponse[ApiExceptionResponse] |
401 |
Authentication Failed |
ApiExceptionResponse[ApiExceptionResponse] |