modifySigningSet

Use the modifySigningSet operation to approve, reject, or cancel a signing request, and submit signing sets for production or test signing.

For test houses, use the modifySigningSet call to upload and include files in the signing set after testing is complete. If your test house can approve or reject signing sets, use this operation to reject or approve the application.

Parameters

authToken, signingSetID, operationType, requestReason, file, fileName

Table: Parameters

Name

Type

Description

authToken

AuthToken

Required. Your user name, password, and partner code.

signingSetID

int

Required. A unique identifier for this signing request. Useful to track the status if not immediately signed. Not returned if there is a fatal error.

operationType

string

Required. Valid values:

  • APPROVE_SIGNING_REQUEST. Flag the signing request as approved and return it to the workgroup.

  • REJECT_SIGNING_REQUEST. Flag the signing set as rejected and return it to the workgroup.

  • CANCEL_SIGNING_REQUEST. Cancels a request.

  • DO_PRODUCTION_SIGNING. Submits the signing set to the production CA.

  • DO_TEST_SIGNING. Submits the signing set to the test CA.

  • UPLOAD_FILE. Add a file to the signing set.

requestReason

string

Required. The reason for modifying the signing set.

file

string

Optional. As part of the testing process, you can upload (add) files to the signing set. Files you upload can be test plans, test results, and so on.

Use the file and fileName parameters to upload files to a signing set. The base64-encoded value of the uploaded file.

fileName

string

Optional. Use the file and fileName parameters to upload files to a signing set. The name of the uploaded file.

signingCertificateOptions

SigningCertificateOptionsType

Required for fixed-pool signing services and when the operationType is DO_PRODUCTION_SIGNING. Specifies whether to reuse or generate a new certificate.

signingSynchronous

boolean

Optional. Set to true by default. Set this parameter to False to get immediate response for modifySigningSet requests that perform operationType of DO_PRODUCTION_SIGNING and DO_TEST_SIGNING. If you set this parameter False for any other operationType, your request fails.

Helps while modifying signing sets containing multiple or large files. Files in a signing set are signed one-by-one and you have to wait for a response until the last file in the set is signed. With this parameter set to False, you can get an initial API response immediately. You can later check the signing status via getSigningSetDetails.

Response

Table: Response

Name

Type

Description

result

Result

Includes the success code and timestamp for the request.

signingSetStatus

string

See Signing set status codes.

XML request
<soapenv:Envelope 
xmlns:soapenv="http://schemas.xmlsoap.org/​soap/envelope/" 
xmlns:cod="http://api.ws.symantec.com/​webtrust/codesigningservice">  
  <soapenv:Body> 
    <cod:modifySigningSet> 
      <cod:modifySigningSetRequest> 
        <cod:authToken> 
          <cod:userName>username</cod:userName>  
          <cod:password>password</cod:password>  
          <cod:partnerCode>partnercode</cod:partnerCode> 
        </cod:authToken>  
        <cod:signingSetID>391929</cod:signingSetID>  
        <cod:operationType>REJECT_SIGNING_REQUEST</cod:operationType>  
        <cod:requestReason>Bad test results</cod:requestReason> 
      </cod:modifySigningSetRequest> 
    </cod:modifySigningSet> 
  </soapenv:Body> 
</soapenv:Envelope>
XML response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/​soap/envelope/">
  <S:Body>
    <modifySigningSetResponse xmlns="http://api.ws.symantec.com/
webtrust/codesigningservice">
      <return>c
        <result>
          <resultCode>0</resultCode>
          <timeStamp>2013-01-27T15:49:01.674Z</timeStamp>
        </result>
        <signingSetStatus>TESTING_REJECTED</signingSetStatus>
      </return>
    </modifySigningSetResponse>
  </S:Body>
</S:Envelope>

We use cookies to ensure that we give you the best experience on our website. By using this site, you agree to the Terms of Service.