GET Codesign/GetGlobalConfiguration

Returns settings that apply to all CodeSign Protect projects.

Requirements

  • Permissions: The caller is not required to have any special permissions.
  • Token scope:  Codesign:Manage

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

None

Returns

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Error: A error message that accompanies the Result.

  • GlobalConfiguration: The set of Policy tree locations and user settings:

    • ApprovedKeyStorageLocations: Items array of key storage locations that are approved for use with CodeSign Protect. This information is also available in the Encryption tree.

    • AvailableKeyStorageLocations: Array of all available key storage locations, such as HSM and Venafi key storage locations

    • DefaultCAContainer: The default Distinguished Name (DN) or container where CodeSign Protect creates and stores CA templates

    • DefaultCertificateContainer: The default container where code signing certificates are held

    • DefaultCredentialContainer: The default container where code signing credentials are held

    • EnvironmentCreateFlowDN: The Flow DN to use for creating an Environment

    • EnvironmentDeleteFlowDN: The Flow DN to use for deleting a Environment

    • EnvironmentTemplateUpdateFlowDN: The Flow DN to use for updating Environment Templates

    • EnvironmentUpdateFlowDN: The Flow DN to use for updating an Environment

    • KeyUseTimeout: The amount of time, in seconds, clients should wait for a key use operation before timing out and trying again later. Default 120.

    • MaxEnvironmentCount: The maximum number of Environments that can be returned in one request. Default 100.

    • ProjectDeleteFlowDn: The Flow DN to use for deleting a Project

    • ProjectDescriptionTooltip: Description that appears when a project owner is creating a project.

    • RequestInProgressMessage: The message that appears when a KeyUser attempts to access a key that requires approval.

  • Result: The Result code of this API call. For more information, see Sign Result Codes.

  • Success: The result of this API call: A value of false indicates the request failed due to an Error. Otherwise, true.

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • error: The reason for the error.
  • error_description: If available, additional information about how to retry the request.

Example: Get default information that applies to all projects

Request

GET https://codesign.venafi.example/vedsdk/Codesign/GetGlobalConfiguration

Response

HTTP/1.1 200 OK
{
   "GlobalConfiguration":{
      "ApprovedKeyStorageLocations":{
         "Items":[
            "Software"
         ]
      },
      "AvailableKeyStorageLocations":[
         "Software"
      ],
      "DefaultCAContainer":"\\VED\\Policy\\Code Signing\\Certificate Authority Templates",
      "DefaultCertificateContainer":"\\VED\\Policy\\Code Signing\\Certificates",
      "DefaultCredentialContainer":"\\VED\\Policy\\Code Signing\\Credentials",
      "KeyUseTimeout":120,
      "ProjectDescriptionTooltip":"",
      "RequestInProgressMessage":""
   },
   "Result":1,
   "Success":true
}