API Method -getCertificateProfileList

Purpose

Use the “getCertificateProfileList” method for getting Certificate Profile lists by using the Issuing CA name.

Type of Method

POST

Request URL

http://www.example.com/emCAServices/rest/getCertificateProfileList

Request Input Parameters

Parameter	Presence	Data Type	Description
signature	M	string	Pass Signed data you want to validate or verify. Signed Data will be CAName
userName	M	String	Pass Username that is registered with emCA for API process.
password	M	String	Pass the password that is registered with emCA for API process.

Sample JSON Object

requestData
{
"signature" :
"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABIGLQ049
dGh1bGFzaSxTRVJJQUxOVU1CRVI9QVZBUEc0MjAxQSxFPXRodWxhc2kuZ0BlbXVkaHJhLmNvbSxPPWVtd WRocmEsUz1LQSxDPUlOLFBvc3RhbENvZGU9NTYwMTAzLEtleUFsb2dpcnRobUFuZFNpemU9UlNBLTEwMj QsUGFzc3dvcmQ9MTIzNAAAAAAAAKCAMIIDpjCCAo6gAwIBAgIDTEtBMA0GCSqGSIb3DQEBCwUAMHQxJTA
jBgNVBAMMHENlcnRpZmljYXRlTWFuYWdlciBSb290IDIwMTYxGDAWBgNVBAoMD2VNdWRocmEgTGltaXRl ZDEQMA4GA1UECwwHZW11ZGhyYTESMBAGA1UECAwJQmFuZ2Fsb3JlMQswCQYDVQQGEwJJTjAeFw0xODA1M DMwNTUyNDNaFw0yMDA1MDIwNTUyNDNaMCgxFzAVBgNVBA8MDkF1dGhlbnRpY2F0aW9uMQ0wCwYDVQQDDA
RyYWNhMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAm4k/r47G8+eRm/zftRSwxg8koTXLEHG JF5MKJZjUsPweASFbxxcj1RwixCHaAP75n3u0JCOFBuOVDMlPMu47j9w+x6jig3IMdVhPo6/rU7Z75Gtw FQDvhLZhoz2VMrSThfjvhaYEiOYy4uhC7sXOVedCw3rFylFtbljgwgnPC6Rp75TesIKj1l+9dZY08OxyI CNUNluztcMOXDqk68rtzbZfPvtfH4msDpyUoJL7XmBwbXF7UMiISlCiSvqpjYyBsu+tPxuOpgxlGbyJGm Wfi9D7Nzg4a8SBW6NrRWhtGASUj+/SaJpH0LI5wTrmMri8vJ2r2LHyi0zdpk+9S8u3vwIDAQABo4GMMIG JMAwGA1UdEwEB/wQCMAAwIgYDVR0jAQH/BBgwFoAUgrVRaCBCfAEiYlkr6rtaEbNDgsEwIAYDVR0OAQH/ BBYEFJ4vM/W+gFWsqBapUx9p7OSBQfDbMA4GA1UdDwEB/wQEAwIEsDAjBgNVHSUEHDAaBggrBgEFBQcDA QYIKwYBBQUHAwIGBFUdJQAwDQYJKoZIhvcNAQELBQADggEBAENZq6xWQGZE+cwOD0CigiZYQqDRBpeMW1
hhtlo7isiKWAlllAZ60aHZ2pMAO30VVwvifEjDv2QvCe+IA5d6x/SIBt0f/FypZj6T4vY6h6Hcaks7zI3 gozMCCuHBeBS/wA7LPwyxkxxFwUzDeJkLYfmkFQH6HN2OT3BqY3cA2Qon/NHRdCc5vvY9pbSR0j4y/2wX qzROIyYjXt3U2z/IL1pkDlmpDmYzbafdIlCJ6xyFOKNRoLp6QiGTZNs5UaVPnxMOvsh2sA1EirFFsRiDB J6ycrAjff9ls4oIc5gpgp7TArXbogFP1lw5j8nj50se46Bv0aQ0D4WdThCljcC6xQMAADGCAhEwggINAg EBMHswdDElMCMGA1UEAwwcQ2VydGlmaWNhdGVNYW5hZ2VyIFJvb3QgMjAxNjEYMBYGA1UECgwPZU11ZGh yYSBMaW1pdGVkMRAwDgYDVQQLDAdlbXVkaHJhMRIwEAYDVQQIDAlCYW5nYWxvcmUxCzAJBgNVBAYTAklO AgNMS0EwDQYJYIZIAWUDBAIBBQCgaTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJB TEPFw0xODA4MDgxMDU3NDFaMC8GCSqGSIb3DQEJBDEiBCCRCU2QQn8vWt9lA+SkB/8weIKlUaHaSgmDqE
4GCgQZ0TANBgkqhkiG9w0BAQEFAASCAQAIjlSTHf+7EXSUuFV7S57vDdYyu5AhE5iJ2dJl03zo/Bc62yM RgWGPpLSTFBjo8102VQIACxfudcCNoV1pfPkTxTyhe/rMv/VnWaMcLLrJZ0JRu7WZgrfHkBZ7p1eIv6LR t/nja93Fuc2M8Jl8B00DeQDNkyjnIN3gVS+0Hr8/ZIfClYa3huxfm8h1PeQHupaZ53UZKONLe7rRVVJGI A2IZwRkXcxk/2Z47qw1hUFvtXokQBbqOj1rDhL3Dh6pOsU9XbXTKGXzmcs0I6RXSB3DHbwQtsPK7neEyJ BbxS0IpiKxY7IZtF2+m+WXmjWQyg7ZIYK0/X96XkYA7W7rcEPjAAAAAAAA",
"userName" : "username", "password" : "password "
}

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

Header:
 
Request Body:


Content-Type : application/json
emKey                    : 47b54594063957de22fce0aeddd51a6adf4a80aa
 
 
{


"requestData" : "DcojYlq57vrFInQ3TypNPKWGZiQ4GXBcIpEaW1hkQxe0qHi5AvBMKnz97dpVOEezet5CoX1UPugOXu2 5w4fqyPKOhnBLkhrg0SDPEJLvGHia+6YlOQe1n3gU8CdWmsLEqhTtdo9EB0R/9xJnd9m/DAmrYx61ChZ YTvlbWu7ZLS7KLukBRNA2zrDtbxEHuArWaMtKPvoqWkQCEZP0srNCGIBq3eChdmHpGgTcVm7QMlFgskX 3gRdm95QfYv3NOYOZrNSORkT3hooVdOu+uL2dj1Re5LsZPJLXYN0cMPsiUG4yHP4ZbE3Bbn1dAb3nbW+ Xr7i+kwmYQ+iObuN/oAX7qjWkxY8GxxmtUBglWBRmsgoGCLQgfy1T9O7uwsxAuxJYzEWvt/8iY8frepI 4KpRUNvYnue1heFiCl4D0MtJ5536XzIauUarxZx3aOT8c0IANqoalnUVooaf8FE1pjQTulHYqozjy03g pDTkN8xUSbhqaCiKJR9cyhtVH9q1HHOsY8sQC0U/VDZRKbF3uL2bpFJ6ZaC6ydtCxxasCM7zzRVP2m1g ng2/aG/WZpb50Kdh6Oji5K0ht+qXjPSu2O3K3s/ffjaM8ZITDDDyloyiIzsLCZMc8QemT4AsZeupblYs sT+GGx8rtn4pht53aqDpC31KNUj8eOkt3s1QPEORRbyYZrEMuJYrJLuEyf8m8CeC25xc1M5wmW5JuKYQ 2XXdAkhAspjt0CmYnd0iRuHj8BXVYp+g3AUPTq99vrv9h4kvtAZAubWoBVdHWfBxW85ifa0gEneJdd+m pKXCfWera/KzofMU5b9zKYHYAdvbSxAsy0MneSc6MT74Lsw1wgbpGiP+bZXudRv8YHsT6mX5GoapSTUr 6koQMwGCJg1F+SgD4obM8UgAXzA7HDgbgmPqds9r877k2kViIcduzg2fHVrh06ewCUeAxzvxWuSl9/Mx 00fe3HV2j0+Pllwhmom69gi01QVFuNih4Sdj6ISb8+0VTze/14g+K0X1Qhl+nTbeZdlMu0HjQ01rrYf5
+PuARNLH4JPuoUWL4ce7oA3PHOzz94+0KZG4uKmPDiybhDRb/yfcmiaR6x9TqDQBe+QHZX1znuCAedPV FquZyhbtutFItz1+D2lwy0qDgUUApzcnERVjfExQ4tAbMO3I5eRBqT3kThJM00DnV3XFVSjSf8rBh88/ PNVvM4y3ez5B2ZFSLrf8VBT2UgRo/kAbMf2u5TRNV1Q99Hwq+RDsaSLWbQvCqL/2TKB2noAcbIvYve0a Moyzj5x9Zu+CvsSG0//bRe9unEIJcqMTs44vt06cDlwHYvUY9Z3HXvIrCJThJE1WZyaxksBGHbTEE5KD ph8l//vhvwM04EEBouuecMGhSHPOCKG0Wrbvx6mJotdhtsPpia/uWsrFrNt50ToqW424X00dIX91VyN7 esgSBnzVyNGPvvQiNhIyY1LnGGiGR1SpQ1svbAywXTzJrm+mfYYk5+Su2iF5y/DUJxIfiP/PaIEb8/iw peKuEARfoX3oNSxELrV+xll6C5SJw1PWct//wJtfa0hs5SnMHedduKwvYgOYXDqjz/HFFjbl+pHZCyMY ZAWArG+2tjNttxunChueq2AUa/IqLf5qkWcpMvwmNd50yCQeXaHlLcIIs6z+h34gYOuLjOA0SzB/wTIk 5JXL0B9O/lRMaYHcFLLwigxmFqXPAxUz00mzBLG2ndji9jpobgD8wAHASb2G0ehYhkchjwfv0jD/JSlI hCehaFG9spHXMt2p5CKlum5FLgRxyfm6FQ6lsXORzkRRYjN8fm6XWe7A/XTDAZvePWztRDK/HpnMMh3p NHGpiSz/Po11oD/+Rt//taQABrFTAW4daQLwK+COE6yELkl9WT9h14LMFLTWxXJUo67PpefJWz32CUzQ GBg8qMCMmy2rXLQto+UiAOVyExBhgVfY0VwdXSZaU7DsmpQTs2tSxwm1J8MDREIhMdFc0OAFTHDK8yEh qDqqABv8KVmiLyuP95rO+9NTvU+FQY00dmf+f3Yz4nThSAQe5QdA+BsiKpxzZ5qoCOlIU+0/AD+WsAOc CnCxNIW+dKQAB2Ows1i4vGwaHnlyXPkTRXhRDGdpFlNLgUA8z9QdQbTWZXII9o54JLNBQE4cIB6wYCu2 0Fd0eCtGoAYbTtuccT80zLIsMovtvZ/yEtUObQzCgnng5xgbV3nGHUozsrgjpHy9aRp+YpTdtLS3oCMR T4Oe8Q8PsJfkU5B6FL3j8RWjYEOduyxuze7e/cD9OtpDgh4dVHz3YqBJsU4TbbZuy4pFOHb48i/5bBZA ciFQ7lHGHAKG05qIuV0g93K9GDM+pLsWTm0bcWhRXAWGQdYkpBtwWeYR+7n8SWNhcH0dd8hDG+CuF0Jw YFnRlneo724DnPGsKG2ryUh2uTjO1pMipI7fpOX+S6/OjJAN1rQWbSj1JH499dSdG/t1PdEyMq4QWdQi kd6IlmtcabGnqvqYAGB5Au4Fawqp5WjfG2FpUfq7sg0jtbq9Mosb5dVoEDUA1Xoy2dK+6/vbNa5Ubh9D iPTojliN6lIKkZKxo3vthTrAM5eBo55NmtDP486Q5VVyZfbLbnlvu5i4GF7b9zDMfDYsr2wH3Syhexo2 Emf03mq9o58vIL9mOxCP7nARy90YpKyKFX+bJI6SCTtl5zRl9A587BMoum7oQVK1SR597fhaEhwtYp3P iDe3zOw80463KvfxLAoxIKjfXqP6fG8f1nKTAYFRl6CEHFhdBIZKoawJeb8n/y0TZyuJBx5lFxtuJrVJ NRlM7qVnniUjoumOmU9Fry62KQtkAUnt0hMP8Zc02fmbXH19tVVVnVsuVOhs++IsZ1jnsnp989jDZ77p BMF/8kG6cZhIRgCl2BIsVASyK3CAykbQP0ddM8dtppCxNWnECOG0dCjqWr95eDghJv2QBJKJ+zoKQRhi PZh8hhA=="
"userName":"username"
}

Process

• When request is received by emCA service, request JSON Object will be decrypted with same AES key that is shared to the client.

• After successful decryption, request JSON object (Username + Password+ Signature (CA Name)) is retrieved.

• First emCA service will validate username and password and check if the IP Address used for request and registered with the user are same.If request is registered with same user, then the system checks if any user profiles are associated with the requested CA.

1. If user profiles are available with requested CA name, the result will be displayed in the list of profiles.

• If validation fails at any point in processing the request, the emCA service will throw error/failure message. (Refer error messages section)

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 requested CA Name is valid. 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‟: User profile details will be displayed In case of “Failure‟: Error message will be displayed.
subscriberId	String	Returns Subscriber Id
requestId	String	null

Response JSON Format

Sample:
Success:
Response Body
{
"status":"success", "result":"/ProfileName:XXX, ProfileId:XX/,” “subscriberId”:”XXX”
"requestId": null,
}
Failure:
{
"status":"failure", "result":"<Error message>" “subscriberId”:null "requestId": null,
}

Error Messages

Error Message	Description
No certificate is available for CAname: <CAname>"	If the given CA name is invalid
Signature verification failed	If signature parameter (CSR) is not signed by the pfx shared by eMudhra