API Method - suspend
Last updated
Last updated
Use the “suspend” method for revoking the x509 certificate based on the certificate serial number.
POST
http://www.example.com/emCAServices/rest/suspend
JSON Object Contains below parameters
When the request is received by the emCA service, we will decrypt the request JSON Object with same AES key that is shared with the client.
After successful decryption, request JSON object (Signed serial number + Username + Password + revokeMode + 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 the 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.
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.
revokeMode
M
Integer
6
remarks
M
String
Pass your reason for suspension of certificate.
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.
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).
Parameter
Data Type
Description
response
String
Returns JSON Object
Parameter
Data Type
Description
status
String
Returns Status of the request as success if certificate suspension 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: “Suspended Successfully”
message will be displayed.
In case of failure: error message will be displayed.
subscriberId
String
Returns Subscriber Id.
requestI
String
Return Request ID null.
Error Message
Description
CRL does not exist
If CRL is not created for Issuer certificate
Certificate already suspended
If user certificate is already suspended
Signature verification failed
If signature parameter (certificate serial number) contains invalid certificate serial number
No Data Found For <serial number>
If no certificate is available for requested certificate serial number