API Method - reinstate
reinstate
Purpose
Use the “reinstate” method for reinstating the suspended x509, p7b, pfx certificates based on the certificate serial number
Type of Method
POST
Request URL
http://example.com/emCAServices/rest/reinstate
Request Input Parameters
JSON Object Contains below parameters
Parameter | Presence | Data Type | Description |
signature | M |
String |
Certificate serial number has to be signed with PFX shared by us. Pass Signed certificate serial number i.e., PKCS#7 data. |
userName | M |
String |
You need to pass username that is registered with emCA for API process. |
password | M |
String |
You need to pass the password that is registered with emCA for API process. |
remarks | M |
String |
Pass your reason to reinstate certificate |
Sample JSON Object
Parameter | Presence | Data Type | Description |
requestData | M | String | All the request input parameters mentioned above should be converted to JSON object and encrypted with AES 256 key shared with you by the emCA team. Pass Encrypted JSON Object. |
userName | M | String | You need to pass username that is registered with emCA for API process. |
Header Details
Key | Presence | Value | Description |
Application / JSON | M | Content-Type | Type of request should be in JSON Format. |
Authentication Key | M | emKey | emKey is an encoded key (Refer section 4 for generating Authentication Key using command prompt). |
Sample Request Data
Process
When request is received by the emCA service, we will decrypt the request JSON Object with the same AES key that is shared with the client. After successful decryption, request JSON object (Signed serial number + Username + Password + remarks) is retrieved.
First the emCA service will validate username and password and check if the IP Address used for request and registered with the user are same.
If it is same then signed data (signature) is validated by checking whether serial number is signed by pfx which is registered for the specific user.
If validation fails at any point in processing the request, the emCA service will throw error /failure message.
Response Parameters
Parameter | Data Type | Description |
response |
String |
Returns JSON Object |
JSON Object Contains below parameters
Parameter | Data Type | Description |
status | String | Returns Status of the request as success if certificate revocation is successful. Returns status of the request as failure if authentication fails or unregistered user tries to call the API. |
result | String | Returns In case of success: “Certificate reinstated successfully” message will be displayed. In case of failure: error message will be displayed. |
subscriberId | String |
Returns Subscriber Id. |
requestId | String |
Returns Request ID null. |
Response JSON Format
Error Messages
Error Message | Description |
Invalid Request | If the user certificate has already been reinstated or if there is no certificate available for the requested certificate serial number. |
Signature verification failed | If signature parameter (certificate serial number) contains invalid certificate serial number. |
Last updated