@itentialopensource/adapter-digicert_pki 0.1.1

package/report/DigiCert One Swagger v1.0.44.json

@@ -0,0 +1 @@
+{"swagger":"2.0","info":{"description":"This document specifies the APIs that user can implement to consume DigiCert PKI platform web services. It details a set of RESTful APIs to allow issuance, management of certificates and users.","version":"1.0.44","title":"DigiCert PKI Platform Rest APIs"},"host":"pki-ws-rest.symauth.com","basePath":"/mpki","tags":[{"name":"Audit API","description":"Audit Controller"},{"name":"CA API","description":"Ca Controller"},{"name":"Certificate Enrollment API","description":"Certificate Controller"},{"name":"Certificate Profile API","description":"Profile Controller"},{"name":"Enroll Status API","description":"Enroll Status Controller"},{"name":"Hello API","description":"Hello Controller"},{"name":"PROFILE API","description":"Profile Creation Controller"},{"name":"Search Certificate API","description":"Search Certificate Controller"},{"name":"Seat Management API","description":"Seat Management Controller"},{"name":"User Management API","description":"User Management Controller"}],"paths":{"/api/v1/audit-log":{"get":{"tags":["Audit API"],"summary":"This API is used to get audit details for given query param","operationId":"getAuditsUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"action","in":"query","description":"Available values : USER_ENROLLED, USER_INFO_EDIT, USER_CREATED , USER_DELETED etc.\nPlease refer API Docs for available values.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"adminRA","in":"query","description":"Administrator userName or RA common name","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateFrom","in":"query","description":"Datetime in ISO format","required":true,"type":"string"},{"name":"dateTo","in":"query","description":"Datetime in ISO format. Time span from dateFrom cannot exceed 365 days.","required":true,"type":"string"},{"name":"limit","in":"query","description":"Default Limit is 100","required":false,"type":"integer","format":"int32","x-example":10},{"name":"offset","in":"query","description":"Default value is 0","required":false,"type":"integer","format":"int32","x-example":0}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/audit-log/{auditId}":{"get":{"tags":["Audit API"],"summary":"This API is used to get audit details for given audit Id.","operationId":"getAuditUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"auditId","in":"path","description":"auditId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/ca/id/{caId}":{"get":{"tags":["CA API"],"summary":"This API is used to get public CA details for a given ca identifier","operationId":"getCAInfoUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"caId","in":"path","description":"caId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/ca/{seatType}":{"get":{"tags":["CA API"],"summary":"This API is used to get public CA details for a given account api key","operationId":"getCAUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"seatType","in":"path","description":"seatType","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/certificate":{"post":{"tags":["Certificate Enrollment API"],"summary":"This API is used to enroll a certificate for a given profile.","operationId":"enrollCertificateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"enrollCertificateRequest","description":"enrollCertificateRequest","required":true,"schema":{"$ref":"#/definitions/RequestCertificateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/certificate/create":{"post":{"tags":["Certificate Enrollment API"],"summary":"This API is used to enroll a certificate for a given profile.","operationId":"createCertificateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"enrollCertificateRequest","description":"enrollCertificateRequest","required":true,"schema":{"$ref":"#/definitions/CreateCertificateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/certificate/renew/{serialNumber}":{"post":{"tags":["Certificate Enrollment API"],"summary":"This API is used to enroll a certificate for a given profile.","operationId":"renewExternalCertificateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"enrollCertificateRequest","description":"enrollCertificateRequest","required":true,"schema":{"$ref":"#/definitions/CreateCertificateRequest"}},{"name":"serialNumber","in":"path","description":"serialNumber","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/certificate/{serialNumber}":{"get":{"tags":["Certificate Enrollment API"],"summary":"This API is used to get certificate details for a given certificate serial number","operationId":"getCertificateUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"serialNumber","in":"path","description":"serialNumber","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/certificate/{serialNumber}/key":{"get":{"tags":["Certificate Enrollment API"],"summary":"This API is used to get private key information for key-escrowed certificate with given serial number","operationId":"recoverKeyUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"serialNumber","in":"path","description":"serialNumber","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/certificate/{serialNumber}/renew":{"post":{"tags":["Certificate Enrollment API"],"summary":"This API is used to renew certificate with the given serial number.","operationId":"renewCertificateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"enrollCertificateRequest","description":"enrollCertificateRequest","required":true,"schema":{"$ref":"#/definitions/RequestCertificateRequest"}},{"name":"serialNumber","in":"path","description":"serialNumber","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/certificate/{serialNumber}/revoke":{"put":{"tags":["Certificate Enrollment API"],"summary":"This API can revoke certificate with the given serial number","operationId":"revokeCertificateUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"revokeCertificateRequest","description":"revokeCertificateRequest","required":false,"schema":{"$ref":"#/definitions/RevokeCertificateRequest"}},{"name":"serialNumber","in":"path","description":"serialNumber","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["Certificate Enrollment API"],"summary":"This API can resume certificate with the given serial number.","operationId":"unRevokeCertificateUsingDELETE","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"serialNumber","in":"path","description":"serialNumber","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/api/v1/enrollment":{"post":{"tags":["User Management API"],"summary":"This API is used to enroll user for profile.","operationId":"createPasscodeUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"createPasscodeRequest","description":"createPasscodeRequest","required":true,"schema":{"$ref":"#/definitions/CreatePasscodeRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/enrollment/{enrollCode}":{"get":{"tags":["User Management API"],"summary":"This API is used to get details of an existing enrollment.","operationId":"getEnrollmentUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"enrollCode","in":"path","description":"enrollCode","required":true,"type":"string"},{"name":"seat_id","in":"query","description":"seat_id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["User Management API"],"summary":"This API is used to reset enrollment code.","operationId":"resetPasscodeUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"enrollCode","in":"path","description":"enrollCode","required":true,"type":"string"},{"in":"body","name":"resetPasscodeRequest","description":"resetPasscodeRequest","required":true,"schema":{"$ref":"#/definitions/ResetPasscodeRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["User Management API"],"summary":"This API can delete an enrollment for given enrollment id","operationId":"deleteEnrollmentUsingDELETE","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"deleteEnrollRequest","description":"deleteEnrollRequest","required":true,"schema":{"$ref":"#/definitions/DeleteEnrollmentRequest"}},{"name":"enrollCode","in":"path","description":"enrollCode","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/api/v1/enrollstatus/{seatId}":{"get":{"tags":["Enroll Status API"],"summary":"This API is used to get certificate enrollment status.","operationId":"enrollStatusUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"profile_id","in":"query","description":"profile_id","required":false,"type":"string"},{"name":"seatId","in":"path","description":"seatId","required":true,"type":"string"}],"responses":{"200":{"description":"Certificate enrollment status result","schema":{"type":"array","items":{"$ref":"#/definitions/GetEnrollStatusResponse"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false}},"/api/v1/hello":{"get":{"tags":["Hello API"],"summary":"Hello API","operationId":"helloUsingGET","produces":["*/*"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile":{"get":{"tags":["Certificate Profile API"],"summary":"This API is used to get profile details of all profiles in an account and its subaccounts","operationId":"getAllProfilesUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GetProfileResponse"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile/activate":{"put":{"tags":["PROFILE API"],"summary":"This API is used to suspend a profile","operationId":"activateProfileUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"profileCreationRequest","description":"profileCreationRequest","required":true,"schema":{"$ref":"#/definitions/ProfileCreationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile/create":{"post":{"tags":["PROFILE API"],"summary":"This API is used to create a profile","operationId":"createProfileUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"profileCreationRequest","description":"profileCreationRequest","required":true,"schema":{"$ref":"#/definitions/ProfileCreationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile/delete":{"put":{"tags":["PROFILE API"],"summary":"This API is used to delete a profile","operationId":"deleteProfileUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"profileCreationRequest","description":"profileCreationRequest","required":true,"schema":{"$ref":"#/definitions/ProfileCreationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile/edit":{"put":{"tags":["PROFILE API"],"summary":"This API is used to create a profile","operationId":"updateProfileUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"profileCreationRequest","description":"profileCreationRequest","required":true,"schema":{"$ref":"#/definitions/ProfileCreationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile/suspend":{"put":{"tags":["PROFILE API"],"summary":"This API is used to suspend a profile","operationId":"suspendProfileUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"profileCreationRequest","description":"profileCreationRequest","required":true,"schema":{"$ref":"#/definitions/ProfileCreationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile/test":{"post":{"tags":["PROFILE API"],"summary":"This API is used to create a profile","operationId":"testCreateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/profile/{profileId}":{"get":{"tags":["Certificate Profile API"],"summary":"This API is used to get profile details for a given profile id","operationId":"getProfileUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"profileId","in":"path","description":"profileId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GetProfileResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/searchcert":{"post":{"tags":["Search Certificate API"],"summary":"This API is used to search for certificates.","operationId":"searchCertUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"searchReq","description":"searchReq","required":true,"schema":{"$ref":"#/definitions/SearchCertificateRequest"}}],"responses":{"200":{"description":"Certificate search result","schema":{"$ref":"#/definitions/SearchCertificateResponse"}},"201":{"description":"Created"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false}},"/api/v1/seat":{"post":{"tags":["Seat Management API"],"summary":"This API is used to create a seat. This seat can be used for  a user, device, server or organization seat pool.","operationId":"createSeatUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"in":"body","name":"createSeatRequest","description":"createSeatRequest","required":true,"schema":{"$ref":"#/definitions/CreateSeatRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/v1/seat/{seatId}":{"get":{"tags":["Seat Management API"],"summary":"This API is used to get information regarding a seat.","operationId":"getSeatUsingGET","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"seatId","in":"path","description":"seatId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["Seat Management API"],"summary":"This API is used to change the seat details.","operationId":"updateSeatUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"seatId","in":"path","description":"seatId","required":true,"type":"string"},{"in":"body","name":"updateSeatRequest","description":"updateSeatRequest","required":true,"schema":{"$ref":"#/definitions/UpdateSeatRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["Seat Management API"],"summary":"This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to the specified seat.","operationId":"deleteSeatUsingDELETE","produces":["application/json"],"parameters":[{"name":"X-API-Key","in":"header","required":false,"type":"string"},{"name":"seatId","in":"path","description":"seatId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Response"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}}},"definitions":{"Account":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}},"title":"Account"},"ApiError":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"title":"ApiError"},"Attribute":{"type":"object","properties":{"id":{"type":"string"},"mandatory":{"type":"boolean"},"type":{"type":"string"},"value":{"type":"string"}},"title":"Attribute"},"AttributeSource":{"type":"object","properties":{"mandatory":{"type":"boolean"},"value":{"type":"object"}},"title":"AttributeSource"},"AuthAttribute":{"type":"object","properties":{"display_name":{"type":"string"},"id":{"type":"string"},"mandatory":{"type":"boolean"},"type":{"type":"string"},"value":{"type":"string"}},"title":"AuthAttribute"},"Authentication":{"type":"object","properties":{"approval":{"type":"string"},"attributes":{"type":"array","items":{"$ref":"#/definitions/AuthAttribute"}},"method":{"type":"string"},"method_id":{"type":"string"}},"title":"Authentication"},"CertificateAttributes":{"type":"object","properties":{"common_name":{"type":"string"},"content_type":{"type":"string"},"counter_signature":{"type":"string"},"country":{"type":"string"},"custom_attributes":{"type":"object","additionalProperties":{"type":"string"}},"dn_qualifier":{"type":"string"},"domain_component":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"domain_name":{"type":"string"},"email":{"type":"string"},"given_name":{"type":"string"},"ip_address":{"type":"string"},"job_title":{"type":"string"},"locality":{"type":"string"},"message_digest":{"type":"string"},"organization_name":{"type":"string"},"organization_unit":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"postal_code":{"type":"string"},"pseudonym":{"type":"string"},"san":{"$ref":"#/definitions/SanAttributes"},"serial_number":{"type":"string"},"signing_time":{"type":"string"},"state":{"type":"string"},"street_address":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"surname":{"type":"string"},"unique_identifier":{"type":"string"},"unstructured_address":{"type":"string"},"unstructured_name":{"type":"string"},"user_id":{"type":"string"}},"title":"CertificateAttributes"},"CertificateDetails":{"type":"object","properties":{"extensions":{"$ref":"#/definitions/Extensions"},"issuer":{"$ref":"#/definitions/Issuer"},"subject":{"$ref":"#/definitions/Subject"},"validity":{"$ref":"#/definitions/Validity"}},"title":"CertificateDetails"},"CertificateInfo":{"type":"object","properties":{"certificate":{"type":"string","format":"byte"},"root":{"type":"boolean"},"serial_number":{"type":"string"},"subject_dn":{"type":"string"}},"title":"CertificateInfo"},"CreateCertificateRequest":{"type":"object","properties":{"csr":{"type":"string"},"extensions":{"type":"object"},"include_ca_chain":{"type":"boolean"},"profile":{"$ref":"#/definitions/Profile"},"seat":{"$ref":"#/definitions/Seat"},"subject":{"type":"object"},"validity":{"$ref":"#/definitions/Validity"}},"title":"CreateCertificateRequest"},"CreatePasscodeRequest":{"type":"object","properties":{"attributes":{"$ref":"#/definitions/CertificateAttributes"},"profile":{"$ref":"#/definitions/Profile"},"seat":{"$ref":"#/definitions/Seat"}},"title":"CreatePasscodeRequest"},"CreateSeatRequest":{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"},"seat_id":{"type":"string"},"seat_name":{"type":"string"}},"title":"CreateSeatRequest"},"CryptoProviders":{"type":"object","properties":{"provider":{"type":"array","items":{"type":"string"}}},"title":"CryptoProviders"},"DeleteEnrollmentRequest":{"type":"object","properties":{"seat":{"$ref":"#/definitions/Seat"}},"title":"DeleteEnrollmentRequest"},"Enrollment":{"type":"object","properties":{"client_type":{"type":"string"},"client_type_id":{"type":"string"}},"title":"Enrollment"},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ErrorResponse"},"ExtendedAttribute":{"type":"object","properties":{"id":{"type":"string"},"mandatory":{"type":"boolean"},"multiple":{"type":"boolean"},"sources":{"type":"array","items":{"$ref":"#/definitions/AttributeSource"}},"type":{"type":"string"},"value":{"type":"string"}},"title":"ExtendedAttribute"},"ExtendedKeyUsageListType":{"type":"object","properties":{"critical":{"type":"boolean"},"extended_key_usages":{"type":"array","items":{"type":"string"}}},"title":"ExtendedKeyUsageListType"},"Extensions":{"type":"object","properties":{"san":{"$ref":"#/definitions/San"}},"title":"Extensions"},"GetCertificateResponse":{"type":"object","properties":{"account":{"$ref":"#/definitions/Account"},"certificate":{"type":"string"},"common_name":{"type":"string"},"enrollment_notes":{"type":"string"},"is_key_escrowed":{"type":"boolean"},"password":{"type":"string"},"profile":{"$ref":"#/definitions/Profile"},"revocation":{"$ref":"#/definitions/Revocation"},"seat":{"$ref":"#/definitions/Seat"},"serial_number":{"type":"string"},"session_key":{"type":"string"},"status":{"type":"string"},"valid_from":{"type":"string"},"valid_to":{"type":"string"},"webpin":{"type":"string"}},"title":"GetCertificateResponse"},"GetEnrollStatusResponse":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string"},"profile_id":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string"}},"title":"GetEnrollStatusResponse"},"GetProfileResponse":{"type":"object","properties":{"authentication":{"$ref":"#/definitions/Authentication"},"certificate":{"$ref":"#/definitions/CertificateDetails"},"certificate_delivery_format":{"type":"string"},"duplicate_cert_policy":{"type":"boolean"},"enrollment":{"$ref":"#/definitions/Enrollment"},"id":{"type":"string"},"name":{"type":"string"},"private_key_attributes":{"$ref":"#/definitions/PrivateKeyAttributes"},"publish_to_public_directory":{"type":"boolean"},"renewal_period_days":{"type":"integer","format":"int32"},"signature_algorithm":{"type":"string"},"status":{"type":"string"}},"title":"GetProfileResponse"},"Issuer":{"type":"object","properties":{"certificate":{"type":"string","format":"byte"},"chain":{"type":"array","items":{"$ref":"#/definitions/CertificateInfo"}},"root":{"type":"boolean"},"serial_number":{"type":"string"},"subject_dn":{"type":"string"}},"title":"Issuer"},"KeyEscrowPolicy":{"type":"object","properties":{"dual_admin_recovery":{"type":"boolean"},"key_escrow_deployment_mode":{"type":"string","enum":["CLOUD","LOCAL"]},"key_escrow_enabled":{"type":"boolean"}},"title":"KeyEscrowPolicy"},"KeyEscrowPolicyType":{"type":"object","properties":{"do_key_recovery_for_additional_enroll_request":{"type":"boolean"},"key_escrow_deployment_mode":{"type":"string"},"key_escrow_enabled":{"type":"boolean"},"key_recovery_dual_admin_approval_required":{"type":"boolean"}},"title":"KeyEscrowPolicyType"},"KeyUsageListType":{"type":"object","properties":{"critical":{"type":"boolean"},"key_usages":{"type":"array","items":{"type":"string"}}},"title":"KeyUsageListType"},"PrivateKeyAttributes":{"type":"object","properties":{"algorithm_oid":{"type":"string"},"crypto_providers":{"$ref":"#/definitions/CryptoProviders"},"key_escrow_policy":{"$ref":"#/definitions/KeyEscrowPolicyType"},"key_exportable":{"type":"boolean"},"key_protect":{"type":"boolean"},"key_size":{"type":"integer","format":"int32"},"key_sizes":{"type":"array","items":{"type":"integer","format":"int32"}}},"title":"PrivateKeyAttributes"},"Profile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"Profile"},"ProfileCreationRequest":{"type":"object","properties":{"bctOid":{"type":"string"},"caId":{"type":"string"},"duplicateCertPolicy":{"type":"boolean"},"extendedKeyUsages":{"$ref":"#/definitions/ExtendedKeyUsageListType"},"keyEscrowPolicy":{"$ref":"#/definitions/KeyEscrowPolicy"},"keySize":{"type":"string"},"keyUsages":{"$ref":"#/definitions/KeyUsageListType"},"overrideCertValidityViaApi":{"type":"boolean"},"profileName":{"type":"string"},"profileOid":{"type":"string"},"renewalPeriodDays":{"type":"integer","format":"int32"},"san":{"$ref":"#/definitions/San"},"signatureAlgorithm":{"type":"string"},"subject":{"$ref":"#/definitions/Subject"},"validity":{"$ref":"#/definitions/Validity"}},"title":"ProfileCreationRequest"},"RequestCertificateRequest":{"type":"object","properties":{"attributes":{"$ref":"#/definitions/CertificateAttributes"},"authentication":{"type":"object","additionalProperties":{"type":"string"}},"csr":{"type":"string"},"profile":{"$ref":"#/definitions/Profile"},"seat":{"$ref":"#/definitions/Seat"},"session_key":{"type":"string"},"validity":{"description":"Validity of certificate only for enroll certificate API.It is not supported for renewal API","$ref":"#/definitions/Validity"}},"title":"RequestCertificateRequest"},"ResetPasscodeRequest":{"type":"object","properties":{"seat":{"$ref":"#/definitions/Seat"}},"title":"ResetPasscodeRequest"},"Response":{"type":"object","title":"Response"},"Revocation":{"type":"object","properties":{"comments":{"type":"string"},"reason":{"type":"string"},"revocation_date":{"type":"string"}},"title":"Revocation"},"RevokeCertificateRequest":{"type":"object","properties":{"revocation_reason":{"type":"string"}},"title":"RevokeCertificateRequest"},"San":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"critical":{"type":"boolean"}},"title":"San"},"SanAttributes":{"type":"object","properties":{"custom_attributes":{"type":"object","additionalProperties":{"type":"string"}},"directory_name":{"type":"string"},"dns_name":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"ip_address":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"other_name":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"registered_id":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"rfc822_name":{"type":"array","items":{"$ref":"#/definitions/Attribute"}},"user_principal_name":{"type":"array","items":{"$ref":"#/definitions/Attribute"}}},"title":"SanAttributes"},"SearchCertificateRequest":{"type":"object","properties":{"common_name":{"type":"string"},"email":{"type":"string"},"issuing_ca":{"type":"string"},"profile_id":{"type":"string"},"seat_id":{"type":"string"},"serial_number":{"type":"string"},"start_index":{"type":"integer","format":"int32"},"status":{"type":"string"},"valid_from":{"type":"string"},"valid_to":{"type":"string"}},"title":"SearchCertificateRequest"},"SearchCertificateResponse":{"type":"object","properties":{"certificates":{"type":"array","items":{"$ref":"#/definitions/GetCertificateResponse"}},"count":{"type":"integer","format":"int32"},"index":{"type":"integer","format":"int32"},"more_certs_available":{"type":"boolean"}},"title":"SearchCertificateResponse"},"Seat":{"type":"object","properties":{"email":{"type":"string"},"seat_id":{"type":"string"},"seat_name":{"type":"string"}},"title":"Seat"},"Subject":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/ExtendedAttribute"}}},"title":"Subject"},"UpdateSeatRequest":{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"},"seat_name":{"type":"string"}},"title":"UpdateSeatRequest"},"Validity":{"type":"object","properties":{"duration":{"type":"integer","format":"int32"},"unit":{"type":"string"}},"title":"Validity"}}}

package/report/adapterInfo.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.1.0",
+  "configLines": 5580,
+  "scriptLines": 1795,
+  "codeLines": 5734,
+  "testLines": 5275,
+  "testCases": 215,
+  "totalCodeLines": 12804,
+  "wfTasks": 48
+}

package/report/creationReport.json

@@ -0,0 +1,490 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "Standard adapter errors available for use",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.48.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 70
+    },
+    {
+      "owner": "adapterJS",
+      "description": "Lines of code generated in adapter.js",
+      "value": 3946
+    },
+    {
+      "owner": "adapterJS",
+      "description": "Number of Functions added to adapter.js",
+      "value": 31
+    },
+    {
+      "owner": "pronghornJson",
+      "description": "Number of Methods added to pronghorn.json",
+      "value": 31
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 338
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 200
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the CALLS.md",
+      "value": 171
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the AUTH.md",
+      "value": 40
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SYSTEMINFO.md",
+      "value": 11
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 2279
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 121
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 1868
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 36
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for AuditAPI entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for CAAPI entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for CertificateEnrollmentAPI entity",
+      "value": 8
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for UserManagementAPI entity",
+      "value": 4
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for EnrollStatusAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for HelloAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for CertificateProfileAPI entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for PROFILEAPI entity",
+      "value": 6
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for SearchCertificateAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for SeatManagementAPI entity",
+      "value": 4
+    },
+    {
+      "owner": "actionJson",
+      "description": "Total number of actions",
+      "value": 31
+    },
+    {
+      "owner": "actionJson",
+      "description": "Total number of entities",
+      "value": 10
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for AuditAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for CAAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for CertificateEnrollmentAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for UserManagementAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for EnrollStatusAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for HelloAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for CertificateProfileAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for PROFILEAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for SearchCertificateAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for SeatManagementAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Total number of schemas",
+      "value": 10
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for AuditAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for CAAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for CertificateEnrollmentAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for UserManagementAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for EnrollStatusAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for HelloAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for CertificateProfileAPI entity",
+      "value": 1
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for PROFILEAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for SearchCertificateAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for SeatManagementAPI entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Total number of mock data files",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for .system entity",
+      "value": 2
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for .system entity",
+      "value": 3
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for .system entity",
+      "value": 2
+    },
+    {
+      "owner": "System",
+      "description": "System entity files",
+      "value": 6
+    },
+    {
+      "owner": "usecases",
+      "description": "Number of workflows",
+      "value": 0
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1788
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 38
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 9881
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 157
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 74
+    }
+  ],
+  "warnings": [],
+  "apiParsingReport": {
+    "no_mockdata": [
+      {
+        "fnName": "getAuditsUsingGET",
+        "method": "get",
+        "path": "/api/v1/audit-log"
+      },
+      {
+        "fnName": "getAuditUsingGET",
+        "method": "get",
+        "path": "/api/v1/audit-log/{auditId}"
+      },
+      {
+        "fnName": "getCAInfoUsingGET",
+        "method": "get",
+        "path": "/api/v1/ca/id/{caId}"
+      },
+      {
+        "fnName": "getCAUsingGET",
+        "method": "get",
+        "path": "/api/v1/ca/{seatType}"
+      },
+      {
+        "fnName": "enrollCertificateUsingPOST",
+        "method": "post",
+        "path": "/api/v1/certificate"
+      },
+      {
+        "fnName": "createCertificateUsingPOST",
+        "method": "post",
+        "path": "/api/v1/certificate/create"
+      },
+      {
+        "fnName": "renewExternalCertificateUsingPOST",
+        "method": "post",
+        "path": "/api/v1/certificate/renew/{serialNumber}"
+      },
+      {
+        "fnName": "getCertificateUsingGET",
+        "method": "get",
+        "path": "/api/v1/certificate/{serialNumber}"
+      },
+      {
+        "fnName": "recoverKeyUsingGET",
+        "method": "get",
+        "path": "/api/v1/certificate/{serialNumber}/key"
+      },
+      {
+        "fnName": "renewCertificateUsingPOST",
+        "method": "post",
+        "path": "/api/v1/certificate/{serialNumber}/renew"
+      },
+      {
+        "fnName": "revokeCertificateUsingPUT",
+        "method": "put",
+        "path": "/api/v1/certificate/{serialNumber}/revoke"
+      },
+      {
+        "fnName": "unRevokeCertificateUsingDELETE",
+        "method": "delete",
+        "path": "/api/v1/certificate/{serialNumber}/revoke"
+      },
+      {
+        "fnName": "createPasscodeUsingPOST",
+        "method": "post",
+        "path": "/api/v1/enrollment"
+      },
+      {
+        "fnName": "getEnrollmentUsingGET",
+        "method": "get",
+        "path": "/api/v1/enrollment/{enrollCode}"
+      },
+      {
+        "fnName": "resetPasscodeUsingPUT",
+        "method": "put",
+        "path": "/api/v1/enrollment/{enrollCode}"
+      },
+      {
+        "fnName": "deleteEnrollmentUsingDELETE",
+        "method": "delete",
+        "path": "/api/v1/enrollment/{enrollCode}"
+      },
+      {
+        "fnName": "helloUsingGET",
+        "method": "get",
+        "path": "/api/v1/hello"
+      },
+      {
+        "fnName": "getProfileUsingGET",
+        "method": "get",
+        "path": "/api/v1/profile/{profileId}"
+      },
+      {
+        "fnName": "activateProfileUsingPUT",
+        "method": "put",
+        "path": "/api/v1/profile/activate"
+      },
+      {
+        "fnName": "createProfileUsingPOST",
+        "method": "post",
+        "path": "/api/v1/profile/create"
+      },
+      {
+        "fnName": "deleteProfileUsingPUT",
+        "method": "put",
+        "path": "/api/v1/profile/delete"
+      },
+      {
+        "fnName": "updateProfileUsingPUT",
+        "method": "put",
+        "path": "/api/v1/profile/edit"
+      },
+      {
+        "fnName": "suspendProfileUsingPUT",
+        "method": "put",
+        "path": "/api/v1/profile/suspend"
+      },
+      {
+        "fnName": "testCreateUsingPOST",
+        "method": "post",
+        "path": "/api/v1/profile/test"
+      },
+      {
+        "fnName": "searchCertUsingPOST",
+        "method": "post",
+        "path": "/api/v1/searchcert"
+      },
+      {
+        "fnName": "createSeatUsingPOST",
+        "method": "post",
+        "path": "/api/v1/seat"
+      },
+      {
+        "fnName": "getSeatUsingGET",
+        "method": "get",
+        "path": "/api/v1/seat/{seatId}"
+      },
+      {
+        "fnName": "updateSeatUsingPUT",
+        "method": "put",
+        "path": "/api/v1/seat/{seatId}"
+      },
+      {
+        "fnName": "deleteSeatUsingDELETE",
+        "method": "delete",
+        "path": "/api/v1/seat/{seatId}"
+      }
+    ],
+    "errors": [],
+    "warnings": [],
+    "callsTotal": 31,
+    "callsConverted": 31,
+    "no_mockdata_num": 29
+  }
+}