API Documentation

1.12.2.3. Content Type

application/json

1.12.2.4. Responses

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

1.12.3. findEndEntityByPolicyIdAndEndEntityDataset

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

Find End Entity by Policy and End Entity dataset

1.12.3.1. Parameters

1.12.3.1.1. Path Parameters

Name

Description

Required

Default

Pattern

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

null

1.12.3.1.2. Body Parameter

Name

Description

Required

Default

Pattern

EndEntityDatasetRequestDto

Section 2.93

1.12.3.2. Return Type

1.12.3.3. Content Type

application/json

1.12.3.4. Responses

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

1.12.4. findEndEntityByPolicyIdAndPkcs10

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

Find End Entity by Policy and PKCS10

1.12.4.1. Parameters

1.12.4.1.1. Path Parameters

Name

Description

Required

Default

Pattern

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

null

1.12.4.1.2. Body Parameter

Name

Description

Required

Default

Pattern

Pkcs10Dto

Section 2.192

1.12.4.2. Return Type

1.12.4.3. Content Type

application/json

1.12.4.4. Responses

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

1.12.5. getEndEntity

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

Get End Entity by Id

1.12.5.1. Parameters

1.12.5.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of End Entity to be searched

null

1.12.5.2. Return Type

1.12.5.3. Content Type

application/json

1.12.5.4. Responses

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

1.12.6. getEndEntityByRealmIdAndExternalId

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

Get End Entity by Realm and External Id

1.12.6.1. Parameters

1.12.6.1.1. Path Parameters

Name

Description

Required

Default

Pattern

realmId

Id of Realm to be searched

null

externalId

Id of External to be searched

null

1.12.6.2. Return Type

1.12.6.3. Content Type

application/json

1.12.6.4. Responses

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

1.12.7. searchEndEntities

POST /api/v1/end-entities/search

Search End Entities

1.12.7.1. Parameters

1.12.7.1.1. Body Parameter

Name

Description

Required

Default

Pattern

EndEntitySearchRequestDto

Section 2.102

1.12.7.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.12.7.2. Return Type

Section 2.147

1.12.7.3. Content Type

application/json

1.12.7.4. Responses

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

1.12.8. setEndEntityAlias

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

Set End Entity Alias

1.12.8.1. Parameters

1.12.8.1.1. Path Parameters

Name

Description

Required

Default

Pattern

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

null

1.12.8.1.2. Body Parameter

Name

Description

Required

Default

Pattern

SetEndEntityAliasRequestDto

Section 2.220

1.12.8.2. Return Type

1.12.8.3. Content Type

application/json

1.12.8.4. Responses

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

1.12.9. uploadEndEntitiesCsv

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

Add multiple End Entities from csv file

1.12.9.1. Parameters

1.12.9.1.1. Body Parameter

Name

Description

Required

Default

Pattern

EndEntitiesCsvDto

Section 2.90

1.12.9.2. Return Type

Section 2.96

1.12.9.3. Content Type

application/json

1.12.9.4. Responses

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

1.13. EndEntityPassword

1.13.1. authorizeWithEEidAndPassword

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

Authenticate with End Entity and Password

1.13.1.1. Parameters

1.13.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

EndEntityAuthenticationRequestDto

Section 2.91

1.13.1.2. Return Type

Section 2.92

1.13.1.3. Content Type

application/json

1.13.1.4. Responses

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

1.13.2. createNewEndEntityPassword

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

Create Password for End Entity

1.13.2.1. Parameters

1.13.2.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreateEndEntityPasswordRequestDto

Section 2.56

1.13.2.2. Return Type

Section 2.57

1.13.2.3. Content Type

application/json

1.13.2.4. Responses

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

1.13.3. deleteEndEntityPassword

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

Delete Password of End Entity

1.13.3.1. Parameters

1.13.3.1.1. Body Parameter

Name

Description

Required

Default

Pattern

EndEntityPasswordRequestDto

Section 2.97

1.13.3.2. Return Type

1.13.3.3. Content Type

application/json

1.13.3.4. Responses

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

1.13.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.13.4.1. Parameters

1.13.4.1.1. Path Parameters

Name

Description

Required

Default

Pattern

endEntityId

Id of End Entity to be searched

null

policyId

Id of Policy to be searched

null

1.13.4.2. Return Type

Section 2.142

1.13.4.3. Content Type

application/json

1.13.4.4. Responses

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

1.13.5. getEndEntityPasswordsByEndEntityId

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

Find the End Entity Passwords connected with the specific End Entity

1.13.5.1. Parameters

1.13.5.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the End Entity for which the search is requested

null

1.13.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.13.5.2. Return Type

Section 2.143

1.13.5.3. Content Type

application/json

1.13.5.4. Responses

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

1.13.6. resetEndEntityPassword

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

Reset Password of End Entity

1.13.6.1. Parameters

1.13.6.1.1. Body Parameter

Name

Description

Required

Default

Pattern

EndEntityPasswordRequestDto

Section 2.97

1.13.6.2. Return Type

Section 2.203

1.13.6.3. Content Type

application/json

1.13.6.4. Responses

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

1.14. Enum

1.14.1. getApiErrorValues

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

Get Api Error values

1.14.1.1. Parameters

1.14.1.2. Return Type

Section 2.117

1.14.1.3. Content Type

application/json

1.14.1.4. Responses

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

1.14.2. getCertRequestPermissionsValues

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

Get Certificate Request Permissions values

1.14.2.1. Parameters

1.14.2.2. Return Type

Section 2.123

1.14.2.3. Content Type

application/json

1.14.2.4. Responses

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

1.14.3. getCertStatusValues

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

Get Certificate Status values

1.14.3.1. Parameters

1.14.3.2. Return Type

Section 2.124

1.14.3.3. Content Type

application/json

1.14.3.4. Responses

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

1.14.4. getCertificatePermissionsValues

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

Get Certificate Permissions values

1.14.4.1. Parameters

1.14.4.2. Return Type

Section 2.125

1.14.4.3. Content Type

application/json

1.14.4.4. Responses

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

1.14.5. getCertificateProviderTypeResponseDtoList

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

Get Certificate Provider type values

1.14.5.1. Parameters

1.14.5.2. Return Type

Section 2.130

1.14.5.3. Content Type

application/json

1.14.5.4. Responses

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

1.14.6. getCertificateSearchKeyValues

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

Get Certificate Search Key values

1.14.6.1. Parameters

1.14.6.2. Return Type

Section 2.133

1.14.6.3. Content Type

application/json

1.14.6.4. Responses

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

1.14.7. getCmpSignatureAlgorithmValues

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

Get CMP Signature Algorithm values

1.14.7.1. Parameters

1.14.7.2. Return Type

Section 2.136

1.14.7.3. Content Type

application/json

1.14.7.4. Responses

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

1.14.8. getCryptoAlgorithmValues

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

Get Crypto Algorithm values

1.14.8.1. Parameters

1.14.8.2. Return Type

Section 2.139

1.14.8.3. Content Type

application/json

1.14.8.4. Responses

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

1.14.9. getEcNamedCurvesValues

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

Get EC Named Curves values

1.14.9.1. Parameters

1.14.9.2. Return Type

Section 2.140

1.14.9.3. Content Type

application/json

1.14.9.4. Responses

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

1.14.10. getEdDSANamedCurvesValues

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

Get EdDSA Named Curves values

1.14.10.1. Parameters

1.14.10.2. Return Type

Section 2.141

1.14.10.3. Content Type

application/json

1.14.10.4. Responses

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

1.14.11. getEndEntityPermissionsValues

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

Get End Entity Permissions values

1.14.11.1. Parameters

1.14.11.2. Return Type

Section 2.144

1.14.11.3. Content Type

application/json

1.14.11.4. Responses

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

1.14.12. getEndEntityPropertiesValues

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

Get End Entity Properties values

1.14.12.1. Parameters

1.14.12.2. Return Type

Section 2.145

1.14.12.3. Content Type

application/json

1.14.12.4. Responses

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

1.14.13. getEntitiesEnumValues

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

Get End Entity Enum values

1.14.13.1. Parameters

1.14.13.2. Return Type

Section 2.149

1.14.13.3. Content Type

application/json

1.14.13.4. Responses

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

1.14.14. getEntityStrategyEnumValues

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

Get Entity Strategy Enum values

1.14.14.1. Parameters

1.14.14.2. Return Type

Section 2.148

1.14.14.3. Content Type

application/json

1.14.14.4. Responses

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

1.14.15. getGlobalPermissionsValues

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

Get Global Permissions values

1.14.15.1. Parameters

1.14.15.2. Return Type

Section 2.150

1.14.15.3. Content Type

application/json

1.14.15.4. Responses

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

1.14.16. getKeyPairModeValues

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

Get Key Pair Mode values

1.14.16.1. Parameters

1.14.16.2. Return Type

Section 2.151

1.14.16.3. Content Type

application/json

1.14.16.4. Responses

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

1.14.17. getPolicyPermissionsValues

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

Get Policy Permissions values

1.14.17.1. Parameters

1.14.17.2. Return Type

Section 2.157

1.14.17.3. Content Type

application/json

1.14.17.4. Responses

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

1.14.18. getRealmPermissionsValues

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

Get Realm Permissions values

1.14.18.1. Parameters

1.14.18.2. Return Type

Section 2.162

1.14.18.3. Content Type

application/json

1.14.18.4. Responses

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

1.14.19. getRevocationReasonValues

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

Get Revocation Reason values

1.14.19.1. Parameters

1.14.19.2. Return Type

Section 2.165

1.14.19.3. Content Type

application/json

1.14.19.4. Responses

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

1.14.20. getRsaKeySizeValues

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

Get RSA Key Size values

1.14.20.1. Parameters

1.14.20.2. Return Type

Section 2.160

1.14.20.3. Content Type

application/json

1.14.20.4. Responses

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

1.14.21. getValidForValues

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

Get Valid For values

1.14.21.1. Parameters

1.14.21.2. Return Type

Section 2.168

1.14.21.3. Content Type

application/json

1.14.21.4. Responses

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

1.15. MailingList

1.15.1. createNewMailingList

POST /api/v1/mailing-lists/

Create Mailing List

1.15.1.1. Parameters

1.15.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreateNewMailingListRequestDto

Section 2.67

1.15.1.2. Return Type

Section 2.68

1.15.1.3. Content Type

application/json

1.15.1.4. Responses

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

1.15.2. getMailingList

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

Get Mailing List by Id

1.15.2.1. Parameters

1.15.2.1.1. Path Parameters

Name

Description

Required

Default

Pattern

The id of the requested Mailing List

null

1.15.2.2. Return Type

Section 2.152

1.15.2.3. Content Type

application/json

1.15.2.4. Responses

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

1.15.3. searchMailingLists

POST /api/v1/mailing-lists/search

Search Mailing Lists

1.15.3.1. Parameters

1.15.3.1.1. Body Parameter

Name

Description

Required

Default

Pattern

MailingListSearchRequestDto

Section 2.180

1.15.3.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.15.3.2. Return Type

Section 2.153

1.15.3.3. Content Type

application/json

1.15.3.4. Responses

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

1.15.4. updateMailingList

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

Update a Mailing List

1.15.4.1. Parameters

1.15.4.1.1. Path Parameters

Name

Description

Required

Default

Pattern

The id of the Mailing List that will be updated

null

1.15.4.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateMailingListRequestDto

Section 2.241

1.15.4.2. Return Type

Section 2.242

1.15.4.3. Content Type

application/json

1.15.4.4. Responses

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

1.16. Permissions

1.16.1. getApiClientPermissions

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

Get Api Client Permissions

1.16.1.1. Parameters

1.16.1.1.1. Path Parameters

Name

Description

Required

Default

Pattern

The id of the Api Client

null

1.16.1.2. Return Type

Section 2.196

1.16.1.3. Content Type

application/json

1.16.1.4. Responses

Table 120. http response codes
Code	Message	Datatype
405	Http method not allowed	ApiExceptionResponse[Section 2.3]
400	Bad Request	ApiExceptionResponse[Section 2.3]
401	Authentication Failed	ApiExceptionResponse[Section 2.3]
500	Internal Error, check the result for more information	ApiExceptionResponse[Section 2.3]
200	Api Client Permissions Found	PrincipalAuthorizationDto[Section 2.196]
403	Access Denied	ApiExceptionResponse[Section 2.3]
404	Not Found, check the result for more information	ApiExceptionResponse[Section 2.3]

1.16.2. getUserPermissions

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

Get User Permissions

1.16.2.1. Parameters

1.16.2.1.1. Path Parameters

Name

Description

Required

Default

Pattern

The id of the User

null

1.16.2.2. Return Type

Section 2.196

1.16.2.3. Content Type

application/json

1.16.2.4. Responses

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

1.16.3. updateCertRequestPermissions

PATCH /api/v1/permissions/cert-requests

Update Certificate Request Permissions

1.16.3.1. Parameters

1.16.3.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UpdateCertRequestPermissionsDto

Section 2.231

1.16.3.2. Return Type

1.16.3.3. Content Type

application/json

1.16.3.4. Responses

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

1.16.4. updateCertificatePermissions

PATCH /api/v1/permissions/certificates

Update Certificate Permissions

1.16.4.1. Parameters

1.16.4.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UpdateCertificatePermissionsDto

Section 2.232

1.16.4.2. Return Type

1.16.4.3. Content Type

application/json

1.16.4.4. Responses

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

1.16.5. updateEndEntityPermissions

PATCH /api/v1/permissions/end-entities

Update End Entity Permissions

1.16.5.1. Parameters

1.16.5.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UpdateEndEntityPermissionsDto

Section 2.239

1.16.5.2. Return Type

1.16.5.3. Content Type

application/json

1.16.5.4. Responses

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

1.16.6. updateGlobalPermissions

PATCH /api/v1/permissions/global

Update Global Permissions

1.16.6.1. Parameters

1.16.6.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UpdateGlobalPermissionsDto

Section 2.240

1.16.6.2. Return Type

1.16.6.3. Content Type

application/json

1.16.6.4. Responses

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

1.16.7. updatePolicyPermissions

PATCH /api/v1/permissions/policies

Update Policy Permissions

1.16.7.1. Parameters

1.16.7.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UpdatePolicyPermissionsDto

Section 2.243

1.16.7.2. Return Type

1.16.7.3. Content Type

application/json

1.16.7.4. Responses

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

1.16.8. updateRealmPermissions

PATCH /api/v1/permissions/realms

Update Realm Permissions

1.16.8.1. Parameters

1.16.8.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UpdateRealmPermissionsDto

Section 2.246

1.16.8.2. Return Type

1.16.8.3. Content Type

application/json

1.16.8.4. Responses

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

1.17. Pkcs10

1.17.1. createPkcs10Request

POST /api/v1/pkcs10/

Create a PKCS10 Request

1.17.1.1. Parameters

1.17.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreatePkcs10RequestDto

Section 2.70

1.17.1.2. Return Type

Section 2.71

1.17.1.3. Content Type

application/json

1.17.1.4. Responses

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

1.17.2. parsePkcs10

POST /api/v1/pkcs10/parse

Parse a PKCS10 Request

1.17.2.1. Parameters

1.17.2.1.1. Body Parameter

Name

Description

Required

Default

Pattern

Pkcs10Dto

Section 2.192

1.17.2.2. Return Type

Section 2.191

1.17.2.3. Content Type

application/json

1.17.2.4. Responses

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

1.18. Policy

1.18.1. availablePoliciesWithoutPasswordByEndEntityId

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

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

1.18.1.1. Parameters

1.18.1.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the End Entity for which the search is requested

null

1.18.1.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.18.1.2. Return Type

1.18.1.3. Content Type

application/json

1.18.1.4. Responses

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

1.18.2. checkEndEntityWithRules

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

Check End Entity Rules

1.18.2.1. Parameters

1.18.2.1.1. Path Parameters

Name

Description

Required

Default

Pattern

null

1.18.2.1.2. Body Parameter

Name

Description

Required

Default

Pattern

CheckEndEntityRequestDto

Section 2.37

1.18.2.2. Return Type

Section 2.38

1.18.2.3. Content Type

application/json

1.18.2.4. Responses

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

1.18.3. createNewPolicy

POST /api/v1/policies/

Create a Policy

1.18.3.1. Parameters

1.18.3.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreatePolicyRequestDto

Section 2.72

1.18.3.2. Return Type

Section 2.73

1.18.3.3. Content Type

application/json

1.18.3.4. Responses

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

1.18.4. getAllowedCryptoParameters

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

Get policy allowed crypto parameters for provider provider and provider configuration

1.18.4.1. Parameters

1.18.4.1.1. Body Parameter

Name

Description

Required

Default

Pattern

GetAllowedCryptoParametersRequestDto

Section 2.114

1.18.4.2. Return Type

Section 2.80

1.18.4.3. Content Type

application/json

1.18.4.4. Responses

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

1.18.5. getPoliciesByCertificateProviderId

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

Search Policies that use a specific Certificate Provider

1.18.5.1. Parameters

1.18.5.1.1. Path Parameters

Name

Description

Required

Default

Pattern

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

null

1.18.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.18.5.2. Return Type

1.18.5.3. Content Type

application/json

1.18.5.4. Responses

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

1.18.6. getPoliciesInRealms

POST /api/v1/policies/realms

Find the Policies of multiple Realms

1.18.6.1. Parameters

1.18.6.1.1. Body Parameter

Name

Description

Required

Default

Pattern

GetPoliciesInRealmsDto

Section 2.156

1.18.6.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.18.6.2. Return Type

1.18.6.3. Content Type

application/json

1.18.6.4. Responses

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

1.18.7. getPolicy

GET /api/v1/policies/{id}

Find a specific Policy

1.18.7.1. Parameters

1.18.7.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of Policy to be searched

null

1.18.7.2. Return Type

Section 2.158

1.18.7.3. Content Type

application/json

1.18.7.4. Responses

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

1.18.8. getPolicyByRealmId

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

Find the Policies of a Realm

1.18.8.1. Parameters

1.18.8.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of Realm for which Policies will be searched

null

1.18.8.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.18.8.2. Return Type

1.18.8.3. Content Type

application/json

1.18.8.4. Responses

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

1.18.9. searchPolicies

POST /api/v1/policies/search

Search Policies

1.18.9.1. Parameters

1.18.9.1.1. Body Parameter

Name

Description

Required

Default

Pattern

PolicySearchRequestDto

Section 2.195

1.18.9.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.18.9.2. Return Type

1.18.9.3. Content Type

application/json

1.18.9.4. Responses

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

1.18.10. updatePolicy

PATCH /api/v1/policies/{id}

Update a Policy

1.18.10.1. Parameters

1.18.10.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of Policy that will be updated

null

1.18.10.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdatePolicyRequestDto

Section 2.244

1.18.10.2. Return Type

Section 2.245

1.18.10.3. Content Type

application/json

1.18.10.4. Responses

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

1.19. PublicUser

1.19.1. extractEndEntityInfoFromPemEncodedPkcs10

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

Extract End Entity info from PEM encoded PKCS10 Request

1.19.1.1. Parameters

1.19.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

ExtractEndEntityInfoFromPkcs10RequestDto

Section 2.107

1.19.1.2. Return Type

Section 2.108

1.19.1.3. Content Type

application/json

1.19.1.4. Responses

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

1.19.2. verifyCertificateRequestByEmail

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

Verify Certificate Request by E-Mail

1.19.2.1. Parameters

1.19.2.1.1. Body Parameter

Name

Description

Required

Default

Pattern

VerifyTokenRequestDto

Section 2.262

1.19.2.2. Return Type

Section 2.89

1.19.2.3. Content Type

application/json

1.19.2.4. Responses

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

1.20. RaCertificate

1.20.1. createBatchRaCertificateForUsers

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

Create Batch Ra Certificates for a User

1.20.1.1. Parameters

1.20.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreateRaCertBatchRequestDto

Section 2.74

1.20.1.2. Return Type

Section 2.263

1.20.1.3. Content Type

application/json

1.20.1.4. Responses

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

1.20.2. createRaCertificateForSingleUser

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

Create/renew Ra Certificate for a single User

1.20.2.1. Parameters

1.20.2.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose Ra Certificate we are creating

null

1.20.2.1.2. Body Parameter

Name

Description

Required

Default

Pattern

CreateSingleRaCertRequestDto

Section 2.77

1.20.2.2. Return Type

Section 2.251

1.20.2.3. Content Type

application/json

1.20.2.4. Responses

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

1.20.3. downloadRaCertCrl

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

Download the Ra Certificate of a User

1.20.3.1. Parameters

1.20.3.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose Ra Certificate CRL we are downloading

null

1.20.3.2. Return Type

Section 2.78

1.20.3.3. Content Type

application/json

1.20.3.4. Responses

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

1.20.4. downloadUserRaCertificate

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

Download the Ra Certificate of a User

1.20.4.1. Parameters

1.20.4.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose Ra Certificate we are downloading

null

1.20.4.2. Return Type

Section 2.197

1.20.4.3. Content Type

application/json

1.20.4.4. Responses

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

1.20.5. downloadUserRaCertificateChain

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

Download the Certificate Chain of a User

1.20.5.1. Parameters

1.20.5.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose Certificate Chain we are downloading

null

1.20.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

casFirst

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

null

1.20.5.2. Return Type

Section 2.197

1.20.5.3. Content Type

application/json

1.20.5.4. Responses

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

1.20.6. getRaOcspStatus

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

Get the Ra OCSP Status of a User

1.20.6.1. Parameters

1.20.6.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose OCSP Status we are getting

null

1.20.6.2. Return Type

Section 2.187

1.20.6.3. Content Type

application/json

1.20.6.4. Responses

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

1.20.7. getUserRaCertificate

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

Find a specific User’s Ra Certificate

1.20.7.1. Parameters

1.20.7.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose Ra Certificate we are searching for

null

1.20.7.2. Return Type

Section 2.161

1.20.7.3. Content Type

application/json

1.20.7.4. Responses

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

1.20.8. retrieveRaCertificateP12

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

Retrieve the Ra PKCS12 Certificate of a User

1.20.8.1. Parameters

1.20.8.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose Ra PKCS12 Certificate we are retrieving

null

1.20.8.2. Return Type

Section 2.178

1.20.8.3. Content Type

application/json

1.20.8.4. Responses

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

1.20.9. revokeRaCertificate

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

Revoke the Ra Certificate of a User

1.20.9.1. Parameters

1.20.9.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User whose Ra Certificate we are revoking

null

1.20.9.1.2. Query Parameters

Name

Description

Required

Default

Pattern

revReason

The reason of the Revocation request

null

1.20.9.2. Return Type

Section 2.209

1.20.9.3. Content Type

application/json

1.20.9.4. Responses

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

1.21. Realm

1.21.1. createNewRealm

POST /api/v1/realms/

Create a Realm

1.21.1.1. Parameters

1.21.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreateRealmRequestDto

Section 2.75

1.21.1.2. Return Type

Section 2.76

1.21.1.3. Content Type

application/json

1.21.1.4. Responses

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

1.21.2. getAuthorizedUsers

GET /api/v1/realms/{id}/authorized-users

Get authorized users

1.21.2.1. Parameters

1.21.2.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the Realm that will be used to fetch authorized users

null

1.21.2.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.21.2.2. Return Type

Section 2.184

1.21.2.3. Content Type

application/json

1.21.2.4. Responses

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

1.21.3. getRealm

GET /api/v1/realms/{id}

Find Realm

1.21.3.1. Parameters

1.21.3.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the Realm that requesting to be found

null

1.21.3.2. Return Type

Section 2.163

1.21.3.3. Content Type

application/json

1.21.3.4. Responses

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

1.21.4. getRealms

GET /api/v1/realms/

Find Realms

1.21.4.1. Parameters

1.21.4.1.1. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.21.4.2. Return Type

Section 2.164

1.21.4.3. Content Type

application/json

1.21.4.4. Responses

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

1.21.5. search

POST /api/v1/realms/search

Search Realms

1.21.5.1. Parameters

1.21.5.1.1. Body Parameter

Name

Description

Required

Default

Pattern

RealmSearchRequestDto

Section 2.201

1.21.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.21.5.2. Return Type

Section 2.164

1.21.5.3. Content Type

application/json

1.21.5.4. Responses

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

1.21.6. updateRealm

PATCH /api/v1/realms/{id}

Update a Realm

1.21.6.1. Parameters

1.21.6.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the Realm that will be updated

null

1.21.6.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateRealmRequestDto

Section 2.247

1.21.6.2. Return Type

Section 2.248

1.21.6.3. Content Type

application/json

1.21.6.4. Responses

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

1.22. Scep

1.22.1. decryptData

POST /api/v1/scep/decrypt

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

1.22.1.1. Parameters

1.22.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

ScepDecryptDataRequestDto

Section 2.212

1.22.1.2. Return Type

Section 2.213

1.22.1.3. Content Type

application/json

1.22.1.4. Responses

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

1.22.2. signDataScep

POST /api/v1/scep/sign

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

1.22.2.1. Parameters

1.22.2.1.1. Body Parameter

Name

Description

Required

Default

Pattern

ScepSignRequestDto

Section 2.215

1.22.2.2. Return Type

Section 2.214

1.22.2.3. Content Type

application/json

1.22.2.4. Responses

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

1.23. Sign

1.23.1. signDataWithCA

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

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

1.23.1.1. Parameters

1.23.1.1.1. Body Parameter

Name

Description

Required

Default

Pattern

SignDataRequestDto

Section 2.222

1.23.1.2. Return Type

Section 2.223

1.23.1.3. Content Type

application/json

1.23.1.4. Responses

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

1.24. User

1.24.1. editPasswordLoginRoleToUser

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

Set or unset disable_password_login Role to User

1.24.1.1. Parameters

1.24.1.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User

null

1.24.1.1.2. Query Parameters

Name

Description

Required

Default

Pattern

enablePasswordLogin

null

1.24.1.2. Return Type

1.24.1.3. Content Type

application/json

1.24.1.4. Responses

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

1.24.2. findUserByRaCertificate

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

Find User by the RA Certificate

1.24.2.1. Parameters

1.24.2.1.1. Body Parameter

Name

Description

Required

Default

Pattern

FindUserByRaCertificateRequestDto

Section 2.112

1.24.2.2. Return Type

1.24.2.3. Content Type

application/json

1.24.2.4. Responses

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

1.24.3. getUser

GET /api/v1/users/{id}

Find User

1.24.3.1. Parameters

1.24.3.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of the User to be searched

null

1.24.3.2. Return Type

1.24.3.3. Content Type

application/json

1.24.3.4. Responses

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

1.24.4. registerUser

POST /api/v1/users/

1.24.4.1. Parameters

1.24.4.1.1. Body Parameter

Name

Description

Required

Default

Pattern

CreateNewUserDetailsDto

Section 2.69

1.24.4.2. Return Type

1.24.4.3. Content Type

application/json

1.24.4.4. Responses

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

1.24.5. searchUsers

POST /api/v1/users/search

Search Users

1.24.5.1. Parameters

1.24.5.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UserSearchRequestDto

Section 2.256

1.24.5.1.2. Query Parameters

Name

Description

Required

Default

Pattern

page

Zero-based page index (0..N)

size

The size of the page to be returned

sort

Sorting criteria in the format: property,(asc

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

null

1.24.5.2. Return Type

Section 2.253

1.24.5.3. Content Type

application/json

1.24.5.4. Responses

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

1.24.6. sendUpdatePasswordEmailBatch

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

Send Batch update password E-Mails

1.24.6.1. Parameters

1.24.6.1.1. Body Parameter

Name

Description

Required

Default

Pattern

UserListDto

Section 2.254

1.24.6.2. Return Type

1.24.6.3. Content Type

application/json

1.24.6.4. Responses

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

1.24.7. setUserCertificateDetails

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

Set a user’s Certificate Details

1.24.7.1. Parameters

1.24.7.1.1. Path Parameters

Name

Description

Required

Default

Pattern

Id of User whose details will be set

null

1.24.7.1.2. Body Parameter

Name

Description

Required

Default

Pattern

UpdateUserCertificateDetailsRequestDto

Section 2.249

1.24.7.2. Return Type