Obtaining certificate properties

The GetCertProperty web service method allows the calling application to retrieve the properties of a given HSM certificate.

A description of the service including a WSDL schema, and an example request and response for SOAP 1.1 and SOAP 1.2 is located at https://localhost/secusign/default.asmx?op=GetCertProperty.

Localhost is the name used for the local computer; write the SDK server name/IP address instead (according to the settings in IIS).

Request in SOAP 1.1 interface

POST /SecuSign/default.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/secusign/GetCertProperty"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCertProperty xmlns="http://software602.com/secusign/">
      <OrganizationID>string</OrganizationID>
      <UserID>string</UserID>
      <CertificateID>string</CertificateID>
      <PropertyName>string</PropertyName>
    </GetCertProperty>
  </soap:Body>
</soap:Envelope>

Input parameters of the method

<OrganizationID>

[optional element]

Input value Description

String

Identification of the organization of the user of the certificate. It was delivered to the customer when implementing the Remote Sealing/Signing service.

If not specified, authentication information will be used to identify the organization.

<UserID>

[optional element]

Input value Description

String

Identification of the user of the certificate if is not basic authenticated.

<CertificateID>

[mandatory element]

Input value Description

String

Identification of the certificate whose property we want to get.

<PropertyName>

[optional element]

Input value Description

String

The name of the searched property. Possible values: status and authmode.

Response structure

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCertPropertyResponse xmlns="http://software602.com/secusign/">
      <GetCertPropertyResult>int</GetCertPropertyResult>
      <PropertyValue>string</PropertyValue>
      <StatusMessage>string</StatusMessage>
    </GetCertPropertyResponse>
  </soap:Body>
</soap:Envelope>

Output parameters of the method

<GetCertPropertyResult>

Return value Description

String

The result of the method GetCertProperty (getting the certificates property).

0 = OK, otherwise error. See StatusMessage.

<PropertyValue>

Return value Description

String

Output parameter. The value of the required certificate property.

<StatusMessage>

Return value Description

String

Contains a more detailed error description in case a problem occurs.