Method name: ListCerts

Service description including WSDL schema, and an example request and response for SOAP 1.1 and SOAP 1.2 are located at https://localhost/secusign/default.asmx?op=ListCerts.

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/ListCerts"

<?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>
    <ListCerts xmlns="http://software602.com/secusign/">
      <Params>string</Params>
      <IncludeNotEnabled>integer</IncludeNotEnabled>
    </ListCerts>
  </soap:Body>
</soap:Envelope>

Input parameters of the method

<Params>

[optional element]

Input Description

string

If the user was not authenticated to the web service with their account (e.g., 602 ID), the user may be specified with a user identifier (id_user) and organization identifier (id_org).

The format is: Id_user=Name; id_org=IdentOrgGUID

By default, authentication and identification by the user’s 602 ID account is expected.

Value: <IncludeExpired>

If the value is set to false, expired certificates are not included in the list. If the value is not specified or is set to true, expired certificates are also included.

<IncludeNotEnabled>

[optional element]

Input Description

Int

The returned list includes certificates in DISABLED or REVOKED status, see output values in chapter <Status>.

If the parameter is set to 1, it will return all certificates regardless of their status.

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>
    <ListCertsResponse xmlns="http://software602.com/secusign/">
      <ListCertsResult>int</ListCertsResult>
      <CertList>
        <PKCS11CertInfo>
          <Alias>string</Alias>
          <X509CertData>base64Binary</X509CertData>
          <Status>string</Status>
        </PKCS11CertInfo>
        <PKCS11CertInfo>
          <Alias>string</Alias>
          <X509CertData>base64Binary</X509CertData>
          <Status>string</Status>
        </PKCS11CertInfo>
      </CertList>
      <StatusMessage>string</StatusMessage>
    </ListCertsResponse>
  </soap:Body>
</soap:Envelope>

Output parameters of the method

<ListCertsResult>

Return value Description

Int

Result of the ListCerts method (getting a list of certificates).

0 = OK, otherwise see Return codes of all methods and error described in StatusMessage.

<CertList>

Array with a list of certificates.

<PKCS11CertInfo>

Certificate details.

<Alias>

Return value Description

String

Alias or CertificateID of the user certificate in GUID format.

<X509CertData>

Return value Description

Base64Binary

Base64 data of certificate in X509 format.

<Status>

Return value Description

String

User certificate status. Values:

  • ENABLED – can be used.

  • DISABLED – cannot be used.

  • REVOKED – cannot be used.

<StatusMessage>

Return value Description

String

Text statement corresponding to the overall result of getting a certificate list. The value is only filled if the result is complicated.