Submit-SigningRequest

Submits a new signing request or resubmits an existing one via the SignPath REST API.

Syntax

Provide an input artifact:

Submit-SigningRequest 
    -OrganizationId <String> -CIUserToken <String> [-ClientCertificate <X509Certificate2>]
    [-ApiUrl <String>] 
    [-Description <String>] 
    [-Parameters <Hashtable>] 
    -InputArtifactPath <String>
        (-ProjectSlug <String> -SigningPolicySlug <String> [-ArtifactConfigurationId <String>] )
        | (-SigningPolicyId <String> [-ArtifactConfigurationSlug <String>] )
        [-Origin <Hashtable>]
    [-WaitForCompletion 
        -OutputArtifactPath <String>
        [-Force]
        [-WaitForCompletionTimeoutInSeconds <Int32>] 
    ]
    [-ServiceUnavailableTimeoutInSeconds <Int32>] [-UploadAndDownloadRequestTimeoutInSeconds <Int32>] 

Resubmit an existing singing request:

Submit-SigningRequest 
    -OrganizationId <String> -CIUserToken <String> [-ClientCertificate <X509Certificate2>]
    [-ApiUrl <String>] 
    [-Description <String>] 
    [-Parameters <Hashtable>] 
    -Resubmit
        -OriginalSigningRequestId <String> 
        (-SigningPolicySlug <String>) | (-SigningPolicyId <String>)
    [-WaitForCompletion 
        -OutputArtifactPath <String>
        [-Force]
        [-WaitForCompletionTimeoutInSeconds <Int32>] 
    ]
    [-ServiceUnavailableTimeoutInSeconds <Int32>] [-UploadAndDownloadRequestTimeoutInSeconds <Int32>] 

Description

The Submit-SigningRequest cmdlet creates a new signing request. The signing request will be processed by SignPath according to authorization and policy rules.

Creating a new signing request vs. re-signing

When using the -InputArtifact parameter, the specified file will be uploaded for processing.

When using the -Resubmit paramter, the specified signing request will be processed again using the specified signing policy. This is especially useful for conditional signing of release candidates. See Resubmit an existing signing request for more information.

Downloading the signed artifact

Processing a signing request may take several minutes, or even longer if manual approval is required. You can either

your own logic to wait for processing to complete and download the signed artifact using the Get-SignedArtifact cmdlet afterwards,
or use the -WaitForCompletion parameter of this cmdlet to wait for processing and then download the signed artifact in a single call.

Parameters

Tip

Signing policies in the SignPath Web application show basic Submit-SigningRequest calls with essential parameters.

Common parameters

Parameter	Type	Description	Default value	Editions
`-OrganizationId`	`String`	ID of your SignPath organization
`-CIUserToken`	`String`	API token you receive when adding a new CI user
`-ClientCertificate`	`X509Certificate2`	Client certificate used for a secure Web API request. Not supported by SignPath.io directly, use for proxies.		Enterprise
`-ApiUrl`	`String`	URL to the SignPath REST API	`https://app.signpath.io/api/`
`-Description`	`String`	Optional description of the signing request
`-Parameters`	`Hashtable`	Values for parameters defined in the artifact configuration
`-ServiceUnavailableTimeoutInSeconds`	`Int32`	Total time in seconds that the cmdlet will wait for a single service call to succeed (across several retries)	600 seconds
`-UploadAndDownloadRequestTimeoutInSeconds`	`Int32`	HTTP timeout used for upload and download HTTP requests	300 seconds

Parameters with `-WaitForCompletion`

Parameter	Type	Description	Default value
`-WaitForCompletion`	Switch	Wait for the signing request to complete	`false`
`-OutputArtifactPath`	`String`	Specifies the target path for the downloaded signed artifact	`InputArtifactPath` with an added `.signed` extension
`-Force`	Switch	Allows the cmdlet to overwrite the file at OutputArtifactPath	`false`
`-WaitForCompletionTimeoutInSeconds`	`Int32`	Maximum time in seconds that the cmdlet will wait for the signing request to complete (upload and download have no specific timeouts)	600 seconds

Parameters with `-InputArtifactPath`

Parameter	Type	Description	Default value	Editions
`-InputArtifactPath`	`String`	Path of the artifact that you want to be signed
`-ProjectSlug`	`String`	Slug of the project
`-SigningPolicySlug`	`String`	Slug of one of the project’s signing policies
`-ArtifactConfigurationSlug`	`String`	Slug of one of the project’s artifact configurations	Project’s default artifact configuration
`-SigningPolicyId`	`String`	ID of a project’s signing policy
`-ArtifactConfigurationId`	`String`	ID of one of the project’s artifact configurations	Project’s default artifact configuration
`-Origin`	`Hashtable`	Information about the origin of the artifact, see below		Enterprise

Note: Use either slugs or IDs, don’t mix.

`-Origin` values

Available for Enterprise subscriptions

Parameter	Description
`RepositoryMetadata.SourceControlManagementType`	Type of source control management (SCM) or version control system (VCS), e.g. `git`
`RepositoryMetadata.RepositoryUrl`	URL of the source code repository, must match project settings for origin verification
`RepositoryMetadata.BranchName`	Branch name for the build, must match signing policy settings for origin verification
`RepositoryMetadata.CommitId`	Commit ID for the build
`BuildData.Url`	URL of the CI system
`BuildData.BuildSettingsFile`	File containing build configuration settings not accessible through SCM/VCS. Use `@` prefix to reference a local file, e.g. `@build/settings.json`

Parameters can either be passed as named above, or using nested hashtables (see example).

Parameters with `-Resubmit`

Parameter	Type	Description	Default value
`-Resubmit`	Switch	Re-sign an existing signing request	`false`
`-OriginalSigningRequestId`	`String`	ID of the signing request that should be resubmitted
`-SigningPolicySlug`	`String`	Slug of one of the original project’s signing policies
`-SigningPolicyId`	`String`	ID of one of the original project’s signing policies

Note: Use either slugs or IDs, don’t mix.

Examples

Example 1: Submit a signing request and wait for completion

Submit-SigningRequest `
    -OrganizationId $ORGANIZATION_ID -CIUserToken $CI_USER_TOKEN `
    -ProjectSlug $PROJECT -SigningPolicySlug $SIGNING_POLICY `
    -ArtifactConfigurationSlug $ARTIFACT_CONFIGURATION `
    -InputArtifactPath $PATH_TO_INPUT_ARTIFACT `
    -WaitForCompletion
    -OutputArtifactPath $PATH_TO_OUTPUT_ARTIFACT `

Example 2: Separate calls for submission and retrieval

Submit a signing request and get a signing request ID without waiting for completion …

$signingRequestID = Submit-SigningRequest `
    -OrganizationId $ORGANIZATION_ID `-CIUserToken $CI_USER_TOKEN `
    -ProjectSlug $PROJECT -SigningPolicySlug $SIGNING_POLICY `
    -ArtifactConfigurationSlug $ARTIFACT_CONFIGURATION `
    -InputArtifactPath $PATH_TO_INPUT_ARTIFACT

… and download the signed artifact later

Get-SignedArtifact `
    -OrganizationId $ORGANIZATION_ID -CIUserToken $CI_USER_TOKEN `
    -SigningRequestId $signingRequestID `
    -OutputArtifactPath $PATH_TO_OUTPUT_ARTIFACT

Example 3: Resubmit an existing signing request with a different signing policy

  Submit-SigningRequestResubmit `
    -CIUserToken $CI_USER_TOKEN -OrganizationId $ORGANIZATION_ID `
    -OriginalSigningRequestId $ORIGINAL_SIGNING_REQUEST_ID `
    -SigningPolicySlug $SIGNING_POLICY `
    -WaitForCompletion `
    -OutputArtifactPath $PATH_TO_OUTPUT_ARTIFACT

Example 4: Provide user-defined parameters and origin verification