{"info":{"_postman_id":"ce991e09-aadb-492c-a52c-1831292edf25","name":"emCA REST API V4.2.7","description":"

emCA provides an open API (Application Programming Interface) for integrating signature modules with third party applications, portals, or websites, and to customize as per your needs. With the emCA REST API, you can extract Recruit data in JSON format and develop new applications or integrate with your existing business applications. As the emCA API is independent of programming languages, you can develop applications in any programming language (Java, .Net etc.).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"40123569","collectionId":"ce991e09-aadb-492c-a52c-1831292edf25","publishedId":"2sB34imfqi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-07-18T06:01:36.000Z"},"item":[{"name":"CA Management","item":[{"name":"createCA","id":"ec2f7411-9d0f-47eb-80f7-b5e49f3bf7d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"certificateRequestDetails\": {\r\n \"caType\": \"subCA\",\r\n \"parentCAID\": \"3\",\r\n \"validityCriteria\": \"d\",\r\n \"validityValue\": \"3000\",\r\n \"keyAlgorithm\": \"RSA2048\",\r\n \"signingAlgorithm\": \"SHA256WithRSA\",\r\n \"caSubjectAttributes\": [\r\n {\r\n \"dataType\": \"PrintableString\",\r\n \"oid\": \"2.5.4.3\",\r\n \"value\": \"SUB TEST 2024\"\r\n }\r\n ],\r\n \"caExtensions\": {\r\n \"basicConstraints\": {\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"1\",\r\n \"type\": \"CA\",\r\n \"pathLength\": \"0\",\r\n \"sortOrder\": \"2\"\r\n },\r\n \"authInfoAccess\": {\r\n \"isEnabled\": \"0\",\r\n \"isCritical\": \"0\",\r\n \"ocspURL\": \"\",\r\n \"crtURL\": \"\",\r\n \"sortOrder\": \"1\"\r\n },\r\n \"crlDistribution\": {\r\n \"isEnabled\": \"0\",\r\n \"isCritical\": \"0\",\r\n \"crlURL\": \"http://www.example.com/repository/crls/test.crl\",\r\n \"sortOrder\": \"4\"\r\n },\r\n \"keyUsageAttributes\": {\r\n \"encipherOnly\": \"0\",\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"1\",\r\n \"nonRepudiation\": \"0\",\r\n \"digitalSignature\": \"0\",\r\n \"keyEncipherment\": \"0\",\r\n \"dataEncipherment\": \"0\",\r\n \"keyAgreement\": \"0\",\r\n \"keyCertSign\": \"1\",\r\n \"crlSign\": \"1\",\r\n \"decipherOnly\": \"0\",\r\n \"sortOrder\": \"5\"\r\n },\r\n \"extendedKeyUsageAttributes\": {\r\n \"isEnabled\": \"0\",\r\n \"isCritical\": \"0\",\r\n \"serverAuthentication\": \"0\",\r\n \"clientAuthentication\": \"0\",\r\n \"codeSigning\": \"0\",\r\n \"emailProtection\": \"0\",\r\n \"timeStamping\": \"0\",\r\n \"ocspSigning\": \"0\",\r\n \"msftDocumentSigning\": \"0\",\r\n \"smartCardLogon\": \"0\",\r\n \"adobeCertifiedDocumentSigning\": \"0\",\r\n \"encryptionFileSystem\": \"0\",\r\n \"sortOrder\": \"6\"\r\n },\r\n \"subjectKeyIdentifier\": {\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"0\",\r\n \"sortOrder\": \"7\"\r\n },\r\n \"authorityKeyIdentifier\": {\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"0\",\r\n \"sortOrder\": \"8\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/create/ca","description":"

Purpose

The \"createCA\" API is used to generate a Certificate Authority (CA) certificate based on the provided input parameters. This API can generate both self-signed CA certificates and sub CA certificates by specifying the parent CA ID. The generated CA certificate is returned in base64 encoded X509 format.

Request Input Parameters

* - Mandatory parameter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
meta*	JSON	The meta parameter is a required JSON object that contains external user details necessary for processing the request. please refer table Meta Object Fields from above ex:- { \"ver\": \"1.0\", \"ts\": \"2024-01-01T11:40:15+05:30\", \"txn\": \"347328314273\", \"appCode\": \"TestApp\", \"authKey\": \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\" }
certificateRequestDetails*	JSON	The certificateRequestDetails parameter is a required JSON object that contains specific details about the certificate to be generated. refer Table no 1

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
caType*	String	Specifies the type of CA certificate being generated. Possible values include \"root\" for a self-signed root CA certificate and \"subCA\" for a sub CA certificate. ex:- \"root\" or \"subCA\"
parentCAID	String	The ID of the parent CA. Required if generating a sub CA certificate. ex:- \"2\", \"5\"
validityCriteria*	String	validityCriteria (String, required): The criteria for the certificate's validity (e.g., \"days\", \"months\", \"years\"). ex:- \"days\"
validityValue*	String	validityValue : The value corresponding to the validity criteria (e.g., 365 for 365 days). ex:-\"365\"
keyAlgorithm*	String	The key algorithm and size used to generate the key. refer Table no 2 for supported algorithm below for more info. ex:- \"RSA2048\"
signingAlgorithm*	String	The algorithm used to sign the certificate. refer Table no 2 for supported algorithm below for more info. ex:- \"SHA256WithRSA\"
keyProfile	String	This is created from emCA by the administrator and specifies the key profile name, indicating whether keys are created for a particular device such as HSM or PKCS12. Ex:- \"HSMProfile\"
caSubjectAttributes*	ArrayList of Object	caSubjectAttributes (Array, required): An array of objects containing the subject attributes of the CA certificate. Each object includes: dataType (String, required): The data type of the attribute (e.g., \"PrintableString\"). oid (String, required): The Object Identifier (OID) for the attribute. value (String, required): The value of the attribute. ex:- [ { \"dataType\": \"PrintableString\", \"oid\": \"2.5.4.3\", \"value\": \"common name\" }, \"dataType\": \"Utif8String\", \"oid\": \"2.5.4.6\", \"value\": \"IN\" } ]
caExtensions*	JSON	caExtensions (Object, optional): A JSON object containing additional X509 extensions for the certificate such as keyUsage, authInfoAccess, certificatePolicy etc refer Table no 3 ex:- \"basicConstraints\": { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"type\": \"root\", \"pathLength\": \"none\", \"sortOrder\": \"2\" }, \"authInfoAccess\": { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"ocspURL\": \"http://example.com/ocsp\", \"cAIssuerURL\": \"http://example.com/ca/testca.cer\", \"sortOrder\": \"1\" }

Table no 2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type of Key algorithm	Supported key algorithm and Sizes
RSA	RSA1024, RSA2048, RSA3072, RSA4096, and RSA8192
ECDSA secp	ECC256, ECC384 and ECC521
ECDSA Brainpool	B-ECDSA-256, B-ECDSA-384 and B-ECDSA-512
ECDSA Prime	P-ECDSA-256, P-ECDSA-384 and P-ECDSA-521
EDDSA	Ed25519
PQC	DILITHIUM2, DILITHIUM3, DILITHIUM5, FALCON-512, FALCON-1024, sha2_256f, sha2_256s, sha2_128f, sha2_128s, sha2_192f, sha2_192s, shake_128f, shake_128s, shake_192f, hake_192s, shake_256f, shake_256s, haraka_192f, haraka_192s, haraka_256f, haraka_256s and haraka_128f

Table no 3

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
basicConstraints*	JSON	basicConstraints: Specifies whether the certificate is a CA certificate and its criticality, including type and path length constraints. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the basic constraints extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the basic constraints extension is critical (\"1\" for enabled, \"0\" for disabled). type (String, required): Specifies the type of CA (e.g., \"root\", \"subCA\"). pathLength (String, required): Specifies the maximum depth of valid certification paths that include this certificate. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"type\": \"root\", \"pathLength\": \"none\", \"sortOrder\": \"2\" }
authInfoAccess		authInfoAccess: Contains URLs for OCSP responder and CA issuer, providing authority information access. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the authority information access extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the authority information access extension is critical (\"1\" for enabled, \"0\" for disabled). ocspURL (String, required): URL of the OCSP responder. cAIssuerURL (String, required): URL of the CA issuer certificate. sortOrder (String, required): Specifies the order in which this extension is processed. { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"ocspURL\": \"http://example.com/ocsp\", \"cAIssuerURL\": \"http://example.com/ca/testca.cer\", \"sortOrder\": \"1\" }
certificatePolicy	JSON	certificatePolicy: Defines policies under which the certificate was issued, including policy OIDs and CPS URLs. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the certificate policy extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the certificate policy extension is critical (\"1\" for enabled, \"0\" for disabled). policyOID (Array, required): An array of objects defining policy OIDs and optional user notice texts. oid (String, required): The Object Identifier for the policy. noticeText (String, required): Optional text notice for the policy. cpsURL (String, required): URL of the Certification Practice Statement. cpsPolicyOID (String, required): OID for the CPS policy. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"policyOID\": [ { \"oid\": \"1.3.24.33.34.34\", \"noticeText\": \"User Notice\" } ], \"cpsURL\": \"http://www.example.com/repository/cps/test.pdf\", \"cpsPolicyOID\": \"2.16.356.100.1.8.2\", \"sortOrder\": \"3\" }
crlDistribution		crlDistribution: Provides URLs where the CRL (Certificate Revocation List) can be accessed. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the CRL distribution points extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the CRL distribution points extension is critical (\"1\" for enabled, \"0\" for disabled). crlURL (String, required): URL of the CRL. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"crlURL\": \"http://www.example.com/repository/crls/test.crl\", \"sortOrder\": \"4\" }
keyUsageAttributes*	JSON	keyUsageAttributes: Defines the purpose of the key contained in the certificate, such as signing or enciphering. this parameter is a required JSON object that contains specific details. isEnabled (String, required): Indicates if the key usage extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the key usage extension is critical (\"1\" for enabled, \"0\" for disabled). encipherOnly (String, required): Indicates if the key is used for enciphering only. nonRepudiation (String, required): Indicates if the key is used for non-repudiation. digitalSignature (String, required): Indicates if the key is used for digital signatures. keyEncipherment (String, required): Indicates if the key is used for key encipherment. dataEncipherment (String, required): Indicates if the key is used for data encipherment. keyAgreement (String, required): Indicates if the key is used for key agreement. keyCertSign (String, required): Indicates if the key is used for signing certificates. crlSign (String, required): Indicates if the key is used for signing CRLs. decipherOnly (String, required): Indicates if the key is used for deciphering only. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"encipherOnly\": \"0\", \"isCritical\": \"0\", \"nonRepudiation\": \"0\", \"digitalSignature\": \"0\", \"keyEncipherment\": \"0\", \"dataEncipherment\": \"0\", \"keyAgreement\": \"0\", \"keyCertSign\": \"0\", \"crlSign\": \"0\", \"decipherOnly\": \"0\", \"sortOrder\": \"5\" }
extendedKeyUsageAttributes		extendedKeyUsageAttributes: Specifies additional key usages for the certificate, such as server authentication or email protection. this parameter is a required JSON object that contains specific details. isEnabled (String, required): Indicates if the extended key usage extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the extended key usage extension is critical (\"1\" for enabled, \"0\" for disabled). serverAuthentication (String, required): Indicates if the key is used for server authentication. clientAuthentication (String, required): Indicates if the key is used for client authentication. codeSigning (String, required): Indicates if the key is used for code signing. emailProtection (String, required): Indicates if the key is used for email protection. timeStamping (String, required): Indicates if the key is used for timestamping. ocspSigning (String, required): Indicates if the key is used for OCSP signing. msftDocumentSigning (String, required): Indicates if the key is used for Microsoft document signing. smartCardLogon (String, required): Indicates if the key is used for smart card logon. adobeCertifiedDocumentSigning (String, required): Indicates if the key is used for Adobe certified document signing. encryptionFileSystem (String, required): Indicates if the key is used for the encryption file system. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"serverAuthentication\": \"0\", \"clientAuthentication\": \"0\", \"codeSigning\": \"0\", \"emailProtection\": \"0\", \"timeStamping\": \"0\", \"ocspSigning\": \"0\", \"msftDocumentSigning\": \"0\", \"smartCardLogon\": \"0\", \"adobeCertifiedDocumentSigning\": \"0\", \"encryptionFileSystem\": \"0\", \"sortOrder\": \"6\" }
subjectKeyIdentifier*		subjectKeyIdentifier: Provides a unique identifier for the certificate's public key. isEnabled (String, required): Indicates if the subject key identifier extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the subject key identifier extension is critical (\"1\" for enabled, \"0\" for disabled). sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"sortOrder\": \"6\" }
authorityKeyIdentifier*		authorityKeyIdentifier: Provides a unique identifier for the key used to sign the certificate. isEnabled (String, required): Indicates if the authority key identifier extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the authority key identifier extension is critical (\"1\" for enabled, \"0\" for disabled). sortOrder (String, required): Specifies the order in which this extension is processed. { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"sortOrder\": \"7\" }
sanDetails		sanDetails: Specifies the Subject Alternative Name (SAN) attributes, including types and values. isCritical (String, required): Indicates if the SAN extension is critical (\"1\" for enabled, \"0\" for disabled). isEnabled (String, required): Indicates if the SAN extension is enabled (\"1\" for enabled, \"0\" for disabled). sortOrder (String, required): Specifies the order in which this extension is processed. attributes (Array, required): An array of objects specifying SAN attributes, each containing: type (String, required): The type of SAN (e.g., \"rfc822Name\"). value (String, required): The value of the SAN attribute. isMandatory (String, required): Indicates if the SAN attribute is mandatory. ex:- { \"isCritical\": \"0\", \"isEnabled\": \"0\", \"sortOrder\": \"1\", \"attributes\": [ { \"type\": \"rfc822Name\", \"value\": \"test@test.com\", \"isMandatory\": \"0\" } ] }

","urlObject":{"protocol":"https","path":["emCAServices","rest","create","ca"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec2f7411-9d0f-47eb-80f7-b5e49f3bf7d2"},{"name":"createCSR","id":"19515aca-cb92-4904-ac46-2927203ef175","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"certificateRequestDetails\": {\r\n \"keyAlgorithm\": \"RSA2048\",\r\n \"signingAlgorithm\": \"SHA256WithRSA\",\r\n \"caSubjectAttributes\": [\r\n {\r\n \"dataType\": \"PrintableString\",\r\n \"oid\": \"2.5.4.3\",\r\n \"value\": \"TEST CSR CA1\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/create/csr","description":"

Purpose

The \"createCSR\" API is used to generate a Certificate Signing Request (CSR) for requesting a CA certificate to be signed by an issuing Certificate Authority (CA). The generated CSR includes necessary information about the certificate and is used to apply for a CA certificate from the issuing CA.

Request Input Parameters

* - Mandatory parameter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
meta*	JSON	The meta parameter is a required JSON object that contains external user details necessary for processing the request. please refer table Meta Object Fields from above ex:- { \"ver\": \"1.0\", \"ts\": \"2024-01-01T11:40:15+05:30\", \"txn\": \"347328314273\", \"appCode\": \"TestApp\", \"authKey\": \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\" }
certificateRequestDetails*	JSON	The certificateRequestDetails parameter is a required JSON object that contains specific details about the certificate to be generated. refer Table no 1

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
keyAlgorithm*	String	The key algorithm and size used to generate the key. refer Table no 2 for supported algorithm below for more info. ex:- \"RSA2048\", \"ECC256\"
signingAlgorithm*	String	The algorithm used to sign the certificate. refer Table no 2 for supported algorithm below for more info. ex:- \"SHA256WithRSA\"
keyProfile	String	This is created from emCA by the administrator and specifies the key profile name, indicating where keys are created for a particular device such as HSM or PKCS12. Ex:- \"HSMProfile\"
caSubjectAttributes*	ArrayList of Object	caSubjectAttributes (Array, required): An array of objects containing the subject attributes of the CA certificate. Each object includes: dataType (String, required): The data type of the attribute (e.g., \"PrintableString\"). oid (String, required): The Object Identifier (OID) for the attribute. value (String, required): The value of the attribute. ex:- [ { \"dataType\": \"PrintableString\", \"oid\": \"2.5.4.3\", \"value\": \"common name\" }, \"dataType\": \"Utif8String\", \"oid\": \"2.5.4.6\", \"value\": \"IN\" } ]
sanDetails	ArrayList of Object	sanDetails (Object, optional): A JSON object containing Subject Alternative Name (SAN) details: attributes (Array, required): An array of objects specifying SAN attributes. Each object includes: type (String, required): The type of SAN attribute, such as \"rfc822Name\". value (String, required): The value of the SAN attribute, such as \"test@test.com\". ex:- { \"attributes\": [ { \"type\": \"rfc822Name\", \"value\": \"test@test.com\" }, { \"type\": \"dnsName\", \"value\": \"www.example.com\" }, ] }

Table no 2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type of Key algorithm	Supported key algorithm and Sizes
RSA	RSA1024, RSA2048, RSA3072, RSA4096, and RSA8192
ECDSA secp	ECC256, ECC384 and ECC521
ECDSA Brainpool	B-ECDSA-256, B-ECDSA-384 and B-ECDSA-512
ECDSA Prime	P-ECDSA-256, P-ECDSA-384 and P-ECDSA-521
EDDSA	Ed25519
PQC	DILITHIUM2, DILITHIUM3, DILITHIUM5, FALCON-512, FALCON-1024, sha2_256f, sha2_256s, sha2_128f, sha2_128s, sha2_192f, sha2_192s, shake_128f, shake_128s, shake_192f, hake_192s, shake_256f, shake_256s, haraka_192f, haraka_192s, haraka_256f, haraka_256s and haraka_128f

","urlObject":{"protocol":"https","path":["emCAServices","rest","create","csr"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"19515aca-cb92-4904-ac46-2927203ef175"},{"name":"importCertificate","id":"d2e9ebd6-4c61-4a38-8e48-79d5bd415fc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"importType\": \"CA\",\r\n \"caId\": \"4\",\r\n \"certData\": \"MIIDmzCCAgOgAwIBAgIRAISAcEvGJRDD7pbBvrPb8zAwDQYJKoZIhvcNAQELBQAwHTEbMBkGA1UEAxMSRWxpbmF0aC1Sb3NlIE1vc2hpMB4XDTI0MDUxNzExNTQzNFoXDTI1MDEyMjE4Mjk1OVowFjEUMBIGA1UEAxMLVEVTVCBDU1IgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCndPrua9PateFtRxwCr9/MEDVWW4NS6u4M+T3VYfqsciBFcNAxzY+v5pcWbXC1EbV8PZtOodFBwpCMRRSNuI6/y79QpV/c39SrAMfvfKZAW5aRxlaqTCQAlEzQQo+c0CZtG/QooBqkUKACHn7j7Zk1jQyzXZDe3iLlMfgMqWkK63VeFQQnSFI8oK+QYRyP/UFT5aO/VUFYbfmLWWpptpQAuNJX/53skmpu2o+k7B8cP/VE2gjNUJx4e2rX3EP+K2rdI+abr0Kr1VRNrOB5UQGcUrBIQ6XXjL7qUohD3pZR3bSOpiB6qJivkZ31zMQpUmISVA/H061knvjC6nmENVIRAgMBAAGjXTBbMAwGA1UdEwQFMAMBAf8wCwYDVR0PBAQDAgbAMB8GA1UdIwQYMBaAFLyIjEk3G0Wxm2+lF9OD2WrKUoTgMB0GA1UdDgQWBBQchzKxYzUf+JLAb/YLTFh1MewDXzANBgkqhkiG9w0BAQsFAAOCAYEAuBrsCwOQt/uY54uawPCqgzQqK54eG2bvKFGGROJZFRazyoF1uIMZoOCrcDeRveX8GhVs1Q/yH1wbx7xwwlwRCBKKU/uIn5QxwfulGdjdVjsoNHacJFjeN5P2RGHZYuRstJEsn0MllsUDWk+b8BexcxWKy3A5CqDO1l422S5XLCakiGKUJXVJqndEle0wSCAnVA1gcXzpQOu7zPKElWNm5US0v+/tjF712GY0FNmlLAxmFqyTlpH7WlgUix5OKOyCIgErPAoKeVIqgSAgdK7By/XrejPtWobUAH/tYSS46AwEoEn7+55A6DFkUiCE2uCe94zVOhOnAkmjxV/wL0PqaLwQUq32XutXtJg3Gar3KD3fH1um+ZtcZKKu80n86hlGmZjGiio+t3Q1ZStgXfnR5QvLBUW/1tnftzuHWmNgRS/YuEwU2eRy50BUVfdvL+8gKQnMUGHPPtCiNsvaWIQV/AWPc44JHCcghwYlLHCk3qxZdt1uqLAy8N37eyN2ss9D\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/import/certificate","description":"

Purpose

The \"importCertificate\" API is used to import a signed certificate or an issuer certificate into the system. This allows the system to recognize and use the imported certificate for various cryptographic operations and verifications.

Request Input Parameters

* - Mandatory parameter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
meta*	JSON	The meta parameter is a required JSON object that contains external user details necessary for processing the request. please refer table Meta Object Fields from above ex:- { \"ver\": \"1.0\", \"ts\": \"2024-01-01T11:40:15+05:30\", \"txn\": \"347328314273\", \"appCode\": \"TestApp\", \"authKey\": \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\" }
importType*	String	importType (String, required): Specifies the type of certificate being imported. Possible values are \"CA\" for a Certificate Authority certificate or \"Issuer\" for an issuer certificate. ex: \"CA\"
caId*	Integer	caId (Integer, required): The identifier of the ca certificate associated with the certificate being imported. ex:-4
certData*	String	certData (String, required): The base64 encoded certificate data. ex:- \"MIICdzCCAeCgAwIBAgIJALkYTrIoPo..........Rlc3QgQ0EwHhcNMjIwNzA1MDI0NzAwWhcNMjMwNzA1N1mkI5eNFP8Q==\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","import","certificate"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2e9ebd6-4c61-4a38-8e48-79d5bd415fc7"},{"name":"createOrUpdateCRLProfile","id":"f4f78648-51d7-4325-b3d7-47b3068f40b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"crlProfileRequestDetails\": {\r\n \"crlProfileID\": 0,\r\n \"profileName\": \"CRL PRofile1\",\r\n \"validity\": 15,\r\n \"customCRLNumber\": 1,\r\n \"isCRLAutoGeneration\": \"1\",\r\n \"crlFrequency\": 1,\r\n \"extensions\": {\r\n \"authorityInformationAccess\": {\r\n \"isEnabled\": \"0\",\r\n \"sortOrder\": 0\r\n },\r\n \"deltaCRL\": {\r\n \"baseCRLNumber\": 0,\r\n \"isEnabled\": \"string\",\r\n \"sortOrder\": 0\r\n },\r\n \"freshestCRL\": {\r\n \"deltaCRLDistributionPoint\": \"string\",\r\n \"isEnabled\": \"string\",\r\n \"sortOrder\": 0\r\n },\r\n \"issuerAlternateName\": {\r\n \"isEnabled\": \"string\",\r\n \"sortOrder\": 0\r\n },\r\n \"issusingDistributionPoint\": {\r\n \"certificateCount\": 0,\r\n \"distributionPointUrl\": \"string\",\r\n \"inDirectCRL\": \"string\",\r\n \"isEnabled\": \"string\",\r\n \"onlyContainsCACerts\": \"string\",\r\n \"onlyContainsUserCert\": \"string\",\r\n \"partitionCount\": 0,\r\n \"sortOrder\": 0\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/create/update/crl-profile","description":"

Purpose

The \"createOrUpdateCRLProfile\" API is used to create or update a Certificate Revocation List (CRL) template. The createOrUpdateCRLProfile API is used to create or update a Certificate Revocation List (CRL) template.

Request Input Parameters

* - Mandatory parameter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
meta*	JSON	The meta parameter is a required JSON object that contains external user details necessary for processing the request. please refer table Meta Object Fields from above ex:- { \"ver\": \"1.0\", \"ts\": \"2024-01-01T11:40:15+05:30\", \"txn\": \"347328314273\", \"appCode\": \"TestApp\", \"authKey\": \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\" }
crlProfileRequestDetails*	JSON	The crlProfileRequestDetails parameter is a required JSON object that contains specific details about the crl template to be generated. refer Table no 1

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
crlProfileID*	Integer	crlProfileID (Integer, optional): The unique identifier for the CRL profile. If provided, updates the existing profile; if not provided (or set to 0), creates a new profile. ex:- 4
profileName	String	profileName (String, required): The name of the CRL profile. ex:- \"sub ca crl profile\"
validity*	Integer	validity (Integer, required): The validity period of the CRL in days. ex:-365
customCRLNumber*	Integer	customCRLNumber (Integer, required): Custom CRL number for the CRL. ex:- 1
isCRLAutoGeneration*	String	isCRLAutoGeneration (String, required): Indicates whether CRL auto-generation is enabled ( \"1\" - \"true\", \"0\"- false\"). ex:- \"1\"
crlFrequency	Integer	crlFrequency (Integer, required): Frequency of CRL generation. Ex:- \"1\"
extensions*	JSON	extensions (Object, required): Contains extension settings for the CRL profile, including: authorityInformationAccess: Settings for Authority Information Access. deltaCRL: Settings for Delta CRL. freshestCRL: Settings for Freshest CRL. issuerAlternateName: Settings for Issuer Alternate Name. issuingDistributionPoint: Settings for Issuing Distribution Point. ex:- { \"authorityInformationAccess\": { \"isEnabled\": \"0\", \"sortOrder\": 0 }, \"deltaCRL\": { \"baseCRLNumber\": 0, \"isEnabled\": \"0\", \"sortOrder\": 0 }, \"issuerAlternateName\": { \"isEnabled\": \"0\", \"sortOrder\": 0 }, }

Table no 2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
authorityInformationAccess	JSON	authInfoAccess: Contains URLs for OCSP responder and CA issuer, providing authority information access. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the authority information access extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the authority information access extension is critical (\"1\" for enabled, \"0\" for disabled). { \"isEnabled\": \"0\", \"isCritical\": \"0\" }
deltaCRL		deltaCRL: Configures Delta CRL settings, including \"baseCRLNumber\" for the base CRL number, \"isEnabled\" (\"1\" for enabled, \"0\" for disabled) to activate Delta CRL, and \"sortOrder\" for prioritization. { \"baseCRLNumber\": 0, \"isEnabled\": \"0\", \"sortOrder\": 0 }
freshestCRL	JSON	freshestCRL: Handles Freshest CRL settings, with \"deltaCRLDistributionPoint\" for Delta CRL distribution, \"isEnabled\" (\"1\" for enabled, \"0\" for disabled) to activate Freshest CRL, and \"sortOrder\" for ordering. ex:- { \"deltaCRLDistributionPoint\": \"string\", \"isEnabled\": \"0\", \"sortOrder\": 0 }
issuerAlternateName		issuerAlternateName: Controls Issuer Alternate Name settings, using \"isEnabled\" (\"1\" for enabled, \"0\" for disabled) to activate this feature and \"sortOrder\" to define its order. ex:- { \"isEnabled\": \"0\", \"sortOrder\": 0 }
issusingDistributionPoint	JSON	issuingDistributionPoint: Manages Issuing Distribution Point attributes, including \"inDirectCRL\" for indirect CRLs, \"onlyContainsCACerts\" and \"onlyContainsUserCert\" for certificate types, \"isEnabled\" (\"1\" for enabled, \"0\" for disabled) to activate this feature, \"distributionPointUrl\" for URL, \"partitionCount\", \"certificateCount\", and \"sortOrder\" for ordering attributes. ex:- { \"inDirectCRL\": \"0\", \"onlyContainsCACerts\": \"0\", \"onlyContainsUserCert\": \"0\", \"isEnabled\": \"0\", \"distributionPointUrl\": \"http://l127.0.0./crl/test.cr\", \"partitionCount\": 0, \"certificateCount\": 0, \"sortOrder\": 5 }

","urlObject":{"protocol":"https","path":["emCAServices","rest","create","update","crl-profile"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4f78648-51d7-4325-b3d7-47b3068f40b4"},{"name":"createOrUpdateCRL","id":"c766a804-8e6e-43a2-96cc-834e02eca68e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"cRLRequestDetails\": {\r\n \"caId\": 1,\r\n \"signingAlgorithm\": \"SHA256WithRSA\",\r\n \"crlProfileId\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/create/update/crl","description":"

Purpose

The \"createOrUpdateCRL\" API is used to generate a new Certificate Revocation List (CRL) or update an existing CRL. The request includes the following parameters within the cRLRequestDetails object:

Request Input Parameters

* - Mandatory parameter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
meta*	JSON	The meta parameter is a required JSON object that contains external user details necessary for processing the request. please refer table Meta Object Fields from above ex:- { \"ver\": \"1.0\", \"ts\": \"2024-01-01T11:40:15+05:30\", \"txn\": \"347328314273\", \"appCode\": \"TestApp\", \"authKey\": \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\" }
cRLRequestDetails*	JSON	The cRLRequestDetails parameter is a required JSON object that contains specific details about the crl template to be generated. refer Table no 1

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
caId*	Integer	caId (Integer, required): The Id of the CA certificate that is generated from the createCA API. ex:- 4
signingAlgorithm*	String	signingAlgorithm (String, required): The algorithm used to sign the CRL, which should match the CA certificate's signing algorithm ex:- \"SHA256WithRSA\"
crlProfileId*	Integer	crlProfileId (Integer, required): The ID of the CRL profile that is generated from the createOrUpdateCRLProfile API. ex:-\"crl profile\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","create","update","crl"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c766a804-8e6e-43a2-96cc-834e02eca68e"},{"name":"getCRL","id":"19624d39-d3fc-439f-b91c-c3475fb8c8bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"caSerialNo\": \"e78b0b75a0fcaf2a7d2fc0aca01ae1d\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/get-crl","description":"

Purpose

The \"getCRL\" API is used to download a Certificate Revocation List (CRL) by providing the CA's certificate serial number and app code.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
caSerialNo*	String	Certificate serial number Ex :- “b4cb23a4b97g5d0c12f2641c1fc49d9ba7”
appCode*	String	appCode is used as part of External Application Registration at emCA. Ex :- “MyApp”

","urlObject":{"protocol":"https","path":["emCAServices","rest","get-crl"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"19624d39-d3fc-439f-b91c-c3475fb8c8bf"},{"name":"getCRL","id":"821b9571-6d59-481d-b4c5-2ecb8843b11a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"url":"https://appemca.emudhra.com/emCAServices/rest/get-crl/{{x_client_id}}/certinext","description":"

Purpose

The \"getCRL\" GET supported API is used to download a Certificate Revocation List (CRL) by providing the CA's serial number and app code.

URL

https://appemca.emudhra.com/emCAServices/rest/get-crl/{caSerialNo}/{appCode}

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
caSerialNo*	String	Certificate serial number need to pass in path variable Ex :- “b4cb23a4b97g5d0c12f2641c1fc49d9ba7”
appCode*	String	appCode is used as part of External Application Registration at emCA and needs to be passed in the path variable. Ex :- “MyApp”

","urlObject":{"protocol":"https","path":["emCAServices","rest","get-crl","{{x_client_id}}","certinext"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"821b9571-6d59-481d-b4c5-2ecb8843b11a"},{"name":"createOrUpdateUserProfile","id":"a0ab83f1-823b-4c3a-b685-89807b1176ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"profileRequestDetails\": {\r\n \"certificateProfileID\": \"\",\r\n \"profileName\": \"test profile\",\r\n \"subjectAttributes\": [\r\n {\r\n \"value\": \"test user cert\",\r\n \"oid\": \"2.5.4.3\",\r\n \"isMandatory\": \"1\",\r\n \"dataType\": \"PrintableString\"\r\n }\r\n ],\r\n \"extensions\": {\r\n \"basicConstraints\": {\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"1\",\r\n \"type\": \"endEntity\",\r\n \"pathLength\": \"none\",\r\n \"sortOrder\": \"2\"\r\n },\r\n \"authInfoAccess\": {\r\n \"isEnabled\": \"0\",\r\n \"isCritical\": \"0\",\r\n \"ocspURL\": \"http://example.com/ocsp\",\r\n \"crtURL\": \"http://example.com/ca/testca.cer\",\r\n \"sortOrder\": \"1\"\r\n },\r\n \"crlDistribution\": {\r\n \"isEnabled\": \"0\",\r\n \"isCritical\": \"0\",\r\n \"crlURL\": \"http://www.example.com/repository/crls/test.crl\",\r\n \"sortOrder\": \"4\"\r\n },\r\n \"keyUsageAttributes\": {\r\n \"encipherOnly\": \"0\",\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"1\",\r\n \"nonRepudiation\": \"0\",\r\n \"digitalSignature\": \"1\",\r\n \"keyEncipherment\": \"0\",\r\n \"dataEncipherment\": \"0\",\r\n \"keyAgreement\": \"0\",\r\n \"keyCertSign\": \"0\",\r\n \"crlSign\": \"0\",\r\n \"decipherOnly\": \"0\",\r\n \"sortOrder\": \"5\"\r\n },\r\n \"extendedKeyUsageAttributes\": {\r\n \"isEnabled\": \"0\",\r\n \"isCritical\": \"0\",\r\n \"serverAuthentication\": \"0\",\r\n \"clientAuthentication\": \"0\",\r\n \"codeSigning\": \"0\",\r\n \"emailProtection\": \"0\",\r\n \"timeStamping\": \"0\",\r\n \"ocspSigning\": \"0\",\r\n \"msftDocumentSigning\": \"0\",\r\n \"smartCardLogon\": \"0\",\r\n \"adobeCertifiedDocumentSigning\": \"0\",\r\n \"encryptionFileSystem\": \"0\",\r\n \"sortOrder\": \"6\"\r\n },\r\n \"subjectKeyIdentifier\": {\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"0\",\r\n \"sortOrder\": \"7\"\r\n },\r\n \"authorityKeyIdentifier\": {\r\n \"isEnabled\": \"1\",\r\n \"isCritical\": \"0\",\r\n \"sortOrder\": \"8\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/create/update/user-profile","description":"

Purpose

The \"createOrUpdateUserProfile\" API is used to create or update a user certificate template. This template defines the details and specifications for user certificates.

Request Input Parameters

* - Mandatory parameter

Request Input Parameters

* - Mandatory parameter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
meta*	JSON	The meta parameter is a required JSON object that contains external user details necessary for processing the request. please refer table Meta Object Fields from above ex:- { \"ver\": \"1.0\", \"ts\": \"2024-01-01T11:40:15+05:30\", \"txn\": \"347328314273\", \"appCode\": \"TestApp\", \"authKey\": \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\" }
profileRequestDetails*	JSON	The profileRequestDetails parameter is a required JSON object that contains the details for creating or updating a user certificate template. refer Table no 1

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
certificateProfileID	String	certificateProfileID (String, required for updating existing profiles, not required for creating new profiles): The unique identifier for the certificate profile. ex:- \"2\", \"54\"
profileName*	String	The ID of the parent CA. Required if generating a sub CA certificate. ex:- \"2\", \"5\"
subjectAttributes*	ArrayList of Object	subjectAttributes (Array, required): An array of objects specifying the subject attributes of the certificate. Each object includes: oid (String, required): The Object Identifier (OID) for the attribute. isMandatory (String, required): Indicates whether the attribute is mandatory (\"1\" for yes, \"0\" for no). dataType (String, required): The data type of the attribute, such as \"PrintableString\". ex:- [ { \"oid\": \"2.5.4.3\", \"isMandatory\": \"0\", \"dataType\": \"PrintableString\" }, \"oid\": \"2.5.4.6\", \"isMandatory\": \"0\", \"dataType\": \"Utif8String\" } ]
extensions*	JSON	caExtensions (Object, optional): A JSON object containing additional X509 extensions for the certificate such as keyUsage, authInfoAccess, certificatePolicy etc refer Table no 2 ex:- \"basicConstraints\": { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"type\": \"root\", \"pathLength\": \"none\", \"sortOrder\": \"2\" }, \"authInfoAccess\": { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"ocspURL\": \"http://example.com/ocsp\", \"cAIssuerURL\": \"http://example.com/ca/testca.cer\", \"sortOrder\": \"1\" }

Table no 2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
basicConstraints*	JSON	basicConstraints: Specifies the basic constraints for the certificate. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the basic constraints extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the basic constraints extension is critical (\"1\" for enabled, \"0\" for disabled). type (String, required): Specifies the type of CA (e.g., \"root\", \"subCA\"). pathLength (String, required): Specifies the maximum depth of valid certification paths that include this certificate. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"type\": \"endEntity\", \"pathLength\": \"none\", \"sortOrder\": \"2\" }
authInfoAccess		authInfoAccess: Contains URLs for OCSP responder and CA issuer, providing authority information access. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the authority information access extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the authority information access extension is critical (\"1\" for enabled, \"0\" for disabled). ocspURL (String, required): URL of the OCSP responder. cAIssuerURL (String, required): URL of the CA issuer certificate. sortOrder (String, required): Specifies the order in which this extension is processed. { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"ocspURL\": \"http://example.com/ocsp\", \"cAIssuerURL\": \"http://example.com/ca/testca.cer\", \"sortOrder\": \"1\" }
certificatePolicy	JSON	certificatePolicy: Defines policies under which the certificate was issued, including policy OIDs and CPS URLs. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the certificate policy extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the certificate policy extension is critical (\"1\" for enabled, \"0\" for disabled). policyOID (Array, required): An array of objects defining policy OIDs and optional user notice texts. oid (String, required): The Object Identifier for the policy. noticeText (String, required): Optional text notice for the policy. cpsURL (String, required): URL of the Certification Practice Statement. cpsPolicyOID (String, required): OID for the CPS policy. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"policyOID\": [ { \"oid\": \"1.3.24.33.34.34\", \"noticeText\": \"User Notice\" } ], \"cpsURL\": \"http://www.example.com/repository/cps/test.pdf\", \"cpsPolicyOID\": \"2.16.356.100.1.8.2\", \"sortOrder\": \"3\" }
crlDistribution		crlDistribution: Provides URLs where the CRL (Certificate Revocation List) can be accessed. this parameter is a required JSON object that contains specific details such as below isEnabled (String, required): Indicates if the CRL distribution points extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the CRL distribution points extension is critical (\"1\" for enabled, \"0\" for disabled). crlURL (String, required): URL of the CRL. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"crlURL\": \"http://www.example.com/repository/crls/test.crl\", \"sortOrder\": \"4\" }
keyUsageAttributes*	JSON	keyUsageAttributes: Defines the purpose of the key contained in the certificate, such as signing or enciphering. this parameter is a required JSON object that contains specific details. isEnabled (String, required): Indicates if the key usage extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the key usage extension is critical (\"1\" for enabled, \"0\" for disabled). encipherOnly (String, required): Indicates if the key is used for enciphering only. nonRepudiation (String, required): Indicates if the key is used for non-repudiation. digitalSignature (String, required): Indicates if the key is used for digital signatures. keyEncipherment (String, required): Indicates if the key is used for key encipherment. dataEncipherment (String, required): Indicates if the key is used for data encipherment. keyAgreement (String, required): Indicates if the key is used for key agreement. keyCertSign (String, required): Indicates if the key is used for signing certificates. crlSign (String, required): Indicates if the key is used for signing CRLs. decipherOnly (String, required): Indicates if the key is used for deciphering only. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"encipherOnly\": \"0\", \"isCritical\": \"0\", \"nonRepudiation\": \"0\", \"digitalSignature\": \"0\", \"keyEncipherment\": \"0\", \"dataEncipherment\": \"0\", \"keyAgreement\": \"0\", \"keyCertSign\": \"0\", \"crlSign\": \"0\", \"decipherOnly\": \"0\", \"sortOrder\": \"5\" }
extendedKeyUsageAttributes		extendedKeyUsageAttributes: Specifies additional key usages for the certificate, such as server authentication or email protection. this parameter is a required JSON object that contains specific details. isEnabled (String, required): Indicates if the extended key usage extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the extended key usage extension is critical (\"1\" for enabled, \"0\" for disabled). serverAuthentication (String, required): Indicates if the key is used for server authentication. clientAuthentication (String, required): Indicates if the key is used for client authentication. codeSigning (String, required): Indicates if the key is used for code signing. emailProtection (String, required): Indicates if the key is used for email protection. timeStamping (String, required): Indicates if the key is used for timestamping. ocspSigning (String, required): Indicates if the key is used for OCSP signing. msftDocumentSigning (String, required): Indicates if the key is used for Microsoft document signing. smartCardLogon (String, required): Indicates if the key is used for smart card logon. adobeCertifiedDocumentSigning (String, required): Indicates if the key is used for Adobe certified document signing. encryptionFileSystem (String, required): Indicates if the key is used for the encryption file system. sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"serverAuthentication\": \"0\", \"clientAuthentication\": \"0\", \"codeSigning\": \"0\", \"emailProtection\": \"0\", \"timeStamping\": \"0\", \"ocspSigning\": \"0\", \"msftDocumentSigning\": \"0\", \"smartCardLogon\": \"0\", \"adobeCertifiedDocumentSigning\": \"0\", \"encryptionFileSystem\": \"0\", \"sortOrder\": \"6\" }
subjectKeyIdentifier*		subjectKeyIdentifier: Provides a unique identifier for the certificate's public key. isEnabled (String, required): Indicates if the subject key identifier extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the subject key identifier extension is critical (\"1\" for enabled, \"0\" for disabled). sortOrder (String, required): Specifies the order in which this extension is processed. ex:- { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"sortOrder\": \"6\" }
authorityKeyIdentifier*		authorityKeyIdentifier: Provides a unique identifier for the key used to sign the certificate. isEnabled (String, required): Indicates if the authority key identifier extension is enabled (\"1\" for enabled, \"0\" for disabled). isCritical (String, required): Indicates if the authority key identifier extension is critical (\"1\" for enabled, \"0\" for disabled). sortOrder (String, required): Specifies the order in which this extension is processed. { \"isEnabled\": \"0\", \"isCritical\": \"0\", \"sortOrder\": \"7\" }
sanDetails		sanDetails: Specifies the Subject Alternative Name (SAN) attributes, including types and values. isCritical (String, required): Indicates if the SAN extension is critical (\"1\" for enabled, \"0\" for disabled). isEnabled (String, required): Indicates if the SAN extension is enabled (\"1\" for enabled, \"0\" for disabled). sortOrder (String, required): Specifies the order in which this extension is processed. attributes (Array, required): An array of objects specifying SAN attributes, each containing: type (String, required): The type of SAN (e.g., \"rfc822Name\"). isMandatory (String, required): Indicates if the SAN attribute is mandatory. ex:- { \"isCritical\": \"0\", \"isEnabled\": \"0\", \"sortOrder\": \"1\", \"attributes\": [ { \"type\": \"rfc822Name\", \"isMandatory\": \"0\" } ] }

","urlObject":{"protocol":"https","path":["emCAServices","rest","create","update","user-profile"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0ab83f1-823b-4c3a-b685-89807b1176ce"},{"name":"createUserCertificate","id":"f312a34d-d2bb-4037-a211-a8ff04461f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"meta\": {\r\n \"ver\": \"1.0\",\r\n \"ts\": \"2024-06-04T11:40:15+05:30\",\r\n \"txn\": \"3473283142736543345\",\r\n \"appCode\": \"certinext\",\r\n \"authKey\": \"702e3cf0a395063f654cbce7b71d0d647fc8816eabeb353170caaab3b3146dd4\"\r\n },\r\n \"certificateRequestDetails\": {\r\n \"certificateProfileID\": \"6\",\r\n \"csr\": \"MIICzTCCAbUCAQAwgYcxCzAJBgNVBAYTAkdCMRYwFAYDVQQIEw1TdGFmZm9yZHNoaXJlMRcwFQYDVQQHEw5TdG9rZSBvbiBUcmVudDEjMCEGA1UEChMaUmVkIEtlc3RyZWwgQ29uc3VsdGluZyBMdGQxIjAgBgNVBAMTGXRlc3RjZXJ0LnJlZGtlc3RyZWwuY28udWswggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDWLeW88IeAIa3n23R99i874fh0jetf+STsGPgkfGXGJ++tclKGk3MJE0ijD4PNaxGXUCNULgn2ROyybm5sTmGzpEOD+1AAAyV+pLQoFNkHEFuudGqVM6XkPWfqaM2vKvdzUbPPC0X/MfDFGPxc8AY3TUM385c9c9/WOIF6NUcAvAFIQF0zG7evzJZBqDb4enUnatMSLHmxRWMi1JeHtfLINXhNitHewEQWgIB3j1xmh7CPO5FeTb6HzQDxc+f7uMisY6s9J/Ph3GeOCeIDooqU8jnfV5eGEzIMH5CFMZjajrNKF4DYK3YRyUI0K66+v0KILoUntEs++M20LhOn+VE9AgMBAAGgADANBgkqhkiG9w0BAQUFAAOCAQEAUWE7oBX3SLjYNM53bsBOlNGnsgAp1P1fiCPpEKaZGEOUJ2xOguIHSu1N1ZigKpWmiAAZxuoagW1R/ANM3jXpvCLVBRv40AHCFsot9udrdCYjI43aDHAaYvLmT4/Pvpntcn0/7+g//elAHhr9UIooMZwwwo6yom67Jwfw/be/g7Mae7mPHZ2lsQTS02hEeqVynIRk2W9meQULrt+/atog0mqJSBx0WswtHliTc+nXFpQrwFIEzVuPGCOVw7LmCfNmHNCkZVuRSJB/9MdLmrfwchPI3NeTGSe+BZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\",\r\n \"subCAID\": \"2\",\r\n \"subjectAttributes\": [\r\n {\r\n \"value\": \"test user cert\",\r\n \"oid\": \"2.5.4.3\",\r\n \"isMandatory\": \"1\",\r\n \"dataType\": \"PrintableString\"\r\n }\r\n ],\r\n \"validityCriteria\": \"d\",\r\n \"validityValue\": \"365\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/request/user-certificate","description":"

Purpose

The \"createUserCertificate\" API is used to generate a user certificate based on the provided input parameters. The request includes details such as the certificate profile ID, CSR, SAN attributes, subordinate CA ID, subject attributes, and validity details. The generated user certificate can be returned in base64 encoded X509 format along with the chain of certificates.

Request Input Parameters

* - Mandatory parameter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
meta*	JSON	The meta parameter is a required JSON object that contains external user details necessary for processing the request. please refer table Meta Object Fields from above ex:- { \"ver\": \"1.0\", \"ts\": \"2024-01-01T11:40:15+05:30\", \"txn\": \"347328314273\", \"appCode\": \"TestApp\", \"authKey\": \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\" }
certificateRequestDetails*	JSON	The certificateRequestDetails parameter is a required JSON object that contains specific details about the certificate to be generated. refer Table no 1

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
certificateProfileID*	String	certificateProfileID (String, required): The unique identifier for the certificate template to be used for certificate generation. ex:- \"2\", \"5\"
subCAID*	String	The ID of the sub CA. ex:- \"2\", \"5\"
csr*	String	csr (String, required): The Certificate Signing Request (CSR) in string format. ex:- \"MIICzTCCAbUCAQAwgYcxCzAJBgN.................ZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\"
validityCriteria*	String	validityCriteria (String, required): The criteria for the certificate's validity, such as \"days\", \"months\", or \"years\". ex:- \"days\"
validityValue*	String	validityValue : The value corresponding to the validity criteria (e.g., 365 for 365 days). ex:-\"365\"
subjectAttributes*	ArrayList of Object	subjectAttributes (Array, required): An array of objects containing the subject attributes of the certificate. Each object includes: oid (String, required): The Object Identifier (OID) for the attribute. value (String, required): The value of the attribute. ex:- [ { \"oid\": \"2.5.4.3\", \"value\": \"common name\" }, \"oid\": \"2.5.4.6\", \"value\": \"IN\" } ]
sanAttributes	ArrayList of Object	sanAttributes (Array, optional): An array of objects specifying the Subject Alternative Name (SAN) attributes. Each object includes: type (String, required): The type of SAN attribute, such as \"rfc822Name\". value (String, required): The value of the SAN attribute. ex:- [ { \"type\": \"rfc822Name\", \"value\": \"test@test.com\" }, \"type\": \"dnsName\", \"value\": \"www.example.com\" } ]

","urlObject":{"protocol":"https","path":["emCAServices","rest","request","user-certificate"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f312a34d-d2bb-4037-a211-a8ff04461f7d"}],"id":"a04945af-21cd-465f-8955-11224d23afdd","description":"

The CA Management APIs for the Certifying Authority (CA) facilitate comprehensive management of digital certificates, enabling tasks such as issuance, renewal, revocation, and validation. These APIs provide secure, programmatic access to CA functions, ensuring seamless integration with existing systems for automated certificate lifecycle management. They support both RSA and ECC algorithms, and adhere to industry standards for security and interoperability, streamlining the process of maintaining robust and compliant public key infrastructures (PKI).

To ensure clarity and consistency across your CA Management APIs, a meta object can be standardized in both request and response structures, including security headers like X-Nonce for replay attack prevention.

Below table can dscribe for meta object, this has to provide for all the APIs

Meta Object Fields

The \"meta\" object must be included as a parameter in all API requests to maintain consistency and security across the system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
ver*	String	ver : Specifies the version of the API or request. This helps in ensuring compatibility and proper handling of the request. ex:- \"1.0\"
ts*	String	ts : Records the time when the request was made. This is crucial for tracking and logging purposes. Format: ISO 8601 ex:- \"2024-01-01T11:40:15+05:30\"
txn*	String	txn : A unique identifier for the transaction. This ID helps in uniquely identifying and tracking the request across different systems. ex:- 347328314273
appCode*	String	appCode : Represents the application code that is making the request. It helps in identifying which application or service initiated the request. ex:- \"MYAPP\"
authKey*	String	authKey : An authentication key used to verify the legitimacy of the request. This key ensures that only authorized entities can make requests to the API. The auth key is generated by applying the SHA256 hash to the concatenation of the ClientID, request timestamp (ts), and request unique transaction ID (txn).(SHA256(clientid+ts+txn) ex:- \"0e56ea59a73102605346cdb2a6ee61e1ab6ddb1d4785d8d5f16401bfa03516a7\"

","_postman_id":"a04945af-21cd-465f-8955-11224d23afdd"},{"name":"Certificate Management","item":[{"name":"getJwt-token","id":"ce4e56ae-83f8-4e6c-95df-46a6b2b4d0c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"certinext\",\r\n \"password\": \"eMudhra@1\",\r\n \"clientId\": \"129d0feb-00fa-482a-8f34-39cf784054ab\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/authenticate/getJwt-token","description":"

Purpose

Authentication for Certificate Management in emCA REST APIs is handled using a JWT token with a configurable expiry time. This token must be included in the header of every request to the APIs for authentication.

To obtain a JWT token for the Certificate Management REST APIs, users need to provide their registered username (appCode), password, and clientId to the API.

Prerequisites

Register Your Application: Ensure your application is registered as an external application in emCA before using the API.
\n
Share Credentials: As part of the registration process, provide the emCA team with your username (appCode), password, and IP address.
\n
Obtain clientId: Receive the clientId from Team emCA upon registering an external application user.
\n

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
username*	String	Username (appCode) which is used as part of External Application Registartion at emCA. ex:- \"certinext\"
password*	String	Password which is used as part of External Application Registartion at emCA. ex:- \"P@ssw0rd\"
clientId*	String	ClientID. Received from team emCA post successful Registration ex:- \"924e5g30-8cea-4bf4-be77-4b0e160dbaf9\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","authenticate","getJwt-token"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce4e56ae-83f8-4e6c-95df-46a6b2b4d0c5"},{"name":"createCertificate","id":"dba3ffe3-2453-4d38-bbf8-66d17a4fe156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"profile\": \"3\",\r\n \"output\": \"X509\",\r\n \"csr\": \"MIICzTCCAbUCAQAwgYcxCzAJBgNVBAYTAkdCMRYwFAYDVQQIEw1TdGFmZm9yZHNoaXJlMRcwFQYDVQQHEw5TdG9rZSBvbiBUcmVudDEjMCEGA1UEChMaUmVkIEtlc3RyZWwgQ29uc3VsdGluZyBMdGQxIjAgBgNVBAMTGXRlc3RjZXJ0LnJlZGtlc3RyZWwuY28udWswggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDWLeW88IeAIa3n23R99i874fh0jetf+STsGPgkfGXGJ++tclKGk3MJE0ijD4PNaxGXUCNULgn2ROyybm5sTmGzpEOD+1AAAyV+pLQoFNkHEFuudGqVM6XkPWfqaM2vKvdzUbPPC0X/MfDFGPxc8AY3TUM385c9c9/WOIF6NUcAvAFIQF0zG7evzJZBqDb4enUnatMSLHmxRWMi1JeHtfLINXhNitHewEQWgIB3j1xmh7CPO5FeTb6HzQDxc+f7uMisY6s9J/Ph3GeOCeIDooqU8jnfV5eGEzIMH5CFMZjajrNKF4DYK3YRyUI0K66+v0KILoUntEs++M20LhOn+VE9AgMBAAGgADANBgkqhkiG9w0BAQUFAAOCAQEAUWE7oBX3SLjYNM53bsBOlNGnsgAp1P1fiCPpEKaZGEOUJ2xOguIHSu1N1ZigKpWmiAAZxuoagW1R/ANM3jXpvCLVBRv40AHCFsot9udrdCYjI43aDHAaYvLmT4/Pvpntcn0/7+g//elAHhr9UIooMZwwwo6yom67Jwfw/be/g7Mae7mPHZ2lsQTS02hEeqVynIRk2W9meQULrt+/atog0mqJSBx0WswtHliTc+nXFpQrwFIEzVuPGCOVw7LmCfNmHNCkZVuRSJB/9MdLmrfwchPI3NeTGSe+BZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/createCertificate","description":"

Purpose

The \"createCertificate\" API is used to generate an X509 certificate for the provided CSR (PKCS10). The generated certificate can be returned either in base64 encoded X509 format or as a PEM, based on the specified requirements.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
profile*	String	A Certificate Profile name or Certificate Profile ID is a unique profile or template created for certificates. Profiles can be created by an admin on emCA or using the CA Management APIs. ex:- \"5\", \"SSL Certificate\"
output*	String	Output defines the format of the certificate: X509: Base64 encoded X509 Certificate (without certificate chain). PEM: PEM format with certificate chain. ex:- \"X509\" or \"PEM\"
csr*	String	Certificate Signing Request (#PKCS10) ex:- \"MIICzTCCAbUCAQAwgYcxCzAJBgNV..........GSe+BZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\"
subscriberID	Integer	A Unique ID for the Subscribers/Devices uniquely identifies the Subscriber/Device. The value should only be a positive integer within the allowed range and up from 1 to 10 characters in length. ex:- 12345 Max :
txnID	Long	The Transaction ID uniquely identifies the transaction. The value should only be a positive integer within the allowed range and upfrom 1 to 19 characters in length. ex:- 876545675
validity	JSON	Certificate validity can be defined only if the profile supports custom validity. The validity should be less than the validity periods of both the profile and the issuer. Ex:- { \"days\": 365, \"hours\": 0, \"minutes\": 0, \"seconds\": 0 }
validfrom	JSON	Certificate validity can be defined starting from a specific date if the profile is enabled for custom validity. Validation for the validfrom field is as follows: validfrom should not be a past date. day - day of the month (1-31) month - month of the year (1-12) year - four-digit year (e.g., 2024) hour - hour of the day (0-23) minute - minute of the hour (0-59) second - second of the minute (0-59)\" ex:- { \"day\": 1, \"month\": 1, \"year\": 2024, \"hour\": 0, \"minute\": 0, \"second\": 0 }

","urlObject":{"protocol":"https","path":["emCAServices","rest","createCertificate"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dba3ffe3-2453-4d38-bbf8-66d17a4fe156"},{"name":"createCertificates","id":"a1fd5660-9f9d-41b5-9c65-62efdbcde920","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"profile\": \"3\",\r\n \"output\": \"X509\",\r\n \"csrInfo\": [\r\n {\r\n \"referenceId\": \"1001\",\r\n \"csr\": \"MIICzTCCAbUCAQAwgYcxCzAJBgNVBAYTAkdCMRYwFAYDVQQIEw1TdGFmZm9yZHNoaXJlMRcwFQYDVQQHEw5TdG9rZSBvbiBUcmVudDEjMCEGA1UEChMaUmVkIEtlc3RyZWwgQ29uc3VsdGluZyBMdGQxIjAgBgNVBAMTGXRlc3RjZXJ0LnJlZGtlc3RyZWwuY28udWswggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDWLeW88IeAIa3n23R99i874fh0jetf+STsGPgkfGXGJ++tclKGk3MJE0ijD4PNaxGXUCNULgn2ROyybm5sTmGzpEOD+1AAAyV+pLQoFNkHEFuudGqVM6XkPWfqaM2vKvdzUbPPC0X/MfDFGPxc8AY3TUM385c9c9/WOIF6NUcAvAFIQF0zG7evzJZBqDb4enUnatMSLHmxRWMi1JeHtfLINXhNitHewEQWgIB3j1xmh7CPO5FeTb6HzQDxc+f7uMisY6s9J/Ph3GeOCeIDooqU8jnfV5eGEzIMH5CFMZjajrNKF4DYK3YRyUI0K66+v0KILoUntEs++M20LhOn+VE9AgMBAAGgADANBgkqhkiG9w0BAQUFAAOCAQEAUWE7oBX3SLjYNM53bsBOlNGnsgAp1P1fiCPpEKaZGEOUJ2xOguIHSu1N1ZigKpWmiAAZxuoagW1R/ANM3jXpvCLVBRv40AHCFsot9udrdCYjI43aDHAaYvLmT4/Pvpntcn0/7+g//elAHhr9UIooMZwwwo6yom67Jwfw/be/g7Mae7mPHZ2lsQTS02hEeqVynIRk2W9meQULrt+/atog0mqJSBx0WswtHliTc+nXFpQrwFIEzVuPGCOVw7LmCfNmHNCkZVuRSJB/9MdLmrfwchPI3NeTGSe+BZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\"\r\n },\r\n {\r\n \"referenceId\": \"1002\",\r\n \"csr\": \"MIIBLzCB1gIBADB0MSkwJwYJKoZIhvcNAQkBFhp0YW5tb3kucHJhZGhhbkBlbXVkaHJhLmNvbTENMAsGA1UEERMEbnVsbDEPMA0GA1UEAxMGVGFubW95MREwDwYDVQQKEwhQZXJzb25hbDEJMAcGA1UECBMAMQkwBwYDVQQGEwAwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAT+EAJgUf75U/UQ12h7ZR9AH4GLGByNOvgu4y/vQIKRkqZeY028EerKzpKjhhL4Ocb8CyNIl/pPElgRJzHawNBDoAAwCgYIKoZIzj0EAwIDSAAwRQIhAPABaUje1TrCD+RqlV4UFvo/pFO3GiMvr989qa8cZfBTAiBLhbbqAo/fx3fdKKahwuLMfbL2dvQXgMHFOdXiR0/oOA==\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/createCertificates","description":"

Purpose

The \"createCertificates\" API is designed to generate multiple X509 Certificates based on up to 10 provided Certificate Signing Requests (CSRs). This API allows for the creation of certificates in either Base64 encoded X509Certificates or PEM. It enables efficient management and creation of multiple certificates simultaneously.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
profile*	String	A Certificate Profile name or Certificate Profile ID is a unique profile or template created for certificates. Profiles can be created by an admin on emCA or using the CA Management APIs. ex:- \"5\", \"SSL Certificate\"
output*	String	Output defines the format of the certificate: X509: Base64 encoded X509 Certificate (without certificate chain). PEM: PEM format with certificate chain. ex:- \"X509\" or \"PEM\"
csrInfo*	ArrayList	A JSON object of csr needs to be passed in an ArrayList for bulk signing. Each csrInfo object should include the necessary details for creating an X509 Certificate, allowing the API to process multiple Certificate Signing Requests (CSRs) simultaneously, up to a maximum of 10 CSRs referenceId : Unique Id for CSR. ex:- [ { \"referenceId\": \"1001\", \"csr\": \"MIICzTCCAbUCAQAwgYcxCzAJBgN............NeTGSe+BZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\" }, { \"referenceId\": \"1002\", \"csr\": \"MIICzTCCAbUCAQAwgYcxCzAJBgN............NeTGSe+BZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\" } ]
subscriberID	Integer	A Unique ID for the Subscribers/Devices uniquely identifies the Subscriber/Device. The value should only be a positive integer within the allowed range and up from 1 to 10 characters in length. ex:- 12345
txnID	Long	The Transaction ID uniquely identifies the transaction. The value should only be a positive integer within the allowed range and upfrom 1 to 19 characters in length. ex:- 876545675
validity	JSON	Certificate validity can be defined only if the profile supports custom validity. The validity should be less than the validity periods of both the profile and the issuer. Ex:- { \"days\": 365, \"hours\": 0, \"minutes\": 0, \"seconds\": 0 }
validfrom	JSON	Certificate validity can be defined starting from a specific date if the profile is enabled for custom validity. Validation for the validfrom field is as follows: validfrom should not be a past date. day - day of the month (1-31) month - month of the year (1-12) year - four-digit year (e.g., 2024) hour - hour of the day (0-23) minute - minute of the hour (0-59) second - second of the minute (0-59)\" ex:- { \"day\": 1, \"month\": 1, \"year\": 2024, \"hour\": 0, \"minute\": 0, \"second\": 0 }

","urlObject":{"protocol":"https","path":["emCAServices","rest","createCertificates"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1fd5660-9f9d-41b5-9c65-62efdbcde920"},{"name":"createCustomCertificate","id":"4f4a40af-b762-4df8-a445-3b760bbaca17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"profile\": \"3\",\r\n \"subjectDN\": {\r\n \"commonName\": \"test\",\r\n \"country\": \"IN\"\r\n },\r\n \"eSign\": \"No\",\r\n \"output\": \"X509\",\r\n \"csr\": \"MIIBLzCB1gIBADB0MSkwJwYJKoZIhvcNAQkBFhp0YW5tb3kucHJhZGhhbkBlbXVkaHJhLmNvbTENMAsGA1UEERMEbnVsbDEPMA0GA1UEAxMGVGFubW95MREwDwYDVQQKEwhQZXJzb25hbDEJMAcGA1UECBMAMQkwBwYDVQQGEwAwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAT+EAJgUf75U/UQ12h7ZR9AH4GLGByNOvgu4y/vQIKRkqZeY028EerKzpKjhhL4Ocb8CyNIl/pPElgRJzHawNBDoAAwCgYIKoZIzj0EAwIDSAAwRQIhAPABaUje1TrCD+RqlV4UFvo/pFO3GiMvr989qa8cZfBTAiBLhbbqAo/fx3fdKKahwuLMfbL2dvQXgMHFOdXiR0/oOA==\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/createCustomCertificate","description":"

Purpose

The 'createCustomCertificate' API facilitates the creation of X509 Certificates or PEM by accepting a CSR (#PKCS10) along with additional parameters such as Subject Distinguished Name (DN) and Subject Alternative Name (SAN) details. This API allows for the customization of certificate attributes, enabling the creation of certificates tailored to specific requirements and ensuring flexibility in certificate management.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
profile*	String	A Certificate Profile name or Certificate Profile ID is a unique profile or template created for certificates. Profiles can be created by an admin on emCA or using the CA Management APIs. ex:- \"5\", \"SSL Certificate\"
eSign*	String	To increase throughput, set this option to 'Yes'. This configuration ensures the application loads all necessary details upfront, such as profiles, and reuses them for all requests, thereby enhancing performance. This approach is commonly used for eSign transactions. Alternatively, set it to 'No'. ex:- \"No\" or \"Yes\"
subjectDN*	JSON	Subject dn details which need to be added as part of the certificate. ex: { \"commonName\": \"test\", \"country\":\"IN\", \"oids\": [ { \"oid\": \"2.5.4.7\", \"value\": \"test\" } ] } ref :- Tabel no 2
csr*	String	Certificate Signing Request (#PKCS10) ex:- \"MIICzTCCAbUCAQAwgYcxCzAJBgNV......................u8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\"
san	JSON	Subject Alternative Name which need to be added as part of the certificate. ref:- Table no 3 ex: - { \"rfc822Name\": \"keven.s@ta.co.in\", \"dnsName\": \"www.example.com\", \"ipAddress\": \"127.0.0.1\", \"url\": \"https://www.emudhra.com\", \"registeredID\": \"2.10.100.2.3.4\", \"directoryName\": \"L=IAO\" }
txnID	Long	The Transaction ID uniquely identifies the transaction. The value should only be a positive integer within the allowed range and upfrom 1 to 19 characters in length. ex:- 876545675
subscriberID	Integer	A Unique ID for the Subscribers/Devices uniquely identifies the Subscriber/Device. The value should only be a positive integer within the allowed range and up from 1 to 10 characters in length. ex:- 12345
validity	JSON	Certificate validity can be defined only if the profile supports custom validity. The validity should be less than the validity periods of both the profile and the issuer. Ex:- { \"days\": 365, \"hours\": 0, \"minutes\": 0, \"seconds\": 0 }
validfrom	JSON	Certificate validity can be defined starting from a specific date if the profile is enabled for custom validity. Validation for the validfrom field is as follows: validfrom should not be a past date. day - day of the month (1-31) month - month of the year (1-12) year - four-digit year (e.g., 2024) hour - hour of the day (0-23) minute - minute of the hour (0-59) second - second of the minute (0-59)\" ex:- { \"day\": 1, \"month\": 1, \"year\": 2024, \"hour\": 0, \"minute\": 0, \"second\": 0 }

Tabel no 2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
commonName	String	Validation for the CN field as below A character length of minimum 2 and maximum 64 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). A digit (from \"0\" to \"9\"). A hyphen (\"-\"). A period (\".\"). An apostrophe (\"'\"). An asterisk (\"*\"). An underscore (\"_\"). At sign (\"@\") A space (\" \"). ex:- \"keven\", \"123\", \"abc123\"
country	String	Validation for the Country field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"IN\", \"India\"
organisation	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"emudhra\", \"Test org\"
organisationUnit	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). It will accept multiple OU values separated by commas(\",\"). ex:- \"emudhra ltd\", \"ESS,TECH\"
postalCode	String	Validation for the postal code field as below A character length of minimum 4 and maximum 64 characters A digit (from \"0\" to \"9\"). ex:- \"560063\"
stateOrProvince	String	Validation for the state field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"KA\", \"texas\"
street	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:-\"abc street\"
houseIdentifier	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"xyz\"
serialNumber	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"fff44f43224c43\"
uniqueIdentifier	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"774434cvfc45\"
pseudonym	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"John Doe\"
telephoneNumber	String	SHA256 of Telephone Number ex:- \"9cd24231c813f6608bcf717e15b76700a80e2170fbf235e5ff344dae948bbfec\"
title	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"Data Analyst\"
email	String	A character length of minimum 2 and maximum 64 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). A digit (from \"0\" to \"9\"). A hyphen (\"-\"). A period (\".\"). An underscore (\"_\"). At sign (\"@\") ex:- \"jhon.ken@co.in\"
oids	ArrayList	Pass additional subject DN details using the OIDs. You can provide multiple OIDs in an array object. Refer Table no 4 ex:- [ { \"oid\": \"2.5.4.7\", \"value\": \"Bengalureu\" } ]

Tabel no 3

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
rfc822Name	String	\"rfc822Name\" refers to an email address formatted according to RFC 822 standards ex:- \"vikram.s@outlook.com\"
dnsName	String	\"dnsName\" refers to a domain name system (DNS) name. It identifies a domain or hostname associated with an entity or resource, allowing secure communication over networks while validating the identity of servers and services. ex:- \"www.example.com\"
ipAddress	String	\"ipAddress\" refers to an IP address. It uniquely identifies a device or network interface on a TCP/IP network, enabling secure communication and validation of network endpoints in cryptographic protocols like TLS/SSL. ex:- \"10.32.43.124\"
url	String	\"url\" refers to a Uniform Resource Locator, commonly known as a web address. ex:- \"https://www.emudhra.com\"
registeredID	String	\"registeredID\" refers to a registered object identifier (OID) that uniquely identifies an object or attribute within a hierarchical naming structure defined by an organization or standards body. it can be used to specify a unique identifier for an entity, attribute, or policy associated with the certificate, ensuring interoperability and standardized identification across systems. ex:- \"2.10.100.2.3.4\"
directoryName	String	\"directoryName\" is a structured representation of a distinguished name (DN) in X.509 certificates. It includes attributes like common name, organization, and locality, facilitating accurate identification and validation of entities within hierarchical directory systems for secure communications. ex:- \"L=IAO\"

Tabel no 4

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
oid	String	subject DN details using the OID ex:- \"2.5.4.7\"
value	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"Delhi\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","createCustomCertificate"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f4a40af-b762-4df8-a445-3b760bbaca17"},{"name":"createKeyStore","id":"8c95be17-0a72-42bd-9008-8f7177e1002a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"profile\": \"4\",\r\n \"subjectDN\": {\r\n \"commonName\": \"Encrypted Certificate\",\r\n \"country\": \"IN\"\r\n },\r\n \"keyAlgorithm\": \"RSA-2048\",\r\n \"keyStorePassword\": \"Test@123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/createKeyStore","description":"

Purpose

This is a method that is responsible for creating a keystore. A keystore is a repository for storing cryptographic keys and certificates.

This refers to the type of keystore being generated. PKCS12 (Public-Key Cryptography Standards #12) is a standard for storing both X.509 certificates and private keys in a single file. It is widely used and supported by various systems.

Call the createKeyStore method, providing it with the necessary parameters, including the certificate profile.

The createKeyStore method processes based on the provided input perameters and generates a new keystore in the PKCS12 format.

Prerequisites

The profile should be KRS (Key Recovery Service) enabled.
\n
To enable KRS, follow these steps when creating the user profile
\n
Log in to the emCA UI Portal as an Administrator and navigate to the user profile (refer emCA User Manual). Then, select the \"Is KRS enabled\" checkbox.
\n

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
profile*	String	A Certificate Profile name or Certificate Profile ID is a unique profile or template created for certificates. Profiles can be created by an admin on emCA or using the CA Management APIs. ex:- \"5\", \"Encryption Certificate\"
subscriberID	Integer	A Unique ID for the Subscribers/Devices uniquely identifies the Subscriber/Device. The value should only be a positive integer within the allowed range and up from 1 to 10 characters in length. ex:- 12345
subjectDN*	JSON	Pass the all the subject dn details from this perameter ex: { \"commonName\": \"test\", \"country\":\"IN\". \"oids\": [ { \"oid\": \"2.5.4.7\", \"value\": \"test\" } ] } ref :- Tabel no 2
san	JSON	Pass the all the san details from this perameter ref:- Table no 4 ex: { \"rfc822Name\": \"test@test.com\" },
keyAlgorithm*	String	Provide required key algorithm for creating key store ex:- \"RSA-2048\", \"ECDSA-256\" For supported key algorithm ref :- Table no 3
keyStorePassword*	String	Password for generating keystore ex:- \"P@ssword1\"
txnID	Long	The Transaction ID uniquely identifies the transaction. The value should only be a positive integer within the allowed range and upfrom 1 to 19 characters in length. ex:- 876545675
validity	JSON	Certificate validity can be defined only if the profile supports custom validity. The validity should be less than the validity periods of both the profile and the issuer. Ex:- { \"days\": 365, \"hours\": 0, \"minutes\": 0, \"seconds\": 0 }
validfrom	JSON	Certificate validity can be defined starting from a specific date if the profile is enabled for custom validity. Validation for the validfrom field is as follows: validfrom should not be a past date. day - day of the month (1-31) month - month of the year (1-12) year - four-digit year (e.g., 2024) hour - hour of the day (0-23) minute - minute of the hour (0-59) second - second of the minute (0-59)\" ex:- { \"day\": 1, \"month\": 1, \"year\": 2024, \"hour\": 0, \"minute\": 0, \"second\": 0 }

Tabel no 2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
commonName	String	Validation for the CN field as below A character length of minimum 2 and maximum 64 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). A digit (from \"0\" to \"9\"). A hyphen (\"-\"). A period (\".\"). An apostrophe (\"'\"). An asterisk (\"*\"). An underscore (\"_\"). At sign (\"@\") A space (\" \"). ex:- \"keven\"
country	String	Validation for the Country field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"IN\"
organisation	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"emudhra\"
organisationUnit	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). It will accept multiple OU values separated by commas. ex:- \"Finance\", \"Sales,Marketing\"
postalCode	String	Validation for the postal code field as below A character length of minimum 4 and maximum 64 characters A digit (from \"0\" to \"9\"). ex:- \"560063\"
stateOrProvince	String	Validation for the state field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"KA\", \"India\"
street	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:-\"jain street\"
houseIdentifier	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"Building A:
serialNumber	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"fff44f43224c43\"
uniqueIdentifier	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"774434cvfc45\"
pseudonym	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"Gorge ven\"
telephoneNumber	String	SHA256 of Telephone Number ex:- \"9cd24231c813f6608bcf717e15b76700a80e2170fbf235e5ff344dae948bbfec\"
title	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"Dovloper\"
email	String	A character length of minimum 2 and maximum 64 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). A digit (from \"0\" to \"9\"). A hyphen (\"-\"). A period (\".\"). An underscore (\"_\"). At sign (\"@\") ex:- \"sri.ram@outlook.com\"
oids	ArrayList	Pass additional subject DN details using the OIDs. You can provide multiple OIDs in an array object. Refer Table no 5 ex:- [ { \"oid\": \"2.5.4.7\", \"value\": \"Hyderabad\" } ]

Table no 3

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type of Key algorithm	Supported key algorithm and Sizes
RSA	RSA-1024, RSA-2048, RSA-3072, RSA-4096, and RSA-8192
ECDSA secp	ECDSA-192, ECDSA-256, ECDSA-384 and ECDSA-521
ECDSA Brainpool	B-ECDSA-256, B-ECDSA-384 and B-ECDSA-512
ECDSA Prime	P-ECDSA-256, P-ECDSA-384 and P-ECDSA-521
EDDSA	Ed25519
PQC	DILITHIUM2, DILITHIUM3, DILITHIUM5, FALCON-512, FALCON-1024, sha2_256f, sha2_256s, sha2_128f, sha2_128s, sha2_192f, sha2_192s, shake_128f, shake_128s, shake_192f, hake_192s, shake_256f, shake_256s, haraka_192f, haraka_192s, haraka_256f, haraka_256s and haraka_128f

Tabel no 4

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
rfc822Name	String	\"rfc822Name\" refers to an email address formatted according to RFC 822 standards ex:- \"sam.r@qa.co.in\"
dnsName	String	\"dnsName\" refers to a domain name system (DNS) name. It identifies a domain or hostname associated with an entity or resource, allowing secure communication over networks while validating the identity of servers and services. ex:- \"www.example.com\"
ipAddress	String	\"ipAddress\" refers to an IP address. It uniquely identifies a device or network interface on a TCP/IP network, enabling secure communication and validation of network endpoints in cryptographic protocols like TLS/SSL. ex:- \"10.32.43.124\"
url	String	\"url\" refers to a Uniform Resource Locator, commonly known as a web address. ex:- \"https://www.emudhra.com\"
registeredID	String	\"registeredID\" refers to a registered object identifier (OID) that uniquely identifies an object or attribute within a hierarchical naming structure defined by an organization or standards body. it can be used to specify a unique identifier for an entity, attribute, or policy associated with the certificate, ensuring interoperability and standardized identification across systems. ex: \"2.10.100.2.3.4\"
directoryName	String	\"directoryName\" is a structured representation of a distinguished name (DN) in X.509 certificates. It includes attributes like common name, organization, and locality, facilitating accurate identification and validation of entities within hierarchical directory systems for secure communications. ex:- \"L=IAO\"

Tabel no 5

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
oid	String	subject DN details using the OID ex:- \"2.5.4.7\"
value	String	Validation for the this field as below A character length of minimum 2 and maximum 75 characters A lowercase or uppercase English letter (from \"a\" to \"z\" and \"A\" to \"Z\"). ex:- \"kerala\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","createKeyStore"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c95be17-0a72-42bd-9008-8f7177e1002a"},{"name":"rekey","id":"901d1326-9d48-4601-9d59-78b33dde5b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"serialNo\": \"551c7bf7e4494a965c7ab38ad1ff4892\",\r\n \"output\": \"X509\",\r\n \"remarks\": \"test\",\r\n \"csr\": \"MIICzTCCAbUCAQAwgYcxCzAJBgNVBAYTAkdCMRYwFAYDVQQIEw1TdGFmZm9yZHNoaXJlMRcwFQYDVQQHEw5TdG9rZSBvbiBUcmVudDEjMCEGA1UEChMaUmVkIEtlc3RyZWwgQ29uc3VsdGluZyBMdGQxIjAgBgNVBAMTGXRlc3RjZXJ0LnJlZGtlc3RyZWwuY28udWswggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDWLeW88IeAIa3n23R99i874fh0jetf+STsGPgkfGXGJ++tclKGk3MJE0ijD4PNaxGXUCNULgn2ROyybm5sTmGzpEOD+1AAAyV+pLQoFNkHEFuudGqVM6XkPWfqaM2vKvdzUbPPC0X/MfDFGPxc8AY3TUM385c9c9/WOIF6NUcAvAFIQF0zG7evzJZBqDb4enUnatMSLHmxRWMi1JeHtfLINXhNitHewEQWgIB3j1xmh7CPO5FeTb6HzQDxc+f7uMisY6s9J/Ph3GeOCeIDooqU8jnfV5eGEzIMH5CFMZjajrNKF4DYK3YRyUI0K66+v0KILoUntEs++M20LhOn+VE9AgMBAAGgADANBgkqhkiG9w0BAQUFAAOCAQEAUWE7oBX3SLjYNM53bsBOlNGnsgAp1P1fiCPpEKaZGEOUJ2xOguIHSu1N1ZigKpWmiAAZxuoagW1R/ANM3jXpvCLVBRv40AHCFsot9udrdCYjI43aDHAaYvLmT4/Pvpntcn0/7+g//elAHhr9UIooMZwwwo6yom67Jwfw/be/g7Mae7mPHZ2lsQTS02hEeqVynIRk2W9meQULrt+/atog0mqJSBx0WswtHliTc+nXFpQrwFIEzVuPGCOVw7LmCfNmHNCkZVuRSJB/9MdLmrfwchPI3NeTGSe+BZfsOtpt2/7j+bqeYKFu8B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/rekey","description":"

Purpose

The \"rekey\" API facilitates the regenerating a certificate's remaining validity period by revoking the existing certificate. It requires a Certificate Signing Request (CSR) to generate a new certificate with the remaining validity timeframe. This workflow ensures the secure replacement of compromised or lost certificates, maintaining continuous secure communication while adhering to best practices in certificate management.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
serialNo*	String	Certificate serial number for which rekey is initiated. Ex :- “e4cb23a4b97a0c12f2641c1fc49d9ba7”
output*	String	Output defines the format of the certificate: X509: Base64 encoded X509 Certificate (without certificate chain). PEM: PEM format with certificate chain. ex:- \"X509\" or \"PEM\"
csr*	String	Certificate Signing Request (#PKCS10) ex:- \"MIICzTCCAbUCAQAwgYcxCzAJBgNV..........................B0stLoJBEnihxUoV18uZOmOeuVuX1N6nA==\"
remarks	String	The 'Remarks' parameter in the 'rekey' API allows users to include additional comments to the certificate rekeying process. ex:-\"lost the public key\"
validfrom	JSON	Certificate validity can be defined starting from a specific date if the profile is enabled for custom validity. Validation for the validfrom field is as follows: validfrom should not be a past date. day - day of the month (1-31) month - month of the year (1-12) year - four-digit year (e.g., 2024) hour - hour of the day (0-23) minute - minute of the hour (0-59) second - second of the minute (0-59)\" ex:- { \"day\": 1, \"month\": 1, \"year\": 2024, \"hour\": 0, \"minute\": 0, \"second\": 0 }

","urlObject":{"protocol":"https","path":["emCAServices","rest","rekey"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"901d1326-9d48-4601-9d59-78b33dde5b05"},{"name":"revoke","id":"cbcb3457-5614-4229-91ec-aa799b06d755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"serialNo\": \"551c7bf7e4494a965c7ab38ad1ff4892\",\r\n \"remarks\": \"test\",\r\n \"reason\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/revoke","description":"

Purpose

The \"revoke\" API facilitates the revocation of a certificate based on its serial number. This functionality is crucial for invalidating certificates that are compromised or no longer trusted.

By specifying the serial number of the certificate, this API ensures immediate termination of its validity, thereby maintaining security and compliance with organizational policies regarding certificate management.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
serialNo*	String	Certificate serial number for which revoke is initiated. Ex :- “b4cb23a4b97g5d0c12f2641c1fc49d9ba7”
reason*	Integer	0 (Unspecified): Reason not specified or unknown. 1 (Key Compromise): Private key associated with the certificate compromised or suspected compromised. 2 (CA compromise): Certificate Authority (CA) certificate or private key compromised or suspected compromised. 3 (Affiliation Changed): Certificate holder's affiliation or relationship with the organization changed. 4 (Superseded): Certificate replaced by a new certificate. 5 (Cessation of Operation): Organization or entity associated with the certificate ceased operation. 9 (Privilege Withdrawn): Privileges associated with the certificate holder withdrawn. 10 (AA Compromise): Certificate used for authentication or authorization compromised or suspected compromised. ex:- 4
remarks*	String	The 'Remarks' parameter in the 'revoke' API allows users to include additional comments to the certificate rekeying process. ex:-\"Certificate expired\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","revoke"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cbcb3457-5614-4229-91ec-aa799b06d755"},{"name":"suspend","id":"17d0f08c-4c81-46a1-ae53-3a84d5a529f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"serialNo\": \"bbc11e8f406e4a24c31c852660b464dd\",\r\n \"remarks\": \"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/suspend","description":"

Purpose

The 'suspend' API suspends certificates based on their serial numbers, crucial for invalidating compromised, or untrusted certificates. Users can also reinstate suspended certificates as needed, ensuring security and compliance with organizational policies.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
serialNo*	String	Certificate serial number for which revoke is initiated. Ex :- “b4cb23a4b97g5d0c12f2641c1fc49d9ba7”
remarks*	String	The 'Remarks' parameter in the 'supend' API allows users to include additional comments to the certificate rekeying process. ex:-\"forgot password\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","suspend"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"17d0f08c-4c81-46a1-ae53-3a84d5a529f8"},{"name":"reinstate","id":"510d6a10-4ff6-4725-9ce5-ed47b0b9664e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"serialNo\": \"bbc11e8f406e4a24c31c852660b464dd\",\r\n \"remarks\": \"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/reinstate","description":"

Purpose

The 'reinstate' API allows for the reinstatement of previously suspended certificates. This functionality is used to restore certificates that were temporarily invalidated due to compromise, or other reasons. By specifying the serial number of the suspended certificate, this API ensures the restoration of its validity, maintaining security and compliance with organizational certificate management policies.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
serialNo*	String	Certificate serial number for which reinstate is initiated. Ex :- “b4cb23a4b97g5d0c12f2641c1fc49d9ba7”
remarks*	String	The 'Remarks' parameter in the 'reinstate' API allows users to include additional comments to the certificate rekeying process. ex:-\"test\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","reinstate"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"510d6a10-4ff6-4725-9ce5-ed47b0b9664e"},{"name":"getCertificate","id":"6c8e5505-56c9-422f-8254-fa2af0616ccf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"234567876543","type":"text"},{"key":"X-Emca-Api-Key","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJncnBJZCI6IjMiLCJBdXRoS2V5IjoiT1RJMFpUQmtNekF0T0dObFlTMDBZbVkwTFdKbE56Y3ROR0l3WlRFMk1HUmlZV1k1IiwiaWF0IjoxNzE4MDE2NTEyLCJleHAiOjE3MTgxMDI5MTJ9.bW3wDshTYCjNCIyzjDvqfaaujnvH1wd2RrHhiY1UpWg","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"serialNo\": \"bbc11e8f406e4a24c31c852660b464dd\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/getCertificate","description":"

Purpose

The \"getCertificate\" API allows users to download a User certificate based on its serial number or retrieve the status of a manually authorized request using the requestId. This functionality supports efficient certificate management by providing access to specific certificates or the status of requests in a straightforward manner.

Request Input Parameters

* - Mandatory parameter

Note: Users must provide either the serial number or the request ID; both parameters cannot be included in the same request

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
serialNo	String	Certificate serial number Ex :- “b4cb23a4b97g5d0c12f2641c1fc49d9ba7”
requestId	String	The requestId is obtained when a certificate request is manually authorized. ex:-\"53352123554532\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","getCertificate"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c8e5505-56c9-422f-8254-fa2af0616ccf"},{"name":"getProfiles","id":"d5e4ce3d-e8ee-4e2f-aa20-067acd4aaddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"caName\": \"CA Certificate 2024\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/getProfiles","description":"

Purpose

The \"getProfiles\" API retrieves all profiles created for the issuing CA, providing basic information such as profile name, profile ID, and validity. By specifying the CA name, users can efficiently manage and review all profiles associated with that issuing CA.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
caName*	String	Common name of CA Certifictae Ex :- “CA Certificate 2924”

","urlObject":{"protocol":"https","path":["emCAServices","rest","getProfiles"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5e4ce3d-e8ee-4e2f-aa20-067acd4aaddb"},{"name":"getProfileInfo","id":"461f0a38-7d74-4f81-897d-673a8519f6cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"profile\": \"3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/getProfileInfo","description":"

Purpose

The \"getProfileInfo\" API retrieves profile information for a CA or USER by providing the profile name or profile id. This API helps in obtaining detailed information about specific profiles, facilitating efficient management and verification of CA or user profiles

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
profile*	String	Pass Certificate profile name or Id to be used to get profile information ex:- \"5\", \"signer cert profile\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","getProfileInfo"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"461f0a38-7d74-4f81-897d-673a8519f6cd"},{"name":"getCertInfo","id":"72a0c44a-e8fd-47a0-9ed5-ee234cbc2bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"caName\": \"CA Certificate 2024\",\r\n \"noOfCertificates\": 100,\r\n \"round\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/getCertInfo","description":"

Purpose

The \"getCertInfo\" API retrieves user certificate information by providing the Issuing CA's common name. This API helps in obtaining detailed information about user certificates issued by a specific Certificate Authority, facilitating efficient certificate management

Request Input Parameters

* - Mandatory parameter

Table no 1

Integer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
caName*	String	Common name of CA Certifictae Ex :- “CA Certificate 2024\"
noOfCertificates*	Integer	Retrieve the number of recently generated certificates under the provided CA. For instance, get the last 10 certificates generated under \"CA Certificate 2024.\" ex:- 10
round	Integer	The certificate details can be retrieved up to the configuration limit, depending on the defined configuration. For example, to get 1000 certificate details when the limitation in the configuration is 100, follow the approach below: 1. To get certificates 1-100, pass 0 or leave it empty. To get certificates 101-200, pass 1. 2. To get certificates 201-300, pass 2. 3. Continue this approach to retrieve certificates up to 1000

","urlObject":{"protocol":"https","path":["emCAServices","rest","getCertInfo"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"72a0c44a-e8fd-47a0-9ed5-ee234cbc2bae"},{"name":"getCertCount","id":"63adecce-11a9-4500-8e16-9fa7bd671044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"responseType\": \"Y\",\r\n \"caName\": [\r\n \"CA Certificate 2024\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/getCertCount","description":"

Purpose

The \"getCertCount\" API retrieves the total count of certificates issued under the specified Issuing CA. By providing the Issuing CA's details, users can obtain an accurate count of all certificates issued by that CA.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
responseType	String	The response will vary based on the responseType parameter. Please refer to the following expected responses: Empty (\"\") or null : Retrieves the total certificate count. \"Y\" : Retrieves the certificate count year-wise. \"M\" : Retrieves the certificate count month-wise. Ex:- \"M\" or \"Y\" or \"\" or null
caName*	ArrayList	List of common names of CA certificates for which you want to get the count of issuing user certificates. Ex:- [ \"CA Certificate 2023\", \"CA Certificate 2024\" ]

","urlObject":{"protocol":"https","path":["emCAServices","rest","getCertCount"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63adecce-11a9-4500-8e16-9fa7bd671044"},{"name":"getExpiringSoonCertInfo","id":"5bc1b695-243a-40e8-b3d1-8b18345cd3b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"noOfDays\": 370,\r\n \"caName\": [\r\n \"\"\r\n ],\r\n \"round\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/getExpiringSoonCertInfo","description":"

Purpose

The \"getExpiringSoonCertInfo\" API retrieves information about certificates that are expiring soon, based on the specified number of days. Users can optionally provide the CA name to filter results for a specific Certificate Authority, aiding in the efficient management of certificates nearing expiration within the defined time frame.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
noOfDays*	Integer	Number of days until certificates are nearing expiration. ex:- 10
caName	ArrayList	List of common names of CA certificates for which you want to retrieve information about expiring user certificates. Ex:- [ \"CA Certificate 2023\", \"CA Certificate 2024\" ]
round	Integer	The certificate details can be retrieved up to the configuration limit, depending on the defined configuration. For example, to get 1000 certificate details when the limitation in the configuration is 100, follow the approach below: 1. To get certificates 1-100, pass 0 or leave it empty. To get certificates 101-200, pass 1. 2. To get certificates 201-300, pass 2. 3. Continue this approach to retrieve certificates up to 1000 ex:- 1

","urlObject":{"protocol":"https","path":["emCAServices","rest","getExpiringSoonCertInfo"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bc1b695-243a-40e8-b3d1-8b18345cd3b1"},{"name":"getCAs","id":"518f2edc-b936-4794-a725-32697fed8bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"url":"https://appemca.emudhra.com/emCAServices/rest/getCAs","description":"

Purpose

The \"getCAs\" API returns the common names of all available Issuing CA certificates in its response.

Request Input Parameters

NOTE: This API does not require any input parameters.

\n","urlObject":{"protocol":"https","path":["emCAServices","rest","getCAs"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"518f2edc-b936-4794-a725-32697fed8bae"},{"name":"getCertificateChain","id":"970c26fa-a8fd-4d7d-a8c2-ce56eb6c1a1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"},{"key":"X-Emca-Api-Key","value":"{{x_emca_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"caName\": \"CA Certificate 2024\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://appemca.emudhra.com/emCAServices/rest/getCertificateChain","description":"

Purpose

The \"getCertificateChain\" API retrieves the complete certificate chain in encoded PEM format by provding the CA name. This functionality enables users to obtain all certificates in the chain associated with a specific Certificate Authority, facilitating comprehensive certificate management and validation.

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
caName*	String	Common name of CA Certifictae Ex :- “CA Certificate 2024”

","urlObject":{"protocol":"https","path":["emCAServices","rest","getCertificateChain"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"970c26fa-a8fd-4d7d-a8c2-ce56eb6c1a1a"},{"name":"getCAs","id":"c17b17ce-7f9e-424d-8cca-0d69d2ddcede","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"url":"https://appemca.emudhra.com/emCAServices/rest/getCAs/{{x_client_id}}","description":"

Purpose

The 'getCAs' API is supported by GET requests. It returns the common names of all available Issuing CA certificates in its response, where clientId is passed as a path variable.

URL

https://appemca.emudhra.com/emCAServices/rest/getCAs/{clientId}

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
clientId*	String	You need to pass the clientId in path variable You will get the clientId from emCA when you register an external application user for consuming APIs. ex:- \"924e0d30-8cea-4bf4-be77-4b0e160dbaf9\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","getCAs","{{x_client_id}}"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c17b17ce-7f9e-424d-8cca-0d69d2ddcede"},{"name":"getCertificateChain","id":"15fee5f3-a93d-4928-8690-153008a06091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"url":"https://appemca.emudhra.com/emCAServices/rest/getCertificateChain/{{x_client_id}}/CA Certificate 2024","description":"

Purpose

The 'getCertificateChain' API is GET-supported API where clientId and caname is passed as a path variable, API retrieves the complete certificate chain in encoded PEM format by provding the CA name. This functionality enables users to obtain all certificates in the chain associated with a specific Certificate Authority, facilitating comprehensive certificate management and validation.

URL

https://appemca.emudhra.com/emCAServices/rest/getProfileInfo/{clientId}/{caName}

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
clientId*	String	You need to pass the clientId in path variable You will get the clientId from emCA when you register an external application user for consuming APIs. ex:- \"924e0d30-8cea-4bf4-be77-4b0e160dbaf9\"
caName*	String	Common name of CA Certifictae need to be passed from the path variable Ex :- “CA Certificate 2924”

","urlObject":{"protocol":"https","path":["emCAServices","rest","getCertificateChain","{{x_client_id}}","CA Certificate 2024"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"15fee5f3-a93d-4928-8690-153008a06091"},{"name":"getProfileInfo","id":"063adeff-b27a-4017-89d6-edf64c8bc6a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"url":"https://appemca.emudhra.com/emCAServices/rest/getProfileInfo/{{x_client_id}}/3","description":"

Purpose

\"The 'getProfileInfo' API is supported by GET requests. It retrieves profile information for a CA or user, where clientId, profile name, or profile ID is passed as path variables. This API facilitates the retrieval of detailed information about specific profiles, enhancing the efficient management and verification of CA or user profiles.\"

URL

https://appemca.emudhra.com/emCAServices/rest/getProfileInfo/{clientId}/{profile}

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
clientId*	String	You need to pass the clientId in path variable You will get the clientId from emCA when you register an external application user for consuming APIs. ex:- \"924e0d30-8cea-4bf4-be77-4b0e160dbaf9\"
profile*	String	Pass Certificate profile name or Id in path variable to be used to get profile information ex:- \"3\", \"signer cert profile\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","getProfileInfo","{{x_client_id}}","3"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"063adeff-b27a-4017-89d6-edf64c8bc6a4"},{"name":"getProfiles","id":"c77cd748-8967-4f4d-8679-bf4f1d619097","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"url":"https://appemca.emudhra.com/emCAServices/rest/getProfiles/{{x_client_id}}/CA Certificate 2024","description":"

Purpose

The 'getProfiles' API is GET-supported API where clientId and caname is passed as a path variable, It retrieves all profiles created for the issuing CA, providing essential details such as profile name, profile ID, and validity. Users specify the CA name to efficiently manage and review profiles associated with that issuing CA.

URL

https://appemca.emudhra.com/emCAServices/rest/getProfileInfo/{clientId}/{caName}

Request Input Parameters

* - Mandatory parameter

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
clientId*	String	You need to pass the clientId in path variable You will get the clientId from emCA when you register an external application user for consuming APIs. ex:- \"924e0d30-8cea-4bf4-be77-4b0e160dbaf9\"
caName*	String	Common name of CA Certifictae need to be passed from the path variable Ex :- “CA Certificate 2024”

","urlObject":{"protocol":"https","path":["emCAServices","rest","getProfiles","{{x_client_id}}","CA Certificate 2024"],"host":["appemca","emudhra","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c77cd748-8967-4f4d-8679-bf4f1d619097"},{"name":"getCertificate","id":"96bea1f8-a40c-41cd-934c-dc5b012e96b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Nonce","value":"{{x_nonce}}","type":"text"}],"url":"https://appemca.emudhra.com/emCAServices/rest/getCertificate/{{x_client_id}}?serialNo=bbc11e8f406e4a24c31c852660b464dd","description":"

Purpose

The \"getCertificate\" API is a GET-supported API where clientId is passed as a path variable, and the serial number and requestId parameters need to be passed from the query parameters. This API allows users to download a user certificate based on its serial number or retrieve the status of a manually authorized request using the requestId, supporting efficient certificate management.

URL

https://appemca.emudhra.com/emCAServices/rest/getProfileInfo/{clientId}?serialNo=bbc11e8f406e4a24c31c852660b464dd

Request Input Parameters

* - Mandatory parameter

Note: Users must provide either the serial number or the request ID; both parameters cannot be included in the same request

Table no 1

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
clientId*	String	You need to pass the clientId in path variable You will get the clientId from emCA when you register an external application user for consuming APIs. ex:- \"924e0d30-8cea-4bf4-be77-4b0e160dbaf9\"
serialNo	String	Certificate serial number. serial number need to be passed from the query parameters Ex :- “b4cb23a4b97g5d0c12f2641c1fc49d9ba7”
requestId	String	The requestId is obtained when a certificate request is manually authorized. requestId need to be passed from the query parameters ex:-\"53352123554532\"

","urlObject":{"protocol":"https","path":["emCAServices","rest","getCertificate","{{x_client_id}}"],"host":["appemca","emudhra","com"],"query":[{"key":"serialNo","value":"bbc11e8f406e4a24c31c852660b464dd"}],"variable":[]}},"response":[],"_postman_id":"96bea1f8-a40c-41cd-934c-dc5b012e96b5"}],"id":"1af6cd8f-9d9d-40ea-9d00-7a94f670eb04","description":"

The Certificate Management APIs provide a robust and secure solution for handling the entire lifecycle of digital certificates. These APIs enable automated processes for certificate issuance, renewal, revocation, and validation, ensuring efficient management and enhanced security. Supporting both RSA and ECC algorithms, these APIs are designed to integrate seamlessly with existing systems and adhere to industry standards for security and interoperability. By utilizing these APIs, organizations can maintain a compliant and reliable public key infrastructure (PKI) with minimal manual intervention.

To ensure secure communication and multi-tenant isolation, all requests must include the following headers:

X-Nonce: A unique, per-request identifier used to prevent replay attacks by ensuring freshness and uniqueness.
\n
X-Client-ID: Identifies the tenant or organization initiating the request, enabling proper scoping and access control.
\n
X-Emca-Api-Key: A secure API key used to authenticate the client and authorize access to certificate management operations.
\n

By leveraging these headers and adhering to a security-first approach, the Certificate Management APIs enable organizations to maintain a compliant, scalable, and reliable public key infrastructure (PKI) with minimal manual intervention.

\n","_postman_id":"1af6cd8f-9d9d-40ea-9d00-7a94f670eb04"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":["\r","function generateUUID() {\r"," let d = new Date().getTime();\r"," if (typeof performance !== 'undefined' && typeof performance.now === 'function'){\r"," d += performance.now(); // use high-precision timer if available\r"," }\r"," return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {\r"," const r = (d + Math.random()*16)%16 | 0;\r"," d = Math.floor(d/16);\r"," return (c==='x' ? r : (r&0x3|0x8)).toString(16);\r"," });\r","}\r","\r","const nonce = `${Date.now()}-${generateUUID()}`;\r","\r","// Set it as a global or local variable\r","pm.variables.set(\"x_nonce\", nonce);\r","pm.variables.set(\"x_client_id\", \"129d0feb-00fa-482a-8f34-39cf784054ab\");\r","pm.variables.set(\"x_emca_api_key\", \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJncnBJZCI6IjQiLCJBdXRoS2V5IjoiTVRJNVpEQm1aV0l0TURCbVlTMDBPREpoTFRobU16UXRNemxqWmpjNE5EQTFOR0ZpIiwiaWF0IjoxNzUyNzMwNjE2LCJleHAiOjE3NTI3MzQyMTZ9.grmjJkTees2PfZgNZgHqEcdFX4izFn0WGtQBnOR41QA\");"],"id":"3edc1630-8913-4ab3-b18d-4dc680125775"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"52db325f-43b2-4484-85bb-bdd70373b348"}}]}