These are the services used for certificate enrollment, deletion, update and listing operations.

1. Get All Certificates

Description/Purpose: The credentials in the project whose name is sent as a parameter are listed. If “admin” is sent as the project name, all credentials are listed, if the project name is sent, only the credentials defined in the project are listed.

Authorization: In order to access the services, the user who wants to access the services must have a role in the project with “Manage API Security ‘ or generally ’Admin” authorization.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/

HTTP Method: GET

Request Headers:

Header	Value
Authorization	<ACCESS_TOKEN> Token is required to access this endpoint. For detailed information on how to get a token, you can visit the Authorization API page
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Full name of the project to be queried

Request Body: (none)

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "name": "test certificate", "certificateEnvironmentList": [ { "environmentName": "test", "startDate": "2023-04-04T12:20:26Z", "endDate": "2023-07-03T12:20:26Z", "base64EncodedContent": "<base64 encoded pem content>", "sha1Thumbprint": "6f5729a656f6e311954753839361da4992ff864a", "subjectDn": "CN=user, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown", "alias": "user" } ] } ], "resultCount": 1 }
Fault	400	bad request	{ "error": "...", "error_description": "..." }
Fault	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Fault	500	internal error	{ "error": "...", "error_description": "..." }

2. Create Certificate

Description/Purpose: A new certificate is created in the project whose name is sent as a parameter. If “admin” is sent as the project name, the certificate is defined globally.

Authorization: In order to access the services, the user who wants to access the services must have a role in the project with “Manage API Security ‘ or generally ’Admin” authorization.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/

HTTP Method: POST

Request Headers:

Header	Value
Authorization	<ACCESS_TOKEN> Token acquisition is required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Content-Type	multipart/form-data
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Full name of the project where the certificate is located

Request Body: (none)

Request Form Parametreleri:

Parametre	Tip	Zorunluluk	Açıklama
certificateName	string	Required	Unique name for the certificate
alias	string	Required	Alias to use for the certificate
certificateDescription	string	Optional	Description of the certificate
deploy	boolean	Required	Whether the certificate will be deployed immediately
environmentList	string	Conditional	This field is mandatory if deploy option is true, comma separated environment list (ex: test,prod)
pemEncodedFile	file	Required	Certificate file in PEM format

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS", }
Fault	400	bad request	{ "error": "...", "error_description": "..." }
Fault	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Fault	500	internal error	{ "error": "...", "error_description": "..." }

3. Update Certificate

Description/Purpose: It is provided to update the existing certificate in the project whose name is sent as a parameter. If “admin” is sent as the project name, the certificate is updated globally.

Authorization: In order to access the services, the user who wants to access the services must have a role in the project with “Manage API Security ‘ or generally ’Admin” authorization.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: PUT

Request Headers:

Header	Value
Authorization	<ACCESS_TOKEN> Token acquisition is required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Content-Type	multipart/form-data
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Full name of the project where the certificate is located
certificateName	Full name of the certificate to be updated

Request Body: (none)

Request Form Parametreleri:

Parametre	Tip	Zorunluluk	Açıklama
certificateName	string	Required	Unique name for the certificate
alias	string	Required	Alias to use for the certificate
certificateDescription	string	Optional	Description of the certificate
deploy	boolean	Required	Whether the certificate will be deployed immediately
environmentList	string	Conditional	This field is mandatory if deploy option is true, comma separated environment list (ex: test,prod)
pemEncodedFile	file	Required	Certificate file in PEM format

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS", }
Fault	400	bad request	{ "error": "...", "error_description": "..." }
Fault	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Fault	500	internal error	{ "error": "...", "error_description": "..." }

4. Delete Certificate

Description/Purpose: It is ensured that the certificate existing in the project whose name is sent as a parameter is deleted. If “admin” is sent as the project name, the certificate will be deleted from global.

Authorization: In order to access the services, the user who wants to access the services must have a role in the project with “Manage API Security ‘ or generally ’Admin” authorization.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: DELETE

Request Headers:

Header	Value
Authorization	<ACCESS_TOKEN> Token acquisition is required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Full name of the project where the certificate is located
certificateName	Full name of the certificate to be updated

Request Body: (none)

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS", }
Fault	400	bad request	{ "error": "...", "error_description": "..." }
Fault	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Fault	500	internal error	{ "error": "...", "error_description": "..." }

5. Get an existing Certificate

Description/Purpose: It is provided to retrieve the information of the certificate available in the project whose name is sent as a parameter. If “admin” is sent as the project name, the certificate is retrieved from global.

Authorization: In order to access the services, the user who wants to access the services must have a role in the project with “Manage API Security ‘ or generally ’Admin” authorization.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: GET

Request Headers:

Header	Value
Authorization	<ACCESS_TOKEN> Token acquisition is required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Full name of the project where the certificate is located
certificateName	Full name of the certificate to be updated

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "name": "swagger sertificate", "description": "swagger sertificate description", "certificateEnvironmentList": [ { "environmentName": "test", "startDate": "2023-01-25T00:00:00Z", "endDate": "2024-02-24T23:59:59Z", "base64EncodedContent": " =", "sha1Thumbprint": "38138BE1D2E0DDC7B8C48F0C5E5F2767F527AEC7", "subjectDn": "CN=*.swagger.io", "alias": "alias123456789" } ] } ], "resultCount": 1 }
Fault	400	bad request	{ "error": "...", "error_description": "..." }
Fault	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Fault	500	internal error	{ "error": "...", "error_description": "..." }

6. Export an existing Certificate

Description/Purpose: The certificate available in the project whose name is sent as a parameter is exported. If “admin” is sent as the project name, the certificate is imported from global.

Authorization: In order to access the services, the user who wants to access the services must have a role in the project with “Manage API Security ‘ or generally ’Admin” authorization.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: GET

Request Headers:

Header	Value
Authorization	<ACCESS_TOKEN> Token acquisition is required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Full name of the project where the certificate is located
certificateName	Full name of the certificate to be updated

Response:

Status	Status Code	Description	Body
Success	200	successful operation	The file with .cer extension returns the zip file. It can be saved as a file and used by unzipping it.
Fault	400	bad request	{ "error": "...", "error_description": "..." }
Fault	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Fault	500	internal error	{ "error": "...", "error_description": "..." }

7. Get Certificates of Truststore of Environment

Description/Purpose: It is provided to return the information of all certificates used by Java in the environment whose name is sent as a parameter.

Authorization: In order to access the services, the user who wants to access the services must have a role in the project with “Manage API Security ‘ or generally ’Admin” authorization.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/admin/certificates/truststore/{environmentName}/

HTTP Method: GET

Request Headers:

Header	Value
Authorization	<ACCESS_TOKEN> Token acquisition is required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
environmentName	Truststore's environment

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "alias": "alias", "serialNumber": "3cda1dfa47300aa6ea2407fad25009c", "issuer": "CN=Amazon RSA 2048 M02,O=Amazon,C=US", "subject": "CN=.swagger.io", "validFrom": "2023-12-27T00:00:00Z", "validUntil": "2025-01-25T23:59:59Z", "publicKeyInfo": "Sun RSA public key, 2048 bits\n params: null\n modulus: \n public exponent: 65537", "subjectAlternativeNames": [ ".swagger.io" ], "signatureAlgorithm": "SHA256withRSA", "pathLengthConstraint": -1, "extendedKeyUsages": [ "1.3.6.1.5.5.7.3.1", "1.3.6.1.5.5.7.3.2" ], "subjectAlternativeNamesStr": "*.swagger.io", "extendedKeyUsagesStr": "1.3.6.1.5.5.7.3.1,1.3.6.1.5.5.7.3.2", "searchObject": true, "valid": true } , { "alias": "ou=go_daddy_class_2_certification_authority,o=the_go_daddy_group__inc.,c=us", "serialNumber": "0", "issuer": "OU=Go Daddy Class 2 Certification Authority,O=The Go Daddy Group\\, Inc.,C=US", "subject": "OU=Go Daddy Class 2 Certification Authority,O=The Go Daddy Group\\, Inc.,C=US", "validFrom": "2004-06-29T17:06:20Z", "validUntil": "2034-06-29T17:06:20Z", "publicKeyInfo": "Sun RSA public key, 2048 bits\n params: null\n modulus: \n public exponent: 3", "signatureAlgorithm": "SHA1withRSA", "pathLengthConstraint": 2147483647, "searchObject": true, "valid": true }, { "alias": "ou=security_communication_rootca2,o=secom_trust_systems_co._ltd.,c=jp", "serialNumber": "0", "issuer": "OU=Security Communication RootCA2,O=SECOM Trust Systems CO.\\,LTD.,C=JP", "subject": "OU=Security Communication RootCA2,O=SECOM Trust Systems CO.\\,LTD.,C=JP", "validFrom": "2009-05-29T05:00:39Z", "validUntil": "2029-05-29T05:00:39Z", "publicKeyInfo": "Sun RSA public key, 2048 bits\n params: null\n modulus: \n public exponent: 65537", "signatureAlgorithm": "SHA256withRSA", "pathLengthConstraint": 2147483647, "searchObject": true, "valid": true } , ... ], "resultCount": 153 }
Fault	400	bad request	{ "error": "...", "error_description": "..." }
Fault	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Fault	500	internal error	{ "error": "...", "error_description": "..." }